1
Step 1Open the server Apps tab
Select the tutorial-vps VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.
Back to all templates
ArchiveBox
Infrastructure512MB+ RAM
Self-hosted internet archiving tool
archivewebbackup
Deploy ArchiveBox in 3 Steps
1
Connect Your VPS
Add your server credentials to Server Compass
2
Select ArchiveBox
Choose from our template library
3
Deploy & Configure
Fill in settings and click Deploy
No Docker knowledge required
Step-by-step deployment guide
Deploy ArchiveBox on a VPS with Server Compass
Use the ArchiveBox template in Server Compass to deploy a self-hosted internet archive on your VPS, then verify the web UI in a browser.
About 10 minutesBrowser verified
2
Step 2Choose an app template
Click New App and choose the template deployment path so Server Compass can load the built-in catalog.
3
Step 3Search for ArchiveBox
Use the template picker search to find ArchiveBox in the Server Compass template catalog.
4
Step 4Select the ArchiveBox template
Choose the ArchiveBox template. Server Compass fills the archive service, persistent data volume, public settings, and web port.
5
Step 5Review the ArchiveBox settings
Confirm the app name and compose service. In this run, the app was named archivebox-demo and used host port 8000.
6
Step 6Deploy ArchiveBox
Review the generated compose settings, confirm the ArchiveBox web port is available, and click Deploy.
7
Step 7Watch the deployment progress
Keep the deployment modal open while Server Compass uploads the compose file, pulls the ArchiveBox image, starts the container, and verifies the stack.
8
Step 8Confirm ArchiveBox is running
After deployment finishes, return to the Apps tab and confirm the ArchiveBox app is marked Running with its application URL available.
9
Step 9Open ArchiveBox in the browser
Open the application URL in a browser. The ArchiveBox web UI confirms the archiving service is reachable.
After ArchiveBox Opens
- Create an ArchiveBox admin user before enabling private archive management workflows.
- Use a VPN, IP allowlist, firewall rule, or authenticated reverse proxy for production access.
- Review the public index and public snapshot settings before exposing the service to the internet.
- Add URLs to archive and tune extractors for the content types you need to preserve.
- Back up the ArchiveBox data volume before moving or replacing the VPS.
- Keep the ArchiveBox image updated for dependency and security fixes.
Verified Result
The ArchiveBox web interface loaded successfully from the deployed container.
ArchiveBox deployment questions
What does the ArchiveBox template deploy?
It deploys the ArchiveBox container with a persistent archive data volume and a public web port.
Which port did the tutorial use?
The tutorial used host port 8000, which maps to the ArchiveBox web UI on container port 8000.
Does this template create an admin user automatically?
No. Create the admin user after deployment with the ArchiveBox management command noted in the template security notes.
Should this become a blog post?
No. The deployment guide should live on the ArchiveBox template detail page and be linked from the reusable template deployment docs page.
CLI Deployment
Deploy ArchiveBox Yourself
Want full control? Here's how to deploy ArchiveBox yourself using Docker Compose.
1
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-ipFirst time? Docker required! Install it with: curl -fsSL https://get.docker.com | sh
2
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/archivebox3
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)4
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 -f5
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:8000Skip 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
1
Create admin user
2
Add URLs to archive
3
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.
Ready to Self-Host ArchiveBox?
Download Server Compass and deploy ArchiveBox to your VPS in under 3 minutes. No Docker expertise required.
Download Server Compass