ArchiveBox
_{Open-source self-hosted web archiving.}

docker-compose (macOS/Linux/Windows)   👈  recommended   (click to expand)

1. Install Docker and Docker Compose on your system (if not already installed).
2. Download the docker-compose.yml file into a new empty directory (can be anywhere).

   mkdir ~/archivebox && cd ~/archivebox
   curl -O 'https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/dev/docker-compose.yml'
   

3. Run the initial setup and create an admin user.

   docker compose run archivebox init --setup
   

4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

   docker compose up
   # completely optional, CLI can always be used without running a server
   # docker compose run [-T] archivebox [subcommand] [--args]
   

docker run (macOS/Linux/Windows)

1. Install Docker on your system (if not already installed).
2. Create a new empty directory and initialize your collection (can be anywhere).

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

3. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

   docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox
   # completely optional, CLI can always be used without running a server
   # docker run -v $PWD:/data -it [subcommand] [--args]
   

bash auto-setup script (macOS/Linux)

1. Install Docker on your system (optional, highly recommended but not required).
2. Run the automatic setup script.

   curl -sSL 'https://get.archivebox.io' | sh

apt (Ubuntu/Debian)

1. Add the ArchiveBox repository to your sources.
   

   echo "deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main" | sudo tee /etc/apt/sources.list.d/archivebox.list
   sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys C258F79DCC02E369
   sudo apt update
   

2. Install the ArchiveBox package using apt.

   sudo apt install archivebox
   sudo python3 -m pip install --upgrade --ignore-installed archivebox   # pip needed because apt only provides a broken older version of Django
   

3. Create a new empty directory and initialize your collection (can be anywhere).

   mkdir ~/archivebox && cd ~/archivebox
   archivebox init --setup           # if any problems, install with pip instead
   

   Note: If you encounter issues with NPM/NodeJS, install a more recent version.
   
   
4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

   archivebox server 0.0.0.0:8000
   # completely optional, CLI can always be used without running a server
   # archivebox [subcommand] [--args]
   

brew (macOS)

1. Install Homebrew on your system (if not already installed).
2. Install the ArchiveBox package using brew.

   brew tap archivebox/archivebox
   brew install archivebox
   

3. Create a new empty directory and initialize your collection (can be anywhere).

   mkdir ~/archivebox && cd ~/archivebox
   archivebox init --setup         # if any problems, install with pip instead
   

4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

   archivebox server 0.0.0.0:8000
   # completely optional, CLI can always be used without running a server
   # archivebox [subcommand] [--args]
   

pip (macOS/Linux/BSD)

1. Install Python >= v3.9 and Node >= v18 on your system (if not already installed).
2. Install the ArchiveBox package using pip3.

   pip3 install archivebox
   

3. Create a new empty directory and initialize your collection (can be anywhere).

   mkdir ~/archivebox && cd ~/archivebox
   archivebox init --setup
   # install any missing extras like wget/git/ripgrep/etc. manually as needed
   

4. Optional: Start the server then login to the Web UI http://127.0.0.1:8000 ⇢ Admin.

   archivebox server 0.0.0.0:8000
   # completely optional, CLI can always be used without running a server
   # archivebox [subcommand] [--args]
   

pacman / pkg / nix (Arch/FreeBSD/NixOS/more)

• Arch: yay -S archivebox (contributed by @imlonghao)
• FreeBSD: curl -sSL 'https://get.archivebox.io' | sh (uses pkg + pip3 under-the-hood)
• Nix: nix-env --install archivebox (contributed by @siraben)
• Guix: guix install archivebox (contributed by @rakino)
• More: contribute another distribution...!

docker + electron Desktop App (macOS/Linux/Windows)

1. Install Docker on your system (if not already installed).
2. Download a binary release for your OS or build the native app from source
   
   • macOS: ArchiveBox.app.zip
   • Linux: ArchiveBox.deb (alpha: build manually)
   • Windows: ArchiveBox.exe (beta: build manually)

Paid hosting solutions (cloud VPS)

• (get hosting, support, and feature customization directy from us)
• (for a generalist software consultancy that helps with ArchiveBox maintainance)

Other providers of paid ArchiveBox hosting (not officially endorsed):



• 
• (USD $29-250/mo, pricing)
• (from USD $2.6/mo)
• (USD $5-50+/mo, 🎗  referral link, instructions)
• (USD $2.5-50+/mo, 🎗  referral link, instructions)
• (USD $10-50+/mo, instructions)
• (USD $60-200+/mo)
• (USD $60-200+/mo)

_{Referral links marked 🎗 provide $5-10 of free credit for new users and help pay for our demo server hosting costs.}

mkdir ~/archivebox && cd ~/archivebox   # just an example, can be anywhere
archivebox init

/data/
    index.sqlite3
    ArchiveBox.conf
    archive/
        ...
        1617687755/
            index.html
            index.json
            screenshot.png
            media/some_video.mp4
            warc/1617687755.warc.gz
            git/somerepo.git
            ...

Learn More

• https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#Disk-Layout
• https://github.com/ArchiveBox/ArchiveBox/wiki/Usage#large-archives
• https://github.com/ArchiveBox/ArchiveBox/wiki/Security-Overview#output-folder
• https://github.com/ArchiveBox/ArchiveBox/wiki/Publishing-Your-Archive
• https://github.com/ArchiveBox/ArchiveBox/wiki/Upgrading-or-Merging-Archives

Comparison With Centralized Public Archives

Comparison With Other Self-Hosted Archiving Options