Self-host ArchiveBox with Levelrail

Verified

A self-hosted web archiver that saves pages as HTML, PDF, screenshots, WARC and media so links never rot. Creates the admin account on first start.

  • AuthorArchiveBoxVerified by Levelrail
  • LicenceMIT
  • Memory1.5 GiB
  • Archarm64
  • Services1

How to self-host ArchiveBox

  1. Pull the images

    One image is pulled on your server.

    Show images
    • archivebox/archivebox:0.9.76
  2. Create the app

    One service starts in a single Compose app, with 2 named volume mounts for your data, on port 5797.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 3 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

ArchiveBox requirements

Memory
About 1.5 GiB
Architectures
amd64 image published, arm64 tested
Ports
5797
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
MIT, permissive license
  • Verified. Verified on arm64 with image tag 0.9.76. Our CI ran this exact image version and it answered on its health path. Evidence

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then ArchiveBox. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the ArchiveBox docs page.

Deploy ArchiveBox your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy ArchiveBox from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain archivebox=app.example.com.

levelrail-cli templates install archivebox --name my-archivebox

Deploy ArchiveBox with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/archivebox/install \
  -d '{
    "name": "my-archivebox"
  }'

ArchiveBox configuration

ArchiveBox services

ServiceImagePortsVolumes
archivebox archivebox/archivebox:0.9.76 5797 data -> /datatmp -> /tmp/archivebox

ArchiveBox environment variables

VariableServiceValue
ADMIN_PASSWORD archivebox Generated at deploy
ADMIN_USERNAME archivebox Preset by the template
ARCHIVEDOTORG_ENABLED archivebox Preset by the template
PUBLIC_ADD_VIEW archivebox Preset by the template

Ports and volumes

Ports
5797
Volumes
2 named mounts: data -> /data, tmp -> /tmp/archivebox

ArchiveBox FAQ

How much memory does ArchiveBox need?

The catalog lists about 1.5 GiB of memory for ArchiveBox.

Does ArchiveBox run on arm64?

For ArchiveBox, arm64 is tested; amd64 is image published.

What licence is ArchiveBox under?

ArchiveBox is licensed under MIT, which is permissive, with few conditions on reuse.

Does ArchiveBox need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which ports does ArchiveBox use?

ArchiveBox listens on port 5797 inside the stack.

Where does ArchiveBox keep its data?

In named volumes: data mounted at /data and tmp mounted at /tmp/archivebox.

Can I deploy ArchiveBox on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id archivebox for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image archivebox/archivebox:0.9.76 is what you deploy there.

levelrail-cli templates install archivebox --name my-archivebox