Repository navigation
Conversation
Closes OpenBMB#194. Adds docs/upgrade-guide.md covering packaged desktop and source-deployment upgrades (backup locations, commands, verification, rollback) and links it from a new FAQ entry in both READMEs.
BlueX888
force-pushed
the
docs/upgrade-guide-194
branch
from
October 25, 2026 18:50
8202dfe to
058c9f5
Compare
Author
|
Rebased onto current |
This branch has not been deployed
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.
Closes #194.
What: Adds
docs/upgrade-guide.md, an English upgrade guide for packaged desktop installs and source deployments: what to back up, the two restart paths for source installs (scripts/dev_up.sh, andstaffdeck serve/launch.pywithprepare.py), choosing betweenmainand a release tag, and verification and rollback steps. Both READMEs get a matching FAQ entry that links it.Why: #194 asks how to upgrade a deployment that is already running.
INSTALL.mddocuments installation and upgrades in Chinese, and the English README links it for that; this page gives English readers the same procedure with the data locations, backup and rollback steps spelled out.The data directory matters: attachments (
harness_uploads/) and workspaces (harness_workspaces/) live there, outside SQLite, so backing up onlybackend/skill_agent_loop.dbdoes not restore them. Source installs also differ by launcher —scripts/dev_up.shprepares and restarts the process it owns, while astaffdeck serveorlaunch.pyservice has to be stopped by hand and started afterpython3 prepare.py.How verified: Docs-only change, checked against the current tree: data directories and the
ULTRARAG_DATA_DIRoverride (backend/app/paths.py), attachment and workspace roots under the data directory (backend/app/session/attachment_store.py,backend/app/core/harness_session_cleanup.py), automatic SQLite schema migration (backend/app/db/database.py), the dev scripts and their default port (scripts/), thestaffdeck servepath (README.md,backend/src/staffdeck_harness/cli.py), and the release tags. Relative links in the page and both READMEs resolve and<details>blocks stay balanced. No code, test or workflow files change.