What’s actually slowing this PC down?
Pick the symptom - the matching free tool is one click away.
On Ubuntu, the recommended straightforward way to install ArchiveBox is to run the project’s official Docker Compose setup. Install Docker Engine with Compose v2, download the current Compose file, start the service, then visit /admin/ to complete first-run setup.
What you need before installing
- An Ubuntu host on amd64 or arm64, both listed as supported by the ArchiveBox project.
- Docker Engine or Docker Desktop, with Docker Compose v2 available. The commands below use the v2 syntax,
docker compose. - A stable directory for the Compose project and its persistent collection data.
The ArchiveBox project recommends Compose as its easiest full-featured installation route. This guide uses the current deployment documentation and Compose file rather than mixing in older Docker instructions. See the official installation overview and Docker deployment guide.
As an Amazon Associate I earn from qualifying purchases.
Install ArchiveBox with Docker Compose
- Check that Docker and Compose are available.
docker --version docker compose versionIf the second command fails, install or configure Docker Compose v2 before continuing.
- Create the project and data directories, then download the official Compose file.
mkdir -p ~/archivebox/data && cd ~/archivebox curl -fsSL https://raw.githubusercontent.com/ArchiveBox/docker-archivebox/main/docker-compose.yml -o docker-compose.ymlThe
datadirectory is on the Ubuntu host; Compose mounts it for ArchiveBox collection data. Keep the directory in a location with enough space and include it in your backup plan. - Pull the image and start the service.
docker compose pull docker compose up -d --wait--waitasks Compose to wait for services to become healthy or running before returning. The deployment includes a/health/health check.
Complete the first-run admin setup
Open http://HOSTNAME-OR-IP:PORT/admin/ in a browser, substituting the hostname or IP used to reach the Ubuntu machine and the configured host port. Complete the setup wizard; it configures the canonical URL and security mode. The current deployment guide documents BASE_URL and SERVER_SECURITY_MODE as environment-variable overrides. It also documents optional ADMIN_USERNAME and ADMIN_PASSWORD variables for creating an administrator without the interactive wizard.
Understand the port and Compose file version
The current Docker deployment guide describes the container listening on port 5797. Set ARCHIVEBOX_PORT to change the host-side port; the container continues to listen on 5797. Check the downloaded Compose file to confirm the host port and any environment settings in the configuration you are actually running.
#1 Best Overall
The quickstart downloads the Compose file from the repository’s mutable main branch, and the current guide describes a dev image deployment. The quickstart does not specify a fixed release number or image digest. For a reproducible deployment, review the fetched Compose file and pin a reviewed image version or repository commit in line with your maintenance policy rather than assuming the downloaded configuration is immutable.
Verify the installation and archive a test URL
Run these from ~/archivebox, the directory containing docker-compose.yml:
docker compose exec archivebox archivebox version
docker compose exec archivebox archivebox add --depth=1 'https://example.com'
docker compose exec archivebox archivebox status
docker compose logs -f archiveboxThe first command checks the ArchiveBox version in the running service. The add command submits a test URL, status reports collection status, and logs -f follows the service logs until you stop it. For a one-off command when the service is not already running, the deployment documentation distinguishes docker compose run --rm archivebox ... from exec, which runs a command in an existing service container.
The Tool Desk
Outbyte Driver Updater FREEScan for outdated or missing drivers - takes under a minuteDriver Scan →Outbyte PC Repair FREERepair Windows errors before they cause bigger problemsFix Now →Common installation problems
docker composeis not recognized: Compose v2 is required for this command sequence. Install or enable the Compose v2 plugin, then confirmdocker compose versionsucceeds.- The admin page does not load: Confirm the service started with
docker compose psand inspectdocker compose logs -f archivebox. Use the Ubuntu host’s reachable hostname or IP and the host port configured in the Compose file; the container port is5797. - Port conflict: If another service is using the configured host port, choose a different value with
ARCHIVEBOX_PORTand restart the Compose project. Do not change the container listener from5797based on older instructions. - Setup settings do not match the address you use: Complete the wizard using the intended canonical address, or review
BASE_URLandSERVER_SECURITY_MODEif you configure these values through environment variables. - Data seems missing after recreating the service: Check that you are using the same project directory and that the host-side
datadirectory remains in place. Back up that directory as part of your own retention plan.
Or skip the browser setup
If you also need screenshots of web pages for development workflows, ScreenshotNeo is a website screenshot API and MCP server. A single request can return an image or PDF; for example, this cURL request saves a WebP screenshot:
curl -G "https://api.screenshotneo.com/v1/shot" -d access_key=YOUR_API_KEY --data-urlencode url=https://example.com -o shot.webpSee the ScreenshotNeo API documentation for setup and options. It removes cookie banners, newsletter popups and chat widgets before capture; bot checks, blank pages and failed loads are not billed; and its MCP server lets AI agents take screenshots. The free plan includes 1,000 screenshots a month with no card, and paid plans start at $5 for 3,000. Sign up for free.
Independent reader supportYour contribution helps us test, update, and keep practical guides available for everyone.Frequently Asked Questions
Can I run ArchiveBox on Ubuntu ARM64?
Yes. The ArchiveBox installation overview lists Ubuntu on both amd64 and arm64 as supported; this Compose path requires Docker Compose v2.
Does the Compose quickstart pin a specific ArchiveBox release?
No. It fetches the Compose file from the mutable main branch, and the deployment guide does not give a fixed release number for this quickstart.
Quick Recap
Best Value
Rank #4
Product prices and availability are accurate as of the date/time indicated and are subject to change. Any price and availability information displayed on Amazon at the time of purchase will apply.
