docs(self-hosting): clarify embedding provider env vars, local models, and v0.0.6 upgrade lock (#1336) - #1659
Open
Adityakk9031 wants to merge 1 commit into
Conversation
…, and v0.0.6 upgrade lock (supermemoryai#1336)
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
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 #1336
Summary
In self-hosted
v0.0.6andv0.0.7-rc.2, the compiled release binary assets were published without pluggable embedding configuration hooks (environment variables likeSUPERMEMORY_EMBEDDING_PROVIDER,SUPERMEMORY_EMBEDDING_MODEL, andSUPERMEMORY_EMBEDDING_DIMENSIONSwere not linked in the binary and defaulted to local EnglishXenova/bge-base-en-v1.5).While full pluggable embedding support is linked in
v0.0.7andv0.0.8+, several documentation gaps and upgrade traps caused confusion:v0.0.6, pre-existing rows without anembedding-plan.jsonlock file cause the server to automatically lock to legacylocal · Xenova/bge-base-en-v1.5 · 768dto prevent mixed-space vector corruption. Any newly configured embedding env vars are either blocked or fail boot unless the data directory is wiped or pointed to a fresh path.SUPERMEMORY_EMBEDDING_PROVIDERonly acceptslocal,openai,openai-compatible, orgemini. SettingSUPERMEMORY_EMBEDDING_PROVIDER=ollamacauses an unknown provider error; Ollama requiresopenai-compatible(oropenai) withSUPERMEMORY_EMBEDDING_BASE_URL.Xenova/bge-m3at 1024d,Xenova/multilingual-e5-baseat 768d, etc.) with required dimensions.SUPERMEMORY_EMBEDDING_API_KEYto the configuration documentation.