ArchiveBox/docs/Docker.md

Docker

Overview

Running ArchiveBox with Docker allows you to manage it in a container without exposing it to the rest of your system. ArchiveBox generally works the same in Docker as it does outside Docker. You can even use uv-installed ArchiveBox and Docker ArchiveBox in tandem, as they both share the same data directory format.

• Overview
• Docker Compose ⭐️ (recommended)
  • Setup
  • Upgrading
  • Usage
  • Accessing the data
  • Configuration
• Plain Docker
  • Setup
  • Upgrading
  • Usage
  • Accessing the data
  • Configuration

Official Docker Hub image: hub.docker.com/r/archivebox/archivebox

docker pull archivebox/archivebox:dev

• Dockerfile
• docker-compose.yml

Published Docker tags:

• :dev for unstable alpha builds (breaks often, only for developers and willing beta testers)
• :x.xrcN and :x.x.xrcN for specific RC versions
• :sha-xxxxxxx for builds of specific git commits (to test or pin specific PRs or commits)

Important

Make sure Docker is installed and up-to-date before following any instructions below! ➡️
Check both commands before continuing: docker --version and docker compose version (Compose v2 is required).

Docker Compose

Setup

A full docker-compose.yml file is provided with all the extras included.
You can uncomment sections within it to enable extra features, or run the basic version as-is.

# create a folder to store your data (can be anywhere)
mkdir -p ~/archivebox/data && cd ~/archivebox

# download the compose file into the directory
curl -fsSL 'https://docker-compose.archivebox.io' > docker-compose.yml
# (shortcut for getting https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/dev/docker-compose.yml)

# pull the current image, initialize the collection, install runtime dependencies,
# then create an admin user for the Web UI (or set ADMIN_USERNAME/ADMIN_PASSWORD env vars)
docker compose pull
docker compose run --rm archivebox init
docker compose run --rm archivebox install
docker compose run --rm archivebox manage createsuperuser

ArchiveBox installs and enables both ripgrep and Sonic. Sonic is selected by default in the UI, while ripgrep remains available as the fallback. To select ripgrep explicitly:

docker compose run --rm archivebox config --set SEARCH_BACKEND_ENGINE=ripgrep

Upgrading

See the wiki page on Upgrading or Merging Archives: Upgrading with Docker Compose for instructions. ➡️

Usage

You can use docker compose run --rm archivebox [subcommand] just like the non-Docker archivebox [subcommand] CLI.

First, make sure you're cd'ed into the same folder as your docker-compose.yml file (e.g. ~/archivebox):

docker compose run --rm archivebox help

To add an individual URL, pass it in as an arg or via stdin:

docker compose run --rm archivebox add 'https://example.com'
# OR
echo 'https://example.com' | docker compose run --rm -T archivebox add

To add multiple URLs at once, pipe them in via stdin, or place them in a file inside ./data/sources so that ArchiveBox can access it from within the container:

# pipe URLs in from a file outside Docker
docker compose run --rm -T archivebox add < ~/Downloads/example_urls.txt

# OR ingest URLs from a file mounted inside Docker
docker compose run --rm archivebox add --depth=1 /data/sources/example_urls.txt

# OR pipe in URLs from a remote source
curl 'https://example.com/some/rss/feed.xml' | docker compose run --rm -T archivebox add
docker compose run --rm archivebox add --depth=1 'https://example.com/some/rss/feed.xml'

The --depth=1 flag tells ArchiveBox to look inside the provided source and archive all the URLs within:

# this archives just the RSS file itself (probably not what you want)
docker compose run --rm archivebox add 'https://example.com/some/feed.rss'

# this archives the RSS feed file + all the URLs mentioned inside of it
docker compose run --rm archivebox add --depth=1 'https://example.com/some/feed.rss'

Accessing the data

The outputted archive data is stored in data/ (relative to the project root), or whatever folder path you specified in the docker-compose.yml volumes: section. The mounted directory must be writable by its current owner; the entrypoint detects that non-root owner and runs ArchiveBox with matching permissions.

To access a result directly via the filesystem, follow its backwards-compatible ./data/archive/<timestamp> symlink, or browse the canonical ./data/archive/users/<user>/snapshots/<date>/<domain>/<uuid>/ tree.

Alternatively, to use the web UI, start the server with:

docker compose up         # add -d to run in the background

Then open http://web.archivebox.localhost:8000 for the public UI or http://admin.archivebox.localhost:8000 for the admin UI.

Configuration

ArchiveBox running with docker compose accepts all the same config options as other ArchiveBox distributions, see the full list of options available on the Configuration page.

The recommended way configure ArchiveBox in Docker Compose is using archivebox config --set ... or by editing ArchiveBox.conf.

docker compose run --rm archivebox config --set TIMEOUT=120
# OR edit ./data/ArchiveBox.conf and add this under its existing [ARCHIVING_CONFIG] section:
TIMEOUT=120

# plugin-specific options work the same way (see https://archivebox.github.io/abx-plugins/)
docker compose run --rm archivebox config --set YTDLP_MAX_SIZE=750m

This will apply the config to all containers or archivebox instances that access the collection.

If you're only running one container, or if you want to scope config options to only apply to a particular container, you can set them in that container's environment: section:

...

services:
    archivebox:
        ...
        environment:
            - USE_COLOR=False
            - SHOW_PROGRESS=False
            - CHECK_SSL_VALIDITY=False
            - RESOLUTION=1900,1820
            - MEDIA_TIMEOUT=512000
        ...

You can also specify an env file via CLI when running compose using docker compose --env-file=/path/to/config.env ... although you must specify the variables in the environment: section that you want to have passed down to the ArchiveBox container from the passed env file.

For public HTTPS, start the default stack with docker compose up -d, open the admin UI on port 8000, and follow the first-run wizard. It gives the DNS, upstream, and certificate settings to enter in Cloudflare, Nginx Proxy Manager, Caddy, Traefik, Tailscale, or your hosting platform's ingress UI, then verifies the public URLs before saving BASE_URL and SERVER_SECURITY_MODE.

Use exactly one of these certificate layouts:

• Single-domain mode: one certificate for the BASE_URL hostname, proxied to ArchiveBox port 8000.
• Isolated-subdomain mode: one certificate covering both the BASE_URL hostname and *.BASE_URL, normally obtained through DNS-01.

Never enable on-demand TLS or request individual certificates for snap-* hostnames. The bundled Compose file also contains opt-in Cloudflare Tunnel and Traefik examples for users who prefer them; they follow the same certificate rules.

---

Docker

Setup

Fetch and run the ArchiveBox Docker image to create your initial archive.

docker pull archivebox/archivebox:dev

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

(You can create a collection in any directory you want, ~/archivebox/data is just used as an example here)

If you encounter permissions issues, make sure the mounted data directory is writable by its intended owner. Docker startup automatically uses the first non-root owner detected from the existing collection, or the default archivebox user when the data directory is root-owned.

Upgrading

See the wiki page on Upgrading or Merging Archives: Upgrading with plain Docker for instructions. ➡️

Usage

The Docker CLI docker run ... archivebox/archivebox:dev [subcommand] works just like the non-Docker archivebox [subcommand] CLI.

First, make sure you're cd'ed into your collection data folder (e.g. ~/archivebox/data).

docker run -it -v $PWD:/data archivebox/archivebox:dev help

To add a single URL, pass it as an arg or pipe it in via stdin:

docker run -it -v $PWD:/data archivebox/archivebox:dev add 'https://example.com'
# OR
echo 'https://example.com' | docker run -i -v $PWD:/data archivebox/archivebox:dev add

To archive multiple URLs at once, pass text containing URLs in via stdin:

docker run -i -v $PWD:/data archivebox/archivebox:dev add < urls.txt
# OR
curl 'https://example.com/some/rss/feed.xml' | docker run -i -v $PWD:/data archivebox/archivebox:dev add

You can also use the --depth=1 flag to tell ArchiveBox to recursively archive the URLs within a provided source.

docker run -it -v $PWD:/data archivebox/archivebox:dev add --depth=1 'https://example.com/some/rss/feed.xml'

Accessing the data

The docker run -v /path/on/host:/path/inside/container flag specifies where your data dir lives on the host.

For example to use a folder on an external USB drive (instead of the current directory $PWD or ~/archivebox/data):

docker run -it -v /media/USB-DRIVE/archivebox/data:/data archivebox/archivebox:dev ...

Then to view your data, you can look in the folder on the host /media/USB-DRIVE/archivebox/data, or use the Web UI:

docker run -it -v /media/USB-DRIVE/archivebox/data:/data -p 8000:8000 archivebox/archivebox:dev
# then open http://web.archivebox.localhost:8000

Configuration

The easiest way is to use archivebox config --set KEY=value or edit ./ArchiveBox.conf (in your collection dir).

For example, this sets TIMEOUT=120 as a persistent setting for the collection:

docker run -it -v $PWD:/data archivebox/archivebox:dev config --set TIMEOUT=120
# OR edit ./ArchiveBox.conf and add this under its existing [ARCHIVING_CONFIG] section:
TIMEOUT=120

ArchiveBox in Docker also accepts config as environment variables, see more on the Configuration page (and the abx-plugins config reference for per-plugin options).

For example, this disables the screenshot extractor for a single run (without persisting for other runs):

docker run -it -v $PWD:/data -e SCREENSHOT_ENABLED=False archivebox/archivebox:dev add 'https://example.com'
# OR
echo 'SCREENSHOT_ENABLED=False' >> ./.env
docker run ... --env-file=./.env archivebox/archivebox:dev ...