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

1. InstallDocker on your system (if not already installed).
2. Download thedocker-compose.yml file into a new empty directory (can be anywhere).

   mkdir -p~/archivebox/data&&cd~/archivebox# Read and edit docker-compose.yml options as-needed after downloadingcurl -fsSL'https://docker-compose.archivebox.io'> docker-compose.yml

3. Run the initial setup to create an admin user (or set ADMIN_USER/PASS in docker-compose.yml)

   docker compose run archivebox init --setup

4. Next steps: Start the server then login to the Web UIhttp://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] [--help]docker compose run archivebox add'https://example.com'docker compose run archiveboxhelp

   For more info, seeInstall: Docker Compose in the Wiki. ➡️

Seebelow for more usage examples using the CLI, Web UI, orfilesystem/SQL/Python to manage your archive.

docker run (macOS/Linux/Windows)

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

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

3. Optional: Start the server then login to the Web UIhttp://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] [--help]docker run -v$PWD:/data -it archivebox/archiveboxhelp

   For more info, seeInstall: Docker Compose in the Wiki. ➡️

Seebelow for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.

bash auto-setup script (macOS/Linux)

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

   curl -fsSL'https://get.archivebox.io'| bash

   For more info, seeInstall: Bare Metal in the Wiki. ➡️

Seebelow for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.
Seesetup.sh for the source code of the auto-install script.
See"Against curl | sh as an install method" blog post for my thoughts on the shortcomings of this install method.

pip (macOS/Linux/BSD)

1. InstallPython >= v3.10 andNode >= v18 on your system (if not already installed).
2. Install the ArchiveBox package usingpip3 (oruvx).

   pip3 install --upgrade archivebox yt-dlp playwrightplaywright install --with-deps chromiumarchivebox version# install any missing extras shown using apt/brew/pkg/etc. see Wiki for instructions#    python@3.10 node curl wget git ripgrep ...

   See theInstall: Bare Metal Wiki for full install instructions for each OS...
3. Create a new empty directory and initialize your collection (can be anywhere).

   mkdir -p~/archivebox/data&&cd~/archivebox/data# for examplearchivebox init --setup# instantialize a new collection# (--setup auto-installs and link JS dependencies: singlefile, readability, mercury, etc.)

4. Optional: Start the server then login to the Web UIhttp://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] [--help]archiveboxhelp

Seebelow for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.

_{See thepip-archivebox repo for more details about this distribution.}

brew (macOS only)

1. InstallHomebrew on your system (if not already installed).
2. Install the ArchiveBox package usingbrew.

   brew tap archivebox/archiveboxbrew install archivebox# update to newest version with pip (sometimes brew package is outdated)pip install --upgrade --ignore-installed archivebox yt-dlp playwrightplaywright install --with-deps chromium# install chromium and its system dependenciesarchivebox version# make sure all dependencies are installed

   See theInstall: Bare Metal Wiki for more granular instructions for macOS... ➡️
3. Create a new empty directory and initialize your collection (can be anywhere).

   mkdir -p~/archivebox/data&&cd~/archivebox/dataarchivebox init --setup

4. Optional: Start the server then login to the Web UIhttp://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] [--help]archiveboxhelp

   
   

Seebelow for more usage examples using the CLI, Web UI, or filesystem/SQL/Python to manage your archive.
_{See thehomebrew-archivebox repo for more details about this distribution.}

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

Warning: These are contributed by external volunteers and may lag behind the officialpip channel.

• Arch:yay -S archivebox (contributed by@imlonghao)
• FreeBSD:curl -fsSL 'https://get.archivebox.io' | bash (usespkg +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. InstallDocker 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)

TrueNAS / UNRAID / YunoHost / Cloudron / etc. (self-hosting solutions)

Warning: These are contributed by external volunteers and may lag behind the officialpip channel.

• TrueNAS:Official ArchiveBox TrueChart /Custom App Guide (TrueCharts is discontinued, wait forElectric Eel)
• UnRaid
• Yunohost
• Cloudron
• Saltbox
• Portainer
• AppImage
• Runtipi
• Umbrel (need contributors...)
• More:contribute another distribution...!

Paid hosting solutions (cloud VPS)

• (get hosting, support, and feature customization directy from us)
• (generalist consultancy that has ArchiveBox experience)

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 $0-5+/mo)
• (USD $60-200+/mo)
• (USD $60-200+/mo)

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

For more discussion on managed and paid hosting options see here:Issue #531.

# Start the server on bare metal (pip/apt/brew/etc):archivebox manage createsuperuser# create a new admin user via CLIarchivebox server 0.0.0.0:8000# start the server# Or with Docker Compose:nano docker-compose.yml# setup initial ADMIN_USERNAME & ADMIN_PASSWORDdocker compose up# start the server# Or with a Docker container:docker run -v$PWD:/data -it archivebox/archivebox archivebox manage createsuperuserdocker run -v$PWD:/data -it -p 8000:8000 archivebox/archivebox

^{Openhttp://localhost:8000 to see your server's Web UI ➡️}

For more info, see ourUsage: Web UI wiki. ➡️

Optional: Change permissions to allow non-logged-in users

archivebox config --set PUBLIC_ADD_VIEW=True# allow guests to submit URLsarchivebox config --set PUBLIC_SNAPSHOTS=True# allow guests to see snapshot contentarchivebox config --set PUBLIC_INDEX=True# allow guests to see list of all snapshots# ordocker compose run archivebox config --set ...# restart the server to apply any config changes

archivebox add --depth=1'https://example.com'# add a URL with pip-installed archivebox on the hostdocker compose run archivebox add --depth=1'https://example.com'# or w/ Docker Composedocker run -it -v$PWD:/data archivebox/archivebox add --depth=1'https://example.com'# or w/ Docker, all equivalent

For more info, see ourDocker wiki. ➡️

data/archive/{Snapshot.id}/

• Index:index.html &index.json HTML and JSON index files containing metadata and details
• Title,Favicon,Headers Response headers, site favicon, and parsed site title
• SingleFile:singlefile.html HTML snapshot rendered with headless Chrome using SingleFile
• Wget Clone:example.com/page-name.html wget clone of the site withwarc/TIMESTAMP.gz
• Chrome Headless
  • 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
• Article Text:article.html/json Article text extraction using Readability & Mercury
• Archive.org Permalink:archive.org.txt A link to the saved site on archive.org
• Audio & Video:media/ all audio/video files + playlists, including subtitles & metadata w/yt-dlp
• Source Code:git/ clone of any repository found on GitHub, Bitbucket, or GitLab links
• More coming soon! See theRoadmap...

TIP: For better security while running ArchiveBox, and to avoid polluting your host system with a bunch of sub-dependencies that you need to keep up-to-date,it is strongly recommended to use the⭐️ official Docker image which provides everything in an easy container with simple one-liner upgrades.

• Language: Python>=3.10
• Backend:Django +Django-Ninja for REST API
• Frontend:Django Admin + Vanilla HTML, CSS, JS
• Web Server:Django +channels +daphne]
• Database:Django ORM saving toSQLite3./data/index.sqlite
• Job Queue:Huey using./data/queue.sqlite3 undersupervisord
• Build/test/lint:pdm /mypy+pyright+pytest /ruff
• Subdependencies:abx-pkg installs apt/brew/pip/npm pkgs at runtime (e.g.yt-dlp,singlefile,readability,git)

These optional subdependencies used for archiving sites include:

• chromium /chrome (for screenshots, PDF, DOM HTML, and headless JS scripts)
• node &npm (for readability, mercury, and singlefile)
• wget (for plain HTML, static files, and WARC saving)
• curl (for fetching headers, favicon, and posting to Archive.org)
• yt-dlp oryoutube-dl (for audio, video, and subtitles)
• git (for cloning git repos)
• singlefile (for saving into a self-contained html file)
• postlight/parser (for discussion threads, forums, and articles)
• readability (for articles and long text content)
• and more as we grow...

You don't need to install every dependency to use ArchiveBox. ArchiveBox will automatically disable extractors that rely on dependencies that aren't installed, based on what is configured and available in your$PATH.

If not using Docker, make sure to keep the dependencies up-to-date yourself and check that ArchiveBox isn't reporting any incompatibility with the versions you install.

#install python3 and archivebox with your system package manager# apt/brew/pip/etc install ... (see Quickstart instructions above)which -a archivebox# see where you have installed archiveboxarchivebox setup# auto install all the extractors and extrasarchivebox --version# see info and check validity of installed dependencies

Installing directly onWindows without Docker or WSL/WSL2/Cygwin is not officially supported (I cannot respond to Windows support tickets), but some advanced users have reported getting it working.

• Wiki: Install (Dependencies)
• Wiki: Chromium Install
• Wiki: Upgrading or Merging Archives
• Wiki: Troubleshooting (Installing)

Data folders can be created anywhere (~/archivebox/data or$PWD/data as seen in our examples), and you can create as many data folders as you want to hold different collections.Allarchivebox CLI commands are designed to be run from inside an ArchiveBox data folder, starting witharchivebox init to initialize a new collection inside an empty directory.

mkdir -p~/archivebox/data&&cd~/archivebox/data# just an example, can be anywherearchivebox init

The on-disk layout is optimized to be easy to browse by hand and durable long-term. The main index is a standardindex.sqlite3 database in the root of the data folder (it can also beexported as static JSON/HTML), and the archive snapshots are organized by date-added timestamp in thedata/archive/ subfolder.

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

Each snapshot subfolderdata/archive/TIMESTAMP/ includes a staticindex.json andindex.html describing its contents, and the snapshot extractor outputs are plain files within the folder.

• Wiki: Setting Up Storage (SMB, NFS, S3, B2, Google Drive, etc.)
• Wiki: Usage (Disk Layout)
• Wiki: Usage (Large Archives)
• Wiki: Security Overview (Output Folder)
• Wiki: Publishing Your Archive
• Wiki: Upgrading or Merging Archives

NOTE: These exports are not paginated, exporting many URLs or the entire archive at once may be slow. Use the filtering CLI flags on thearchivebox list command to export specific Snapshots or ranges.

# do a one-off single URL archive wihout needing a data dir initializedarchivebox oneshot'https://example.com'# archivebox list --helparchivebox list --html --with-headers> index.html# export to static html tablearchivebox list --json --with-headers> index.json# export to json blobarchivebox list --csv=timestamp,url,title> index.csv# export to csv spreadsheet# (if using Docker Compose, add the -T flag when piping)# docker compose run -T archivebox list --html 'https://example.com' > index.json

The paths in the static exports are relative, make sure to keep them next to your./archive folder when backing them up or viewing them.

• Wiki: Publishing Your Archive (Exporting as Static HTML)
• Wiki: Security Overview (Publishing)
• Wiki: Configuration (PUBLIC_INDEX,PUBLIC_SNAPSHOTS,PUBLIC_ADD_VIEW)

# don't save private content to ArchiveBox, e.g.:archivebox add'https://docs.google.com/document/d/12345somePrivateDocument'archivebox add'https://vimeo.com/somePrivateVideo'# without first disabling saving to Archive.org:archivebox config --set SAVE_ARCHIVE_DOT_ORG=False# disable saving all URLs in Archive.org# restrict the main index, Snapshot content, and Add Page to authenticated users as-needed:archivebox config --set PUBLIC_INDEX=Falsearchivebox config --set PUBLIC_SNAPSHOTS=Falsearchivebox config --set PUBLIC_ADD_VIEW=False archivebox manage createsuperuser# if extra paranoid or anti-Google:archivebox config --set SAVE_FAVICON=False# disable favicon fetching (it calls a Google API passing the URL's domain part only)archivebox config --set CHROME_BINARY=chromium# ensure it's using Chromium instead of Chrome

CAUTION: Assume anyoneviewing your archives will be able to see any cookies, session tokens, or private URLs passed to ArchiveBox during archiving.Make sure to secure your ArchiveBox data and don't share snapshots with others without stripping out sensitive headers and content first.

• Wiki: Publishing Your Archive
• Wiki: Security Overview
• Wiki: Chromium Install (Setting Up a User Profile)
• Wiki: Configuration (CHROME_USER_DATA_DIR)
• Wiki: Configuration (COOKIES_FILE)

# 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 from:https://127.0.0.1:8000/index.htmlhttps://127.0.0.1:8000/archive/*# then example.com/index.js can send it off to some evil server

NOTE: Only thewget &dom extractor methods execute archived JS when viewing snapshots, all other archive methods produce static output that does not execute JS on viewing.
If you are worried about these issues ^ you should disable these extractors using:
archivebox config --set SAVE_WGET=False SAVE_DOM=False.

• Wiki: Security Overview
• ArchiveBox Github Issue: #239
• Security Advisory:CVE-2023-45815
• Wiki: Security Overview (Publishing)

• SetCHROME_USER_AGENT,WGET_USER_AGENT,CURL_USER_AGENT to impersonate a real browser (by default, ArchiveBox reveals that it's a bot when using the default user agent settings)
• Set up a logged-in browser session for archiving usingCHROME_USER_DATA_DIR &COOKIES_FILE
• Rewrite your URLs before archiving to swap in alternative frontends that are more bot-friendly e.g.
  reddit.com/some/url ->teddit.net/some/url:https://github.com/mendel5/alternative-front-ends

In the future we plan on adding support for running JS scripts during archiving to block ads, cookie popups, modals, and fix other issues. Follow here for progress:Issue #51.

Because ArchiveBox uniquely identifies snapshots by URL, it must use a workaround to take multiple snapshots of the same URL (otherwise they would show up as a single Snapshot entry). It makes the URLs of repeated snapshots unique by adding a hash with the archive date at the end:

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

The button in the Admin UI is a shortcut for this hash-date multi-snapshotting workaround.

Improved support for saving multiple snapshots of a single URL without this hash-date workaround will beadded eventually (along with the ability to view diffs of the changes between runs).

• ArchiveBox Issues: #179
• Wiki: Usage (Explanation of Web UI Buttons)

• ArchiveBox can use anywhere from ~1gb per 1000 Snapshots, to ~50gb per 1000 Snapshots, mostly dependent on whether you're saving audio & video usingSAVE_MEDIA=True and whether you lowerMEDIA_MAX_SIZE=750mb.
• Disk usage can be reduced by using a compressed/deduplicated filesystem likeZFS/BTRFS, or by turning off extractors methods you don't need. You can also deduplicate content with a tool likefdupes orrdfind.
• Don't store large collections on older filesystems like EXT3/FAT as they may not be able to handle more than 50k directory entries in thedata/archive/ folder.
• Try to keep thedata/index.sqlite3 file on local drive (not a network mount) or SSD for maximum performance, however thedata/archive/ folder can be on a network mount or slower HDD.
• If using Docker or NFS/SMB/FUSE for thedata/archive/ folder, you may need to setPUID &PGID anddisableroot_squash on your fileshare server.

• Wiki: Usage (Disk Layout)
• Wiki: Security Overview (Output-Folder)
• Wiki: Usage (Large Archives)
• Wiki: Configuration (PUID &GUID)
• Wiki: Security Overview (Do Not Run as Root)

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 news articles before they get taken down or edited, or just to save a collection of early 2010's flash games you loved to play, having the tools to archive internet content enables to you save the stuff you care most about before it disappears.

^{Image fromPerma.cc...}

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, just like libraries do. Without the work of archivists saving physical books, manuscrips, and paintings we wouldn't have any knowledge of our ancestors' history. I believe archiving the web is just as important to provide the same benefit to future generations.

ArchiveBox's stance is that duplication of other people's content is only ethical if it:

• A. doesn't deprive the original creators of revenue and
• B. is responsibly curated by an individual/institution.

In the U.S.,libraries, researchers, and archivists are allowed to duplicate copyrighted materials under"fair use" forprivate study, scholarship, or research. Archive.org's non-profit preservation work iscovered under fair use in the US, and they properly handleunethical content/DMCA/GDPR removal requests to maintain good standing in the eyes of the law.

As long as you A. don't try to profit off pirating copyrighted content and B. have processes in place to respond to removal requests, many countries allow you to use sofware like ArchiveBox to ethically and responsibly archive any web content you can view. That being said, ArchiveBox is not liable for how you choose to operate the software. You must research your own local laws and regulations, and get proper legal council if you plan to host a public instance (start by putting your DMCA/GDPR contact info inFOOTER_INFO and changing your instance's branding usingCUSTOM_TEMPLATES_DIR).

ArchiveBox tries to be a robust, set-and-forget archiving solution suitable for archiving RSS feeds, bookmarks, or your entire browsing history (beware, it may be too big to store), including private/authenticated content that you wouldn't otherwise share with a centralized service like Archive.org.

Not all content is suitable to be archived on a centralized, publicly accessible platform. Archive.org doesn't offer the ability to save things behind login walls for good reason, as the content may not have been intended for a public audience. ArchiveBox exists to fill that gap by letting everyone save what they have access to on an individual basis, and to encourage decentralized archiving that's less succeptible to censorship or natural disasters.

By having users store their content locally or within their organizations, we can also save much larger portions of the internet than a centralized service has the disk capcity handle. The eventual goal is to work towards federated archiving where users can share portions of their collections with each other, and with central archives on a case-by-case basis.

ArchiveBox differentiates itself fromsimilar self-hosted projects by providing both a comprehensive CLI interface for managing your archive, a Web UI that can be used either independently or together with the CLI, and a simple on-disk data format that can be used without either.

If you want better fidelity for very complex interactive pages with heavy JS/streams/API requests, check outArchiveWeb.page andReplayWeb.page.

If you want more bookmark categorization and note-taking features, check outMemex,Hoarder,LinkWarden,Archivy, orLinkAce.

If you need more advanced recursive spider/crawling ability beyond--depth=1, check outBrowsertrix,Photon, orScrapy and pipe the outputted URLs into ArchiveBox.

For more alternatives, see ourlist here...

ArchiveBox is neither the highest fidelity nor the simplest tool available for self-hosted archiving, rather it's a jack-of-all-trades that tries to do most things well by default. We encourage you to try these other tools made by our friends if ArchiveBox isn't suited to your needs.

• Community Wiki
  • Web Archiving Software
    List of ArchiveBox alternatives and open source projects in the internet archiving space.
  • Awesome-Web-Archiving Lists
    Community-maintained indexes of archiving tools and institutions likeiipc/awesome-web-archiving.
  • 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 ArchiveBoxRoadmap andChangelog
• Learn why archiving the internet is important by reading the "On the Importance of Web Archiving" blog post.
• Reach out to me for questions and comments via@ArchiveBoxApp or@theSquashSH on Twitter

# set up persistent DEBUG=True for all runsarchivebox config --set DEBUG=True# OR you can run a dev server with DEBUG=True in a few ways:archivebox manage runserver --debug --reload 0.0.0.0:8000# orarchivebox server --debug 0.0.0.0:8000# orenv DEBUG=True daphne -b 0.0.0.0 -p 8000 archivebox.core.asgi:application

https://stackoverflow.com/questions/1074212/how-can-i-see-the-raw-sql-queries-django-is-running

If you're looking for the latestdev Docker image, it's often available pre-built on Docker Hub, simply pull and usearchivebox/archivebox:dev.

docker pull archivebox/archivebox:devdocker run archivebox/archivebox:dev version# verify the BUILD_TIME and COMMIT_HASH in the output are recent

You can also build and run any branch yourself from source, for example to build & usedev locally:

# docker-compose.yml:services:    archivebox:        image: archivebox/archivebox:dev        build:'https://github.com/ArchiveBox/ArchiveBox.git#dev'        ...# or with plain Docker:docker build -t archivebox:dev https://github.com/ArchiveBox/ArchiveBox.git#devdocker run -it -v$PWD:/data archivebox:dev init# or with pip:pip install'git+https://github.com/pirate/ArchiveBox@dev'npm install'git+https://github.com/ArchiveBox/ArchiveBox.git#dev'archivebox install

./bin/lint.sh./bin/test.sh

(usesflake8,mypy, andpytest -s)

# generate the database migrations after changes to models.pycd archivebox/./manage.py makemigrations# enter a python shell or a SQL shellcd path/to/test/data/archivebox shellarchivebox manage dbshell# generate a graph of the ORM modelsbrew install graphvizpip install pydot graphvizarchivebox manage graph_models -a -o orm.pngopen orm.png# list all models with field db info and methodsarchivebox manage list_model_info --all --signature --db-type --field-class# print all django settingsarchivebox manage print_settingsarchivebox manage print_settings --format=yaml# pip install pyyaml# autogenerate an admin.py from given app modelsarchivebox manage admin_generator core> core/admin.py# dump db data to a script that re-populates itarchivebox manage dumpscript core> scripts/testdata.pyarchivebox manage reset corearchivebox manage runscript testdata# resetdb and clear all data!archivebox manage reset_db# use django-tui to interactively explore commandspip install django-tui# ensure django-tui is in INSTALLED_APPS: core/settings.pyarchivebox manage tui# show python and JS package dependency treespdm list --treenpm ls --all

• https://django-extensions.readthedocs.io/en/latest/command_extensions.html
• https://stackoverflow.com/questions/1074212/how-can-i-see-the-raw-sql-queries-django-is-running
• https://github.com/anze3db/django-tui (exploremanage.py commands as TUI)
• https://github.com/bloomberg/memray (advanced python profiler)
• https://github.com/laixintao/flameshow (display flamegraphs in terminal)
• https://github.com/taliraj/django-migrations-tui (explore migrations as TUI)

ArchiveBoxextractors are external binaries or Python/Node scripts that ArchiveBox runs to archive content on a page.

Extractors take the URL of a page to archive, write their output to the filesystemdata/archive/TIMESTAMP/EXTRACTOR/..., and return anArchiveResult entry which is saved to the database (visible on theLog page in the UI).

Check out how we addedarchivebox/extractors/singlefile.py as an example of the process:Issue #399 +PR #403.

The process to contribute a new extractor is like this:

[!IMPORTANT]This process is getting much easier after v0.8.x, there is a new plugin system under development:https://github.com/ArchiveBox/ArchiveBox/releases/tag/v0.8.4-rc

1. Open an issue with your propsoed implementation (please link to the pages of any new external dependencies you plan on using)
2. Ensure any dependencies needed are easily installable via a package managers likeapt,brew,pip3,npm(Ideally, prefer to use external programs available viapip3 ornpm, however we do support using any binary installable via package manager that exposes a CLI/Python API and writes output to stdout or the filesystem.)
3. Create a new file inarchivebox/extractors/EXTRACTOR.py (copy an existing extractor likesinglefile.py as a template)
4. Add config settings to enable/disable any new dependencies and the extractor as a whole, e.g.USE_DEPENDENCYNAME,SAVE_EXTRACTORNAME,EXTRACTORNAME_SOMEOTHEROPTION inarchivebox/config.py
5. Add a preview section toarchivebox/templates/core/snapshot.html to view the output, and a column toarchivebox/templates/core/index_row.html with an icon for your extractor
6. Add an integration test for your extractor intests/test_extractors.py
7. Submit your PR for review! 🎉
8. Once merged, please document it in these places and anywhere else you see info about other extractors:

• https://github.com/ArchiveBox/ArchiveBox#output-formats
• https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration#archive-method-toggles
• https://github.com/ArchiveBox/ArchiveBox/wiki/Install#dependencies

(Normally CI takes care of this, but these scripts can be run to do it manually)

./bin/build.sh# or individually:./bin/build_docs.sh./bin/build_pip.sh./bin/build_docker.sh

(Normally CI takes care of this, but these scripts can be run to do it manually)

./bin/release.sh# or individually:./bin/release_docs.sh./bin/release_pip.sh./bin/release_docker.sh