ArchiveBox

Infrastructure512MB+ RAM

Self-hosted internet archiving tool

Download Server Compass View Documentation

archivewebbackup

Deploy ArchiveBox in 3 Steps

Connect Your VPS

Add your server credentials to Server Compass

Select ArchiveBox

Choose from our template library

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required

CLI Deployment

Deploy ArchiveBox Yourself

Want full control? Here's how to deploy ArchiveBox yourself using Docker Compose.

Remote into Your Server

Initiate a secure shell connection to your server using the command below.

terminal

# Connect to your VPS
ssh root@your-server-ip

# Or with a specific SSH key
ssh -i ~/.ssh/your-key root@your-server-ip

First time? Docker required! Install it with: curl -fsSL https://get.docker.com | sh

Create the App Directory

Organize your deployment by creating a dedicated project folder.

terminal

# Create and navigate to project directory
mkdir -p ~/apps/archivebox
cd ~/apps/archivebox

Write Your docker-compose.yml

Create a new docker-compose.yml file and paste this configuration:

docker-compose.yml

services:
  archivebox:
    image: archivebox/archivebox:latest
    ports:
      - "8000:8000"
    environment:
      - ALLOWED_HOSTS=*
      - PUBLIC_INDEX=True
      - PUBLIC_SNAPSHOTS=True
      - PUBLIC_ADD_VIEW=False
    volumes:
      - archivebox_data:/data
    restart: unless-stopped

volumes:
  archivebox_data:

Required Settings

PORTHost port(default: 8000)

Launch the Containers

Start the services and tail the logs to verify startup.

terminal

# Spin up containers
docker compose up -d

# Verify deployment
docker compose ps

# Check logs for errors
docker compose logs -f

Open Firewall Ports

Open the required port in your firewall to allow access.

terminal

# Allow the application port through firewall
sudo ufw allow 8000/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:8000

Skip the Terminal

Want the easy way? Try Server Compass.

Skip the terminal and deploy ArchiveBox with a visual interface. Configure everything with clicks, not commands.

Visual config editor
Instant deployment
Automatic HTTPS
Smooth updates
Live monitoring
Quick rollbacks

Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying ArchiveBox with Server Compass, complete these steps to finish setup

Create admin user

Add URLs to archive

Configure archiving options

Need help? Check out our documentation for detailed guides.

ArchiveBox FAQ

Common questions about self-hosting ArchiveBox

How do I deploy ArchiveBox with Server Compass?

Simply download Server Compass, connect to your VPS, and select ArchiveBox from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for ArchiveBox?

ArchiveBox requires a minimum of 512MB RAM. We recommend a VPS with at least 1024MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing ArchiveBox data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard ArchiveBox backup and restore procedures.

How do I update ArchiveBox to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest ArchiveBox image will be pulled and deployed with zero downtime.

Is ArchiveBox free to self-host?

ArchiveBox is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.