The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-12 19:50:57 +05:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

Clarify supported hosts and upgrade prerequisites

Browse Source
This commit is contained in:
Nick Sweeting 2026-08-09 18:11:37 -04:00
parent 87667c6459
commit 64a41766b8
No known key found for this signature in database
5 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -169,7 +169,7 @@ ArchiveBox is free for everyone to self-host, but we also provide support, secur
# Quickstart
**🖥&nbsp; [Supported OSs](https://github.com/ArchiveBox/ArchiveBox/wiki/Install#supported-systems):** Linux/BSD, macOS, Windows (Docker) &nbsp; **👾&nbsp; CPUs:** `amd64` (`x86_64`), `arm64`, `arm7` <sup>(raspi>=3)</sup><br/>
**🖥&nbsp; [Supported OSs](https://github.com/ArchiveBox/ArchiveBox/wiki/Install#supported-systems):** Linux/BSD, macOS, Windows (Docker) &nbsp; **👾&nbsp; CPUs:** `amd64` (`x86_64`), `arm64`<br/>
<br/>

2
docs/Docker.md
View File

@ -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).
<br/>

6
docs/Install.md
View File

@ -21,8 +21,8 @@ ArchiveBox is primarily distributed as a Python package installed with `uv`, but
<img src="https://assets.ubuntu.com/v1/c5cb0f8e-picto-ubuntu.svg" width="5%" align="right"/>
<img src="https://imgur.zervice.io/Ue9BI7n.png" width="5%" align="right"/>
**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`)<br/>
*(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.
<sub>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.</sub>
<br/>
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).

6
docs/Upgrading.md
View File

@ -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

2
docs/codeblocks.toml
View File

@ -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"