# Option A: Get ArchiveBox with Docker Compose (recommended):
mkdir -p ~/archivebox/data && cd ~/archivebox
curl -fsSL 'https://docker-compose.archivebox.io' > docker-compose.yml
docker compose pull
docker compose up -d --wait                                                # initializes new collections automatically
docker compose exec archivebox archivebox manage createsuperuser          # create the first Web UI user
docker compose run --rm archivebox add 'https://example.com'
docker compose run --rm archivebox help



Option B: Or use it as a plain Docker container:
mkdir -p ~/archivebox/data && cd ~/archivebox/data
docker run --rm -it -v "$PWD:/data" archivebox/archivebox:dev init
docker run --rm -it -v "$PWD:/data" archivebox/archivebox:dev install
docker run --rm -it -v "$PWD:/data" archivebox/archivebox:dev manage createsuperuser
docker run -d --name archivebox -v "$PWD:/data" -p 8000:8000 archivebox/archivebox:dev
docker run -it -v $PWD:/data archivebox/archivebox:dev add 'https://example.com'
docker run -it -v $PWD:/data archivebox/archivebox:dev help



Option C: Or install it with uv (see Quickstart below for apt, brew, and more)
uv tool install --python 3.13 --prerelease explicit --upgrade 'archivebox>=0.9.0rc0,<0.10'
mkdir -p ~/archivebox/data && cd ~/archivebox/data
archivebox init
archivebox install
archivebox add 'https://example.com'
archivebox help
archivebox server 0.0.0.0:8000



Option D: Or use the optional auto setup script to install it
curl -fsSL 'https://get.archivebox.io' | bash

docker-compose (macOS/Linux)   👈  recommended   (click to expand)

1. Install Docker on your system (if not already installed).
2. Download the docker-compose.yml file into a new empty directory (can be anywhere).

   mkdir -p ~/archivebox/data && cd ~/archivebox
   curl -fsSL 'https://docker-compose.archivebox.io' > docker-compose.yml
   docker compose pull
   

3. Start the server, which initializes a new collection automatically, then create the first admin user.

   docker compose up -d --wait
   docker compose exec archivebox archivebox manage createsuperuser
   

4. Next steps: Log in to the Admin UI at http://admin.archivebox.localhost:8000.

   run CLI commands inside the server container started above
   docker compose exec archivebox archivebox add 'https://example.com'
   docker compose exec archivebox archivebox help
   

   For more info, see Install: Docker Compose in the Wiki. ➡️

docker run (macOS/Linux)

1. Install Docker on your system (if not already installed).
2. Create a new empty directory and initialize your collection (can be anywhere).

   mkdir -p ~/archivebox/data && cd ~/archivebox/data
   docker run --rm -v $PWD:/data -it archivebox/archivebox:dev init
   docker run --rm -v $PWD:/data -it archivebox/archivebox:dev install
   

3. Optional: Start the server then log in to the Admin UI at http://admin.archivebox.localhost:8000.

   docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox:dev
   completely optional, CLI can always be used without running a server
   docker run -v $PWD:/data -it archivebox/archivebox:dev subcommand --help
   docker run -v $PWD:/data -it archivebox/archivebox:dev help
   

   For more info, see Install: Docker Compose in the Wiki. ➡️

bash auto-setup script (macOS/Linux)

1. Install Docker on your system (optional, highly recommended but not required).
2. Run the automatic setup script.

   curl -fsSL 'https://get.archivebox.io' | bash

   For more info, see Install: Bare Metal in the Wiki. ➡️

uv (macOS/Linux/BSD)

1. Install uv on your system (if not already installed).
2. Install the ArchiveBox package using uv.

   uv tool install --python 3.13 --prerelease explicit --upgrade 'archivebox>=0.9.0rc0,<0.10'
   archivebox version
   

   See the Install: Bare Metal Wiki for full install instructions for each OS...
3. Create a new empty directory and initialize your collection (can be anywhere).

   mkdir -p ~/archivebox/data && cd ~/archivebox/data   # for example
   archivebox init     # initialize a new collection
   archivebox install  # install all the runtime dependencies (e.g. chrome, single-file, yt-dlp, etc.)
   

4. Create an admin account, then optionally start the server and log in to the Admin UI at http://admin.archivebox.localhost:8000.

   archivebox manage createsuperuser
   archivebox server 0.0.0.0:8000
   completely optional, CLI can always be used without running a server
   archivebox subcommand --help
   archivebox help