From 993d87badd8d87c8859b5924a1d9ac0f867b4f82 Mon Sep 17 00:00:00 2001 From: Nick Sweeting Date: Wed, 12 Aug 2026 23:42:44 -0700 Subject: [PATCH] Clarify novice install commands --- README.md | 2 +- docs/Docker.md | 1 + docs/Install.md | 1 + docs/Quickstart.md | 2 +- 4 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9595aee4..b7a6a772 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`
+**🖥  [Supported OSs](https://github.com/ArchiveBox/ArchiveBox/wiki/Install#supported-systems):** Ubuntu, macOS, Docker   **👾  CPUs:** `amd64` (`x86_64`), `arm64`

diff --git a/docs/Docker.md b/docs/Docker.md index ee236fae..e76c12d5 100644 --- a/docs/Docker.md +++ b/docs/Docker.md @@ -69,6 +69,7 @@ docker compose pull docker compose run --rm archivebox init docker compose run --rm archivebox install docker compose run --rm archivebox manage createsuperuser +docker compose up -d ``` ArchiveBox installs and enables both ripgrep and [Sonic](https://github.com/valeriansaliou/sonic). Sonic is selected by default in the UI, while ripgrep remains available as the fallback. To select ripgrep explicitly: diff --git a/docs/Install.md b/docs/Install.md index 7586467a..120f26a8 100644 --- a/docs/Install.md +++ b/docs/Install.md @@ -156,6 +156,7 @@ Alternatively, install with `uv` or [Homebrew on Linux](https://docs.brew.sh/Hom ```bash # uv curl -LsSf https://astral.sh/uv/install.sh | sh +source "$HOME/.local/bin/env" uv tool install --python 3.13 --prerelease allow --upgrade archivebox # or Homebrew, after installing Linuxbrew diff --git a/docs/Quickstart.md b/docs/Quickstart.md index d93b4633..0852fe1e 100644 --- a/docs/Quickstart.md +++ b/docs/Quickstart.md @@ -6,7 +6,7 @@ ▶️ *It only takes about 5 minutes to get up and running with ArchiveBox.* -ArchiveBox [officially supports](https://github.com/ArchiveBox/ArchiveBox/wiki/Install#supported-systems) **macOS**, **Ubuntu/Debian**, and **BSD**, but likely runs on many other systems. You can run it on any system that supports **Docker** and/or Python. Windows *is not supported* unless you run it inside Docker Desktop, Docker in WSL2, or WSL2. +ArchiveBox [officially supports](https://github.com/ArchiveBox/ArchiveBox/wiki/Install#supported-systems) **macOS** and **Ubuntu** on `amd64` or `arm64`, plus **Docker** on those architectures. Windows is supported only through Docker Desktop or Docker in WSL2. For more detailed Docker and Docker Compose-specific instructions, see the [[Docker]] page.