docs: capture deployment gotchas (TLS defaults, app-key match, local embeddings)#98
Merged
Merged
Conversation
…embeddings) Fold the issues hit during a real self-hosted bring-up into the docs and troubleshooting. - docker-deployment: correct the stale "migrations are manual" section (the entrypoint auto-runs them now) and add a TLS section covering DATABASE_SSL/REDIS_TLS with the bundled plain Postgres/Redis. - configuration reference: add DATABASE_SSL, REDIS_TLS, EMBEDDING_CACHE_DIR, the agent LLM provider, local embedding defaults, and clarify that GITHUB_PRIVATE_KEY is key contents (real newlines) belonging to the same App that is installed. - llm-providers: add an Embeddings (PR memory) section documenting voyage vs local, dimensions, and the glibc-image requirement. - faq + setup-walkthrough: troubleshooting for the crash-loop from production TLS defaults, the 404 installation-token error from mismatched App credentials, the empty-installation case, and "Indexed 0 comments" being expected on repos without review history.
|
ClearPR — Review failed: Unprocessable Entity: "Line could not be resolved" - https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request. |
1 similar comment
|
ClearPR — Review failed: Unprocessable Entity: "Line could not be resolved" - https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request. |
|
ClearPR — Review failed: Unprocessable Entity: "Line could not be resolved, Line could not be resolved, and Line could not be resolved" - https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request. |
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.
What
Documents the real issues encountered during a self-hosted deployment, so the next person doesn't rediscover them.
Changes
DATABASE_SSL/REDIS_TLSwith the bundled plain Postgres/Redis.DATABASE_SSL,REDIS_TLS,EMBEDDING_CACHE_DIR, theagentLLM provider, local-embedding defaults; clarifiedGITHUB_PRIVATE_KEYis key contents from the same App that's installed.The server does not support SSL connections/ Redis timeout),GITHUB_APP_ID/key,installations/repositorieswhen installed before creds were correct,Notes
All generic, no environment-specific details.
npm run docs:buildpasses. Touchesdocs-site/**, so the docs-deploy workflow will publish on merge.