From 2a68ff3151cfd25ceb2f60d4d9259cc82c3b9707 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Sun, 2 Aug 2026 00:39:28 -0700 Subject: [PATCH] Align documented upgrade commands --- docs/Install.md | 2 ++ docs/Troubleshooting.md | 2 +- docs/Upgrading.md | 3 ++- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/Install.md b/docs/Install.md index f2048d21..74390529 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -280,6 +280,8 @@ uv tool install --python 3.13 --upgrade 'git+https://github.com/ArchiveBox/Archi cd ~/archivebox/data archivebox init # update collection index & apply any migrations archivebox install # update runtime dependencies to latest versions +archivebox update --migrate-only # migrate/reconcile Snapshot files and metadata +archivebox status # check collection health after the upgrade ``` Check our more detailed [Upgrading](https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives) documentation and [Release Notes](https://github.com/ArchiveBox/ArchiveBox/releases) if you run into any problems. ➡️ diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index e095ab5a..b193e2fa 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -150,7 +150,7 @@ Database and filesystem issues are uncommon but do come up from time to time (es ```bash archivebox init # upgrade the archivebox collection archivebox install # upgrade the archivebox runtime dependencies -archivebox update --index-only # force an upgrade of some of the archivebox index/collection files +archivebox update --migrate-only # migrate/reconcile Snapshot files and metadata archivebox server --debug # run the server with more verbose debug log output archivebox shell # access the Python API / Django management shell sqlite3 index.sqlite3 # access the SQLite3 SQL database shell diff --git a/docs/Upgrading.md b/docs/Upgrading.md index 139f70fd..d8a2fcc7 100644 --- a/docs/Upgrading.md +++ b/docs/Upgrading.md @@ -81,12 +81,13 @@ More info: ### Upgrading with plain Docker -Upgrading with plain Docker is similar to the process with Docker Compose, but you have to run `archivebox init` manually at the end to finish the process. +Upgrading with plain Docker is similar to the process with Docker Compose, but each command must mount the existing collection directory. ```bash docker ps -a -q --filter ancestor=archivebox/archivebox # find any currently running archivebox containers docker stop CONTAINER_ID +cd ~/archivebox/data # or wherever your existing collection is stored docker pull archivebox/archivebox:dev docker run -v $PWD:/data -it archivebox/archivebox:dev init docker run -v $PWD:/data -it archivebox/archivebox:dev install