archivebox/archivebox

ArchiveBox
_{The open-source self-hosted web archive.}

▶️ Quickstart | Demo | Github | Documentation | Info & Motivation | Community | Roadmap

"Your own personal internet archive" (网站存档 / 爬虫)

---

ArchiveBox is a powerful self-hosted internet archiving solution written in Python 3. You feed it URLs of pages you want to archive, and it saves them to disk in a variety of formats depending on the configuration and the content it detects.

Your archive can be managed through the command line with commands like archivebox add, through the built-in Web UI archivebox server, or via the Python library API (beta). It can ingest bookmarks from a browser or service like Pocket/Pinboard, your entire browsing history, RSS feeds, or URLs one at a time. You can also schedule regular/realtime imports with archivebox schedule.

The main index is a self-contained index.sqlite3 file, and each snapshot is stored as a folder data/archive/<timestamp>/, with an easy-to-read index.html and index.json within. For each page, ArchiveBox auto-extracts many types of assets/media and saves them in standard formats, with out-of-the-box support for: several types of HTML snapshots (wget, Chrome headless, singlefile), PDF snapshotting, screenshotting, WARC archiving, git repositories, images, audio, video, subtitles, article text, and more. The snapshots are browseable and managable offline through the filesystem, the built-in webserver, or the Python library API.

Quickstart

It works on Linux/BSD (Intel and ARM CPUs with docker/apt/pip3), macOS (with docker/brew/pip3), and Windows (beta with docker/pip3).

pip3 install archivebox
archivebox --version
# install extras as-needed, or use one of full setup methods below to get everything out-of-the-box

mkdir ~/archivebox && cd ~/archivebox    # this can be anywhere
archivebox init

archivebox add 'https://example.com'
archivebox add --depth=1 'https://example.com'
archivebox schedule --every=day https://getpocket.com/users/USERNAME/feed/all
archivebox oneshot --extract=title,favicon,media https://www.youtube.com/watch?v=dQw4w9WgXcQ
archivebox help   # to see more options

(click to expand the sections below for full setup instructions)

Get ArchiveBox with docker-compose on any platform (recommended, everything included out-of-the-box)

First make sure you have Docker installed: https://docs.docker.com/get-docker/

This is the recommended way to run ArchiveBox because it includes all the extractors like chrome, wget, youtube-dl, git, etc., as well as full-text search with sonic, and many other great features.

# create a new empty directory and initalize your collection (can be anywhere)
mkdir ~/archivebox && cd ~/archivebox
curl -O https://raw.githubusercontent.com/ArchiveBox/ArchiveBox/master/docker-compose.yml
docker-compose run archivebox init
docker-compose run archivebox --version

# start the webserver and open the UI (optional)
docker-compose run archivebox manage createsuperuser
docker-compose up -d
open http://127.0.0.1:8000

# you can also add links and manage your archive via the CLI:
docker-compose run archivebox add 'https://example.com'
docker-compose run archivebox status
docker-compose run archivebox help  # to see more options

Get ArchiveBox with docker on any platform

First make sure you have Docker installed: https://docs.docker.com/get-docker/

# create a new empty directory and initalize your collection (can be anywhere)
mkdir ~/archivebox && cd ~/archivebox
docker run -v $PWD:/data -it archivebox/archivebox init
docker run -v $PWD:/data -it archivebox/archivebox --version

# start the webserver and open the UI (optional)
docker run -v $PWD:/data -it archivebox/archivebox manage createsuperuser
docker run -v $PWD:/data -p 8000:8000 archivebox/archivebox server 0.0.0.0:8000
open http://127.0.0.1:8000

# you can also add links and manage your archive via the CLI:
docker run -v $PWD:/data -it archivebox/archivebox add 'https://example.com'
docker run -v $PWD:/data -it archivebox/archivebox status
docker run -v $PWD:/data -it archivebox/archivebox help  # to see more options

Get ArchiveBox with apt on Ubuntu >=20.04

sudo add-apt-repository -u ppa:archivebox/archivebox
sudo apt install archivebox

# create a new empty directory and initalize your collection (can be anywhere)
mkdir ~/archivebox && cd ~/archivebox
npm install --prefix . 'git+https://github.com/ArchiveBox/ArchiveBox.git'
archivebox init
archivebox --version

# start the webserver and open the web UI (optional)
archivebox manage createsuperuser
archivebox server 0.0.0.0:8000
open http://127.0.0.1:8000

# you can also add URLs and manage the archive via the CLI and filesystem:
archivebox add 'https://example.com'
archivebox status
archivebox list --html --with-headers > index.html
archivebox list --json --with-headers > index.json
archivebox help  # to see more options

For other Debian-based systems or older Ubuntu systems you can add these sources to /etc/apt/sources.list:

deb http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main
deb-src http://ppa.launchpad.net/archivebox/archivebox/ubuntu focal main

(you may need to install some other dependencies manually however)

Get ArchiveBox with brew on macOS >=10.13

brew install archivebox/archivebox/archivebox

# create a new empty directory and initalize your collection (can be anywhere)
mkdir ~/archivebox && cd ~/archivebox
npm install --prefix . 'git+https://github.com/ArchiveBox/ArchiveBox.git'
archivebox init
archivebox --version

# start the webserver and open the web UI (optional)
archivebox manage createsuperuser
archivebox server 0.0.0.0:8000
open http://127.0.0.1:8000

# you can also add URLs and manage the archive via the CLI and filesystem:
archivebox add 'https://example.com'
archivebox status
archivebox list --html --with-headers > index.html
archivebox list --json --with-headers > index.json
archivebox help  # to see more options

Get ArchiveBox with pip on any platform

pip3 install archivebox

# create a new empty directory and initalize your collection (can be anywhere)
mkdir ~/archivebox && cd ~/archivebox
npm install --prefix . 'git+https://github.com/ArchiveBox/ArchiveBox.git'
archivebox init
archivebox --version
# Install any missing extras like wget/git/chrome/etc. manually as needed

# start the webserver and open the web UI (optional)
archivebox manage createsuperuser
archivebox server 0.0.0.0:8000
open http://127.0.0.1:8000

# you can also add URLs and manage the archive via the CLI and filesystem:
archivebox add 'https://example.com'
archivebox status
archivebox list --html --with-headers > index.html
archivebox list --json --with-headers > index.json
archivebox help  # to see more options

---

DEMO: archivebox.zervice.io/
For more information, see the full Quickstart guide, Usage, and Configuration docs.

---

Overview

ArchiveBox is a command line tool, self-hostable web-archiving server, and Python library all-in-one. It can be installed on Docker, macOS, and Linux/BSD, and Windows. You can download and install it as a Debian/Ubuntu package, Homebrew package, Python3 package, or a Docker image. No matter which install method you choose, they all provide the same CLI, Web UI, and on-disk data format.

To use ArchiveBox you start by creating a folder for your data to live in (it can be anywhere on your system), and running archivebox init inside of it. That will create a sqlite3 index and an ArchiveBox.conf file. After that, you can continue to add/export/manage/etc using the CLI archivebox help, or you can run the Web UI (recommended). If you only want to archive a single site, you can run archivebox oneshot to avoid having to create a whole collection.

The CLI is considered "stable", the ArchiveBox Python API and REST APIs are "beta", and the desktop app is "alpha".

At the end of the day, the goal is to sleep soundly knowing that the part of the internet you care about will be automatically preserved in multiple, durable long-term formats that will be accessible for decades (or longer). You can also self-host your archivebox server on a public domain to provide archive.org-style public access to your site snapshots.

^{Demo | Usage | Screenshots}
_{. . . . . . . . . . . . . . . . . . . . . . . . . . . .}

Key Features

• Free & open source, doesn't require signing up for anything, stores all data locally
• Few dependencies and simple command line interface
• Comprehensive documentation, active development, and rich community
• Easy to set up scheduled importing from multiple sources
• Uses common, durable, long-term formats like HTML, JSON, PDF, PNG, and WARC
• Suitable for paywalled / authenticated content (can use your cookies) (do not do this until v0.5 is released with some security fixes)
• Doesn't require a constantly-running daemon, proxy, or native app
• Provides a CLI, Python API, self-hosted web UI, and REST API (WIP)
• Architected to be able to run many varieties of scripts during archiving, e.g. to extract media, summarize articles, scroll pages, close modals, expand comment threads, etc.
• Can also mirror content to 3rd-party archiving services automatically for redundancy

Input formats

ArchiveBox supports many input formats for URLs, including Pocket & Pinboard exports, Browser bookmarks, Browser history, plain text, HTML, markdown, and more!

echo 'http://example.com' | archivebox add
archivebox add 'https://example.com/some/page'
archivebox add < ~/Downloads/firefox_bookmarks_export.html
archivebox add < any_text_with_urls_in_it.txt
archivebox add --depth=1 'https://example.com/some/downloads.html'
archivebox add --depth=1 'https://news.ycombinator.com#2020-12-12'

• Browser history or bookmarks exports (Chrome, Firefox, Safari, IE, Opera, and more)
• RSS, XML, JSON, CSV, SQL, HTML, Markdown, TXT, or any other text-based format
• Pocket, Pinboard, Instapaper, Shaarli, Delicious, Reddit Saved Posts, Wallabag, Unmark.it, OneTab, and more

See the Usage: CLI page for documentation and examples.

It also includes a built-in scheduled import feature with archivebox schedule and browser bookmarklet, so you can pull in URLs from RSS feeds, websites, or the filesystem regularly/on-demand.

Output formats

All of ArchiveBox's state (including the index, snapshot data, and config file) is stored in a single folder called the "ArchiveBox data folder". All archivebox CLI commands must be run from inside this folder, and you first create it by running archivebox init.

The on-disk layout is optimized to be easy to browse by hand and durable long-term. The main index is a standard sqlite3 database (it can also be exported as static JSON/HTML), and the archive snapshots are organized by date-added timestamp in the archive/ subfolder. Each snapshot subfolder includes a static JSON and HTML index describing its contents, and the snapshot extrator outputs are plain files within the folder (e.g. media/example.mp4, git/somerepo.git, static/someimage.png, etc.)

 ls ./archive/<timestamp>/

• Index: index.html & index.json HTML and JSON index files containing metadata and details
• Title: title title of the site
• Favicon: favicon.ico favicon of the site
• Headers: headers.json Any HTTP headers the site returns are saved in a json file
• SingleFile: singlefile.html HTML snapshot rendered with headless Chrome using SingleFile
• WGET Clone: example.com/page-name.html wget clone of the site, with .html appended if not present
• WARC: warc/<timestamp>.gz gzipped WARC of all the resources fetched while archiving
• PDF: output.pdf Printed PDF of site using headless chrome
• Screenshot: screenshot.png 1440x900 screenshot of site using headless chrome
• DOM Dump: output.html DOM Dump of the HTML after rendering using headless chrome
• Readability: article.html/json Article text extraction using Readability
• URL to Archive.org: archive.org.txt A link to the saved site on archive.org
• Audio & Video: media/ all audio/video files + playlists, including subtitles & metadata with youtube-dl
• Source Code: git/ clone of any repository found on github, bitbucket, or gitlab links
• More coming soon! See the Roadmap...

It does everything out-of-the-box by default, but you can disable or tweak individual archive methods via environment variables or config file.

Dependencies

You don't need to install all the dependencies, ArchiveBox will automatically enable the relevant modules based on whatever you have available, but it's recommended to use the official Docker image with everything preinstalled.

If you so choose, you can also install ArchiveBox and its dependencies directly on any Linux or macOS systems using the automated setup script or the system package manager.

ArchiveBox is written in Python 3 so it requires python3 and pip3 available on your system. It also uses a set of optional, but highly recommended external dependencies for archiving sites: wget (for plain HTML, static files, and WARC saving), chromium (for screenshots, PDFs, JS execution, and more), youtube-dl (for audio and video), git (for cloning git repos), and nodejs (for readability and singlefile), and more.

Caveats

If you're importing URLs containing secret slugs or pages with private content (e.g Google Docs, CodiMD notepads, etc), you may want to disable some of the extractor modules to avoid leaking private URLs to 3rd party APIs during the archiving process.

# don't do this:
archivebox add 'https://docs.google.com/document/d/12345somelongsecrethere'
archivebox add 'https://example.com/any/url/you/want/to/keep/secret/'

# without first disabling share the URL with 3rd party APIs:
archivebox config --set SAVE_ARCHIVE_DOT_ORG=False   # disable saving all URLs in Archive.org
archivebox config --set SAVE_FAVICON=False      # optional: only the domain is leaked, not full URL
archivebox config --set CHROME_BINARY=chromium  # optional: switch to chromium to avoid Chrome phoning home to Google

Be aware that malicious archived JS can also read the contents of other pages in your archive due to snapshot CSRF and XSS protections being imperfect. See the Security Overview page for more details.

# visiting an archived page with malicious JS:
https://127.0.0.1:8000/archive/1602401954/example.com/index.html

# example.com/index.js can now make a request to read everything:
https://127.0.0.1:8000/index.html
https://127.0.0.1:8000/archive/*
# then example.com/index.js can send it off to some evil server

Support for saving multiple snapshots of each site over time will be added soon (along with the ability to view diffs of the changes between runs). For now ArchiveBox is designed to only archive each URL with each extractor type once. A workaround to take multiple snapshots of the same URL is to make them slightly different by adding a hash:

archivebox add 'https://example.com#2020-10-24'
...
archivebox add 'https://example.com#2020-10-25'

---

---

Background & Motivation

Vast treasure troves of knowledge are lost every day on the internet to link rot. As a society, we have an imperative to preserve some important parts of that treasure, just like we preserve our books, paintings, and music in physical libraries long after the originals go out of print or fade into obscurity.

Whether it's to resist censorship by saving articles before they get taken down or edited, or just to save a collection of early 2010's flash games you love to play, having the tools to archive internet content enables to you save the stuff you care most about before it disappears.

^{Image from WTF is Link Rot?...}

The balance between the permanence and ephemeral nature of content on the internet is part of what makes it beautiful. I don't think everything should be preserved in an automated fashion, making all content permanent and never removable, but I do think people should be able to decide for themselves and effectively archive specific content that they care about.

Because modern websites are complicated and often rely on dynamic content, ArchiveBox archives the sites in several different formats beyond what public archiving services like Archive.org and Archive.is are capable of saving. Using multiple methods and the market-dominant browser to execute JS ensures we can save even the most complex, finicky websites in at least a few high-quality, long-term data formats.

All the archived links are stored by date bookmarked in ./archive/<timestamp>, and everything is indexed nicely with JSON & HTML files. The intent is for all the content to be viewable with common software in 50 - 100 years without needing to run ArchiveBox in a VM.

Comparison to Other Projects

▶ Check out our community page for an index of web archiving initiatives and projects.

The aim of ArchiveBox is to go beyond what the Wayback Machine and other public archiving services can do, by adding a headless browser to replay sessions accurately, and by automatically extracting all the content in multiple redundant formats that will survive being passed down to historians and archivists through many generations.

User Interface & Intended Purpose

ArchiveBox differentiates itself from similar projects by being a simple, one-shot CLI interface for users to ingest bulk feeds of URLs over extended periods, as opposed to being a backend service that ingests individual, manually-submitted URLs from a web UI. However, we also have the option to add urls via a web interface through our Django frontend.

Private Local Archives vs Centralized Public Archives

Unlike crawler software that starts from a seed URL and works outwards, or public tools like Archive.org designed for users to manually submit links from the public internet, ArchiveBox tries to be a set-and-forget archiver suitable for archiving your entire browsing history, RSS feeds, or bookmarks, including private/authenticated content that you wouldn't otherwise share with a centralized service (do not do this until v0.5 is released with some security fixes). Also by having each user store their own content locally, we can save much larger portions of everyone's browsing history than a shared centralized service would be able to handle.

Storage Requirements

Because ArchiveBox is designed to ingest a firehose of browser history and bookmark feeds to a local disk, it can be much more disk-space intensive than a centralized service like the Internet Archive or Archive.today. However, as storage space gets cheaper and compression improves, you should be able to use it continuously over the years without having to delete anything. In my experience, ArchiveBox uses about 5gb per 1000 articles, but your milage may vary depending on which options you have enabled and what types of sites you're archiving. By default, it archives everything in as many formats as possible, meaning it takes more space than a using a single method, but more content is accurately replayable over extended periods of time. Storage requirements can be reduced by using a compressed/deduplicated filesystem like ZFS/BTRFS, or by setting SAVE_MEDIA=False to skip audio & video files.

Learn more

Whether you want to learn which organizations are the big players in the web archiving space, want to find a specific open-source tool for your web archiving need, or just want to see where archivists hang out online, our Community Wiki page serves as an index of the broader web archiving community. Check it out to learn about some of the coolest web archiving projects and communities on the web!

• Community Wiki
  • The Master Lists
    Community-maintained indexes of archiving tools and institutions.
  • Web Archiving Software
    Open source tools and projects in the internet archiving space.
  • Reading List
    Articles, posts, and blogs relevant to ArchiveBox and web archiving in general.
  • Communities
    A collection of the most active internet archiving communities and initiatives.
• Check out the ArchiveBox Roadmap and Changelog
• Learn why archiving the internet is important by reading the "On the Importance of Web Archiving" blog post.
• Or reach out to me for questions and comments via @ArchiveBoxApp or @theSquashSH on Twitter.

---

Documentation

We use the Github wiki system and Read the Docs (WIP) for documentation.

You can also access the docs locally by looking in the ArchiveBox/docs/ folder.

Getting Started

• Quickstart
• Install
• Docker

Reference

• Usage
• Configuration
• Supported Sources
• Supported Outputs
• Scheduled Archiving
• Publishing Your Archive
• Chromium Install
• Security Overview
• Troubleshooting
• Python API
• REST API (coming soon...)

More Info

• Tickets
• Roadmap
• Changelog
• Donations
• Background & Motivation
• Web Archiving Community

---

ArchiveBox Development

All contributions to ArchiveBox are welcomed! Check our issues and Roadmap for things to work on, and please open an issue to discuss your proposed implementation before working on things! Otherwise we may have to close your PR if it doesn't align with our roadmap.

Setup the dev environment

First, install the system dependencies from the "Bare Metal" section above. Then you can clone the ArchiveBox repo and install

git clone https://github.com/ArchiveBox/ArchiveBox && cd ArchiveBox
git checkout master  # or the branch you want to test
git submodule update --init --recursive
git pull --recurse-submodules

# Install ArchiveBox + python dependencies
python3 -m venv .venv && source .venv/bin/activate && pip install -e .[dev]
# or with pipenv: pipenv install --dev && pipenv shell

# Install node dependencies
npm install

# Optional: install extractor dependencies manually or with helper script
./bin/setup.sh

# Optional: develop via docker by mounting the code dir into the container
# if you edit e.g. ./archivebox/core/models.py on the docker host, runserver
# inside the container will reload and pick up your changes
docker build . -t archivebox
docker run -it -p 8000:8000 \
    -v $PWD/data:/data \
    -v $PWD/archivebox:/app/archivebox \
    archivebox server 0.0.0.0:8000 --debug --reload

Common development tasks

See the ./bin/ folder and read the source of the bash scripts within. You can also run all these in Docker. For more examples see the Github Actions CI/CD tests that are run: .github/workflows/*.yaml.

Run the linters

./bin/lint.sh

(uses flake8 and mypy)

Run the integration tests

./bin/test.sh

(uses pytest -s)

Make migrations or enter a django shell

cd archivebox/
./manage.py makemigrations

cd data/
archivebox shell

(uses pytest -s)

Build the docs, pip package, and docker image

./bin/build.sh

# or individually:
./bin/build_docs.sh
./bin/build_pip.sh
./bin/build_deb.sh
./bin/build_brew.sh
./bin/build_docker.sh

Roll a release

./bin/release.sh

(bumps the version, builds, and pushes a release to PyPI, Docker Hub, and Github Packages)

---

_{This project is maintained mostly in my spare time with the help from generous contributors and Monadical.com.}


Sponsor us on Github