Skip to content

docs: add upgrade guide for existing deployments - #254

Open
BlueX888 wants to merge 1 commit into
OpenBMB:mainfrom
BlueX888:docs/upgrade-guide-194
Open

BlueX888 wants to merge 1 commit into
OpenBMB:mainfrom
BlueX888:docs/upgrade-guide-194

Conversation

@BlueX888

@BlueX888 BlueX888 commented Sep 1, 2026 •

Copy link
Copy Markdown

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, and staffdeck serve / launch.py with prepare.py), choosing between main and 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.md documents 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 only backend/skill_agent_loop.db does not restore them. Source installs also differ by launcher — scripts/dev_up.sh prepares and restarts the process it owns, while a staffdeck serve or launch.py service has to be stopped by hand and started after python3 prepare.py.

How verified: Docs-only change, checked against the current tree: data directories and the ULTRARAG_DATA_DIR override (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/), the staffdeck serve path (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.

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
BlueX888 force-pushed the docs/upgrade-guide-194 branch from 8202dfe to 058c9f5 Compare October 25, 2026 18:50
@BlueX888

Copy link
Copy Markdown
Author

Rebased onto current main and revised the guide after checking it against the tree: it now covers backing up the whole data directory (attachments and workspaces live outside SQLite) and both source restarts — scripts/dev_up.sh, and staffdeck serve / launch.py after python3 prepare.py — plus a current release tag for pinning. The docs check passes (relative links resolve, <details> blocks stay balanced, the scripts it names exist), and no code, test or workflow files change. If you would rather have this folded into INSTALL.md, or the README FAQ split from the guide, say which and I will adjust.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

之前部署的,怎么升级到最新的release?

1 participant