fix(self-host): clarify reinstall recovery#1668
Merged
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
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.
Summary
This PR improves the local self-host reinstall path and makes the self-host README easier to use when someone is confused or blocked.
What changed
~/compass/.envis missing and stops before creating a new.envthat could lock the user out of old data.MONGO_REPLICA_SET_KEYis absent.self-host/README.mdinto a troubleshooting-focused guide for install, helper commands, Docker volumes,.envchanges, update/rebuild behavior, ports, and Google Calendar limitations.Why
Re-running the installer after deleting
~/compassbut leaving Docker volumes behind produced a confusing Docker failure. The installer now explains what happened, why it stopped, and which recovery path to choose. The README now mirrors that support flow so users have a clearer place to self-serve when Docker, volumes, or env files get confusing.Validation
sh -n self-host/install.sh~/compass/.envdocker compose --env-file <older-env-without-MONGO_REPLICA_SET_KEY> -f self-host/docker-compose.yml configself-host/compassgit diff --check --cachedNote: Biome reports these docs and shell files are ignored by the repo config, so there was no Biome file check to apply here.