pip
archivebox setup
OUTPUT_PERMISSIONS
PUID
PGID
ONLY_NEW
TIMEOUT
MEDIA_TIMEOUT
ADMIN_USERNAME
ADMIN_PASSWORD
PUBLIC_INDEX
PUBLIC_SNAPSHOTS
PUBLIC_ADD_VIEW
CUSTOM_TEMPLATES_DIR
REVERSE_PROXY_USER_HEADER
REVERSE_PROXY_WHITELIST
LOGOUT_REDIRECT_URL
LDAP
SNAPSHOTS_PER_PAGE
FOOTER_INFO
URL_DENYLIST
URL_ALLOWLIST
SAVE_TITLE
SAVE_FAVICON
SAVE_WGET
SAVE_WARC
SAVE_PDF
SAVE_SCREENSHOT
SAVE_DOM
SAVE_SINGLEFILE
SAVE_READABILITY
SAVE_MERCURY
SAVE_GIT
SAVE_MEDIA
SAVE_ARCHIVE_DOT_ORG
CHECK_SSL_VALIDITY
SAVE_WGET_REQUISITES
RESOLUTION
CURL_USER_AGENT
WGET_USER_AGENT
CHROME_USER_AGENT
GIT_DOMAINS
COOKIES_FILE
CHROME_USER_DATA_DIR
CHROME_HEADLESS
CHROME_SANDBOX
USE_COLOR
SHOW_PROGRESS
CHROME_BINARY
WGET_BINARY
YOUTUBEDL_BINARY
GIT_BINARY
CURL_BINARY
SINGLEFILE_BINARY
READABILITY_BINARY
MERCURY_BINARY
RIPGREP_BINARY
SINGLEFILE_ARGS
CURL_ARGS
WGET_ARGS
YOUTUBEDL_ARGS
GIT_ARGS
[Default, recommended for most people]
[Advanced users only]
EXT4
APFS
ZFS
NTFS
HFS+
BTRFS
EXT2
EXT3
FAT32
exFAT
NFS
SMB
Ceph
ripgrep
ripgrep-all
rga
ugrep
sonic
SQLite FTS5
archivebox
archivebox.misc
archivebox.machine
archivebox.crawls
archivebox.index
archivebox.extractors
archivebox.pkgs
archivebox.api
archivebox.workers
archivebox.parsers
archivebox.base_models
archivebox.personas
archivebox.core
archivebox.search
archivebox.config
archivebox.cli
archivebox.tags
archivebox.manage
archivebox.__main__
abx_plugin_favicon
abx_plugin_favicon.config
abx_plugin_favicon.favicon
abx_plugin_favicon.models
abx_plugin_favicon.actors
abx_plugin_favicon.extractors
abx_spec_django
abx_plugin_playwright
abx_plugin_playwright.config
abx_plugin_playwright.binproviders
abx_plugin_playwright.binaries
abx_plugin_readwise
abx_plugin_curl
abx_plugin_curl.config
abx_plugin_curl.binaries
abx_plugin_curl.headers
abx_spec_extractor
abx_plugin_title
abx_plugin_title.extractors
abx_plugin_title.extractor
abx_spec_config
abx_spec_config.toml_util
abx_spec_config.base_configset
abx_plugin_chrome
abx_plugin_chrome.config
abx_plugin_chrome.binaries
abx_plugin_chrome.screenshot
abx_plugin_chrome.dom
abx_plugin_chrome.extractors
abx_plugin_chrome.pdf
abx_plugin_git
abx_plugin_git.config
abx_plugin_git.binaries
abx_plugin_git.extractors
abx_plugin_git.git
abx_plugin_pip
abx_plugin_pip.config
abx_plugin_pip.binproviders
abx_plugin_pip.binaries
abx_plugin_archivedotorg
abx_plugin_archivedotorg.config
abx_plugin_archivedotorg.archive_org
abx_plugin_singlefile
abx_plugin_singlefile.config
abx_plugin_singlefile.singlefile
abx_plugin_singlefile.binaries
abx_plugin_singlefile.models
abx_plugin_singlefile.actors
abx_plugin_singlefile.extractors
abx_plugin_wget
abx_plugin_wget.config
abx_plugin_wget.binaries
abx_plugin_wget.wget
abx_plugin_wget.wget_util
abx_plugin_wget.extractors
abx_plugin_puppeteer
abx_plugin_puppeteer.config
abx_plugin_puppeteer.binproviders
abx_plugin_puppeteer.binaries
abx_plugin_sqlitefts_search
abx_plugin_sqlitefts_search.searchbackend
abx_plugin_sqlitefts_search.config
abx_plugin_pocket
abx_plugin_pocket.config
abx_plugin_ytdlp
abx_plugin_ytdlp.config
abx_plugin_ytdlp.media
abx_plugin_ytdlp.binaries
abx_plugin_ripgrep_search
abx_plugin_ripgrep_search.searchbackend
abx_plugin_ripgrep_search.config
abx_plugin_ripgrep_search.binaries
abx_plugin_npm
abx_plugin_npm.config
abx_plugin_npm.binproviders
abx_plugin_npm.binaries
abx_spec_archivebox
abx_spec_archivebox.states
abx_spec_archivebox.events
abx_spec_archivebox.effects
abx_spec_archivebox.writes
abx_plugin_mercury
abx_plugin_mercury.config
abx_plugin_mercury.binaries
abx_plugin_mercury.mercury
abx_plugin_mercury.extractors
abx_plugin_ldap_auth
abx_plugin_ldap_auth.config
abx_plugin_ldap_auth.binaries
abx_plugin_sonic_search
abx_plugin_sonic_search.searchbackend
abx_plugin_sonic_search.config
abx_plugin_sonic_search.binaries
abx_plugin_default_binproviders
abx_plugin_readability
abx_plugin_readability.config
abx_plugin_readability.binaries
abx_plugin_readability.readability
abx_plugin_readability.extractors
abx_plugin_htmltotext
abx_plugin_htmltotext.config
abx_plugin_htmltotext.htmltotext
abx_spec_searchbackend
abx_spec_abx_pkg
abx
v0.7: Schema improvements
v0.8: Security
v0.9: Performance
v1.0: Full headless browser control
v2.0 Federated or distributed archiving + paid hosted service offering
archivebox.core.admin
register_admin