From 64a41766b8ce95b40730fa42712629897d04bc7c Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Sun, 9 Aug 2026 18:11:37 -0400 Subject: [PATCH] Clarify supported hosts and upgrade prerequisites --- README.md | 2 +- docs/Docker.md | 2 +- docs/Install.md | 6 ++---- docs/Upgrading.md | 6 +++++- docs/codeblocks.toml | 2 +- 5 files changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5360d4d5..8e3dfb77 100644 --- a/README.md +++ b/README.md @@ -169,7 +169,7 @@ ArchiveBox is free for everyone to self-host, but we also provide support, secur # Quickstart -**🖥  [Supported OSs](https://github.com/ArchiveBox/ArchiveBox/wiki/Install#supported-systems):** Linux/BSD, macOS, Windows (Docker)   **👾  CPUs:** `amd64` (`x86_64`), `arm64`, `arm7` (raspi>=3)
+**🖥  [Supported OSs](https://github.com/ArchiveBox/ArchiveBox/wiki/Install#supported-systems):** Linux/BSD, macOS, Windows (Docker)   **👾  CPUs:** `amd64` (`x86_64`), `arm64`

diff --git a/docs/Docker.md b/docs/Docker.md index c3976602..fb554275 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -39,7 +39,7 @@ Published [Docker tags](https://hub.docker.com/r/archivebox/archivebox/tags): > [!IMPORTANT] > *Make sure Docker is **[installed](https://docs.docker.com/install/#supported-platforms)** and up-to-date before following any instructions below!* ➡️ -> To check installed version, run: `docker --version` (must be `>=17.04.0`) +> Check both commands before continuing: `docker --version` and `docker compose version` (Compose v2 is required).
diff --git a/docs/Install.md b/docs/Install.md index e1ad037c..2075df52 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -21,8 +21,8 @@ ArchiveBox is primarily distributed as a Python package installed with `uv`, but -**CPU Architectures:** `amd64` (`x86_64`), `arm64` (`aarch64`), `arm7` -*(Including 64-bit Intel/AMD, M1/M2/etc. Macs, Raspberry Pi >= 3)* +**CPU Architectures:** `amd64` (`x86_64`), `arm64` (`aarch64`)
+*(Including 64-bit Intel/AMD and Apple Silicon Macs)* **Memory:** 1GB RAM minimum; 2GB+ is recommended. On a 1GB VPS, configure at least 4GB of swap before running full default crawls. @@ -38,8 +38,6 @@ Other systems are not officially supported but may work with degraded functional * **Windows:** Via [[Docker]], Docker in WSL2, or WSL2 without Docker (not recommended) * [Other UNIX systems:](https://github.com/ArchiveBox/ArchiveBox#-package-manager-setup) Arch, Nix, Guix, Fedora, SUSE, Arch, CentOS, etc. -Note: Some managed binary providers do not publish `arm7` builds. Run `archivebox install` to see which compatible host or managed providers are available for your platform. -
You can reduce crawl-time memory pressure by disabling all Chrome-based archiving methods with [`CHROME_ENABLED=False`](https://archivebox.github.io/abx-plugins/#chrome) (or its `USE_CHROME` alias). diff --git a/docs/Upgrading.md b/docs/Upgrading.md index d0b47962..f069861c 100644 --- a/docs/Upgrading.md +++ b/docs/Upgrading.md @@ -3,12 +3,16 @@ ```bash # Stop any running ArchiveBox server/workers first (Ctrl+C, or stop the service/process manager that started them) +# Back up the entire collection, including index.sqlite3, ArchiveBox.conf, and all archived outputs +cd ~/archivebox +tar -czf "archivebox-data-$(date +%s).tar.gz" data/ + # Update ArchiveBox using the package manager you originally installed it with uv tool install --python 3.13 --upgrade 'git+https://github.com/ArchiveBox/ArchiveBox.git@dev' # or: sudo apt update && sudo apt install --only-upgrade archivebox # or: brew update && brew upgrade archivebox -cd ~/archivebox/data +cd data archivebox init archivebox install archivebox update --migrate-only diff --git a/docs/codeblocks.toml b/docs/codeblocks.toml index 77ce8950..53129c72 100644 --- a/docs/codeblocks.toml +++ b/docs/codeblocks.toml @@ -230,7 +230,7 @@ version = 2 "03803c44e54399c4-1" = "illustration" # docs/Upgrading.md -"8e43020c6e8ada8f-1" = "illustration" +"02a6a3d3dfd39c24-1" = "illustration" "6678cb1b999c44ea-1" = "illustration" "09bbb69bbb6cf07f-1" = "illustration" "611ff525e9208d7a-1" = "illustration"