docs: warn about CWD-relative SUPERMEMORY_DATA_DIR default (#1420) - #1607
Open
Adityakk9031 wants to merge 1 commit into
Open
docs: warn about CWD-relative SUPERMEMORY_DATA_DIR default (#1420)#1607Adityakk9031 wants to merge 1 commit into
Adityakk9031 wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #1420.
Description
Adds a warning block to the self-hosted configuration documentation, advising users to always set
SUPERMEMORY_DATA_DIRto a stable directory path (e.g.~/.supermemory) to prevent the creation of accidental empty stores.Root Cause
When
SUPERMEMORY_DATA_DIRis left unset, it defaults to./.supermemoryrelative to the current working directory ($CWD). If the server is started from different directories (e.g. while cd-ing between repo checkouts or system folders), it silently scaffolds and boots a brand-new, empty store (along with a new API key, auth secret, and downloading models/runtimes again). Nothing in the console output distinguishes a fresh creation from an existing store opening, which leads to confusion and wasted disk space.Changes
Added a clear Warning block under the configuration parameters table recommending explicit configuration of
SUPERMEMORY_DATA_DIR.