archivebox.config package

Submodules

Module contents

ArchiveBox config definitons (including defaults and dynamic config options).

Config Usage Example:

archivebox config –set MEDIA_TIMEOUT=600 env MEDIA_TIMEOUT=600 USE_COLOR=False … archivebox [subcommand] …

Config Precedence Order:

cli args (–update-all / –index-only / etc.)

shell environment vars (env USE_COLOR=False archivebox add ‘…’)

config file (echo “SAVE_FAVICON=False” >> ArchiveBox.conf)

defaults (defined below in Python)

Documentation:

https://github.com/ArchiveBox/ArchiveBox/wiki/Configuration

archivebox.config.get_real_name(key: str) → str[source]: get the current canonical name for a given deprecated config key

archivebox.config.get_system_user() → str[source]

archivebox.config.get_version(config)[source]

archivebox.config.get_commit_hash(config) → str | None[source]

archivebox.config.get_build_time(config) → str[source]

archivebox.config.get_versions_available_on_github(config)[source]: returns a dictionary containing the ArchiveBox GitHub release info for the recommended upgrade version and the currently installed version

archivebox.config.can_upgrade(config)[source]

archivebox.config.load_config_val(key: str, default: str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[ConfigDict], str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]]] = None, type: Type | None = None, aliases: Tuple[str, ...] | None = None, config: ConfigDict | None = None, env_vars: _Environ | None = None, config_file_vars: Dict[str, str] | None = None) → str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]][source]: parse bool, int, and str key=value pairs from env

archivebox.config.load_config_file(out_dir: str = None) → Dict[str, str] | None[source]: load the ini-formatted config file from OUTPUT_DIR/Archivebox.conf

archivebox.config.write_config_file(config: Dict[str, str], out_dir: str = None) → ConfigDict[source]: load the ini-formatted config file from OUTPUT_DIR/Archivebox.conf

archivebox.config.load_config(defaults: Dict[str, ConfigDefault], config: ConfigDict | None = None, out_dir: str | None = None, env_vars: _Environ | None = None, config_file_vars: Dict[str, str] | None = None) → ConfigDict[source]

archivebox.config.parse_version_string(version: str) → Tuple[int, int, int][source]: parses a version tag string formatted like ‘vx.x.x’ into (major, minor, patch) ints

archivebox.config.stdout(*args, color: str | None = None, prefix: str = '', config: ConfigDict | None = None) → None[source]

archivebox.config.stderr(*args, color: str | None = None, prefix: str = '', config: ConfigDict | None = None) → None[source]

archivebox.config.hint(text: Tuple[str, ...] | List[str] | str, prefix=' ', config: ConfigDict | None = None) → None[source]

archivebox.config.bin_version(binary: str | None) → str | None[source]: check the presence and return valid version line of a specified binary

archivebox.config.bin_path(binary: str | None) → str | None[source]

archivebox.config.bin_hash(binary: str | None) → str | None[source]

archivebox.config.find_chrome_binary() → str | None[source]: find any installed chrome binaries in the default locations

archivebox.config.find_chrome_data_dir() → str | None[source]: find any installed chrome user data directories in the default locations

archivebox.config.wget_supports_compression(config)[source]

archivebox.config.get_code_locations(config: ConfigDict) → Dict[str, str | bool | int | None | Pattern | Dict[str, Any]][source]

archivebox.config.get_external_locations(config: ConfigDict) → str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]][source]

archivebox.config.get_data_locations(config: ConfigDict) → str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]][source]

archivebox.config.get_dependency_info(config: ConfigDict) → str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]][source]

archivebox.config.get_chrome_info(config: ConfigDict) → str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]][source]

archivebox.config.load_all_config()[source]

archivebox.config.check_system_config(config: ~archivebox.config_stubs.ConfigDict = {'ADMIN_PASSWORD': None, 'ADMIN_USERNAME': None, 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'BUILD_TIME': '2024-02-19 03:15:46 1708312546', 'CAN_UPGRADE': False, 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'CUSTOM_TEMPLATES_DIR': {'enabled': False, 'is_valid': None, 'path': None}, 'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates')}}, 'COMMIT_HASH': '841c01ec2c60e066f8d69528864a36ba80cd4a23', 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.81.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.81.0 (x86_64-pc-linux-gnu)', 'CUSTOM_TEMPLATES_DIR': None, 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources')}, 'SQL_INDEX': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:18bc286a2f948a74a8d0bb67650f7714', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'version': 'dev'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:714f2f5fa87eea8d1c7c96f22434a6f5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.81.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:a2f77691aaca42acce83c4af07a844c3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'version': '3.1.14 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:df8565e7b5e4b83a438cb12b52c20c74', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.34.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'postlight-parser', 'version': None}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:ac082a412acb9cf073ea54be7ded6cdc', 'is_valid': True, 'path': '/home/docs/.asdf/shims/node', 'version': 'v20.11.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:517ef976972c6ff05560c343b226dff8', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/bin/python3.12', 'version': '3.12.0'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'RIPGREP_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'rg', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'SQLITE_BINARY': {'enabled': True, 'hash': 'md5:0fe95ee6b2ca98b5b50963b81c6b3788', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'version': '2.6.0'}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:d4dbfd931aeb9931ba381178ad636e4f', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.21.2'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:a9dfe8014a1db56c50e370be4ce0ed69', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/yt-dlp', 'version': '2023.12.30'}}, 'DIR_OUTPUT_PERMISSIONS': '755', 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'DJANGO_VERSION': '3.1.14 final (0)', 'ENFORCE_ATOMIC_WRITES': True, 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FAVICON_PROVIDER': 'https://www.google.com/s2/favicons?domain={}', 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'FTS_SEPARATE_DATABASE': True, 'FTS_SQLITE_MAX_LENGTH': 1000000000, 'FTS_TOKENIZERS': 'porter unicode61 remove_diacritics 2', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com,gist.github.com,codeberg.org,gitea.com,git.sr.ht', 'GIT_VERSION': 'git version 2.34.1', 'IN_DOCKER': False, 'IN_QEMU': False, 'IS_TTY': False, 'LDAP': False, 'LDAP_BIND_DN': None, 'LDAP_BIND_PASSWORD': None, 'LDAP_CREATE_SUPERUSER': False, 'LDAP_EMAIL_ATTR': None, 'LDAP_FIRSTNAME_ATTR': None, 'LDAP_LASTNAME_ATTR': None, 'LDAP_SERVER_URI': None, 'LDAP_USERNAME_ATTR': None, 'LDAP_USER_BASE': None, 'LDAP_USER_FILTER': None, 'LOGOUT_REDIRECT_URL': '/', 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs'), 'MEDIA_MAX_SIZE': '750m', 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'postlight-parser', 'MERCURY_VERSION': None, 'NODE_BINARY': 'node', 'NODE_VERSION': 'v20.11.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest'), 'OUTPUT_PERMISSIONS': '644', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PGID': 205, 'POCKET_ACCESS_TOKENS': {}, 'POCKET_CONSUMER_KEY': None, 'PREVIEW_ORIGINALS': True, 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PUID': 1005, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.12.0', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'READWISE_READER_TOKENS': {}, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'REVERSE_PROXY_USER_HEADER': 'Remote-User', 'REVERSE_PROXY_WHITELIST': '', 'RIPGREP_BINARY': 'rg', 'RIPGREP_VERSION': None, 'SAVE_ALLOWLIST': {}, 'SAVE_ALLOWLIST_PTN': {}, 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DENYLIST': {}, 'SAVE_DENYLIST_PTN': {}, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_HTMLTOTEXT': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SEARCH_BACKEND_ENGINE': 'ripgrep', 'SEARCH_BACKEND_HOST_NAME': 'localhost', 'SEARCH_BACKEND_PASSWORD': 'SecretPassword', 'SEARCH_BACKEND_PORT': 1491, 'SEARCH_BACKEND_TIMEOUT': 90, 'SEARCH_PROCESS_HTML': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_ARGS': [], 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SNAPSHOTS_PER_PAGE': 40, 'SONIC_BUCKET': 'snapshots', 'SONIC_COLLECTION': 'archivebox', 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources'), 'SQLITE_BINARY': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'SQLITE_VERSION': '2.6.0', 'TAG_SEPARATOR_PATTERN': '[,]', 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'TIMEZONE': 'UTC', 'TIME_ZONE': 'UTC', 'URL_ALLOWLIST': None, 'URL_ALLOWLIST_PTN': None, 'URL_DENYLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_DENYLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_INDEXING_BACKEND': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_RIPGREP': True, 'USE_SEARCHING_BACKEND': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': 'dev', 'VERSIONS_AVAILABLE': None, 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': True, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.21.2', 'WGET_VERSION': 'GNU Wget 1.21.2', 'YOUTUBEDL_ARGS': ['--restrict-filenames', '--trim-filenames', '128', '--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--write-sub', '--write-auto-subs', '--convert-subs=srt', '--yes-playlist', '--continue', '--no-abort-on-error', '--ignore-errors', '--geo-bypass', '--add-metadata', '--format=(bv*+ba/b)[filesize<=750m][filesize_approx<=?750m]/(bv*+ba/b)'], 'YOUTUBEDL_BINARY': 'yt-dlp', 'YOUTUBEDL_VERSION': '2023.12.30'}) → None[source]

archivebox.config.check_dependencies(config: ~archivebox.config_stubs.ConfigDict = {'ADMIN_PASSWORD': None, 'ADMIN_USERNAME': None, 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'BUILD_TIME': '2024-02-19 03:15:46 1708312546', 'CAN_UPGRADE': False, 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'CUSTOM_TEMPLATES_DIR': {'enabled': False, 'is_valid': None, 'path': None}, 'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates')}}, 'COMMIT_HASH': '841c01ec2c60e066f8d69528864a36ba80cd4a23', 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.81.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.81.0 (x86_64-pc-linux-gnu)', 'CUSTOM_TEMPLATES_DIR': None, 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources')}, 'SQL_INDEX': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:18bc286a2f948a74a8d0bb67650f7714', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'version': 'dev'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:714f2f5fa87eea8d1c7c96f22434a6f5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.81.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:a2f77691aaca42acce83c4af07a844c3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'version': '3.1.14 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:df8565e7b5e4b83a438cb12b52c20c74', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.34.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'postlight-parser', 'version': None}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:ac082a412acb9cf073ea54be7ded6cdc', 'is_valid': True, 'path': '/home/docs/.asdf/shims/node', 'version': 'v20.11.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:517ef976972c6ff05560c343b226dff8', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/bin/python3.12', 'version': '3.12.0'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'RIPGREP_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'rg', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'SQLITE_BINARY': {'enabled': True, 'hash': 'md5:0fe95ee6b2ca98b5b50963b81c6b3788', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'version': '2.6.0'}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:d4dbfd931aeb9931ba381178ad636e4f', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.21.2'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:a9dfe8014a1db56c50e370be4ce0ed69', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/yt-dlp', 'version': '2023.12.30'}}, 'DIR_OUTPUT_PERMISSIONS': '755', 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'DJANGO_VERSION': '3.1.14 final (0)', 'ENFORCE_ATOMIC_WRITES': True, 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FAVICON_PROVIDER': 'https://www.google.com/s2/favicons?domain={}', 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'FTS_SEPARATE_DATABASE': True, 'FTS_SQLITE_MAX_LENGTH': 1000000000, 'FTS_TOKENIZERS': 'porter unicode61 remove_diacritics 2', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com,gist.github.com,codeberg.org,gitea.com,git.sr.ht', 'GIT_VERSION': 'git version 2.34.1', 'IN_DOCKER': False, 'IN_QEMU': False, 'IS_TTY': False, 'LDAP': False, 'LDAP_BIND_DN': None, 'LDAP_BIND_PASSWORD': None, 'LDAP_CREATE_SUPERUSER': False, 'LDAP_EMAIL_ATTR': None, 'LDAP_FIRSTNAME_ATTR': None, 'LDAP_LASTNAME_ATTR': None, 'LDAP_SERVER_URI': None, 'LDAP_USERNAME_ATTR': None, 'LDAP_USER_BASE': None, 'LDAP_USER_FILTER': None, 'LOGOUT_REDIRECT_URL': '/', 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs'), 'MEDIA_MAX_SIZE': '750m', 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'postlight-parser', 'MERCURY_VERSION': None, 'NODE_BINARY': 'node', 'NODE_VERSION': 'v20.11.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest'), 'OUTPUT_PERMISSIONS': '644', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PGID': 205, 'POCKET_ACCESS_TOKENS': {}, 'POCKET_CONSUMER_KEY': None, 'PREVIEW_ORIGINALS': True, 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PUID': 1005, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.12.0', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'READWISE_READER_TOKENS': {}, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'REVERSE_PROXY_USER_HEADER': 'Remote-User', 'REVERSE_PROXY_WHITELIST': '', 'RIPGREP_BINARY': 'rg', 'RIPGREP_VERSION': None, 'SAVE_ALLOWLIST': {}, 'SAVE_ALLOWLIST_PTN': {}, 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DENYLIST': {}, 'SAVE_DENYLIST_PTN': {}, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_HTMLTOTEXT': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SEARCH_BACKEND_ENGINE': 'ripgrep', 'SEARCH_BACKEND_HOST_NAME': 'localhost', 'SEARCH_BACKEND_PASSWORD': 'SecretPassword', 'SEARCH_BACKEND_PORT': 1491, 'SEARCH_BACKEND_TIMEOUT': 90, 'SEARCH_PROCESS_HTML': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_ARGS': [], 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SNAPSHOTS_PER_PAGE': 40, 'SONIC_BUCKET': 'snapshots', 'SONIC_COLLECTION': 'archivebox', 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources'), 'SQLITE_BINARY': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'SQLITE_VERSION': '2.6.0', 'TAG_SEPARATOR_PATTERN': '[,]', 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'TIMEZONE': 'UTC', 'TIME_ZONE': 'UTC', 'URL_ALLOWLIST': None, 'URL_ALLOWLIST_PTN': None, 'URL_DENYLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_DENYLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_INDEXING_BACKEND': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_RIPGREP': True, 'USE_SEARCHING_BACKEND': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': 'dev', 'VERSIONS_AVAILABLE': None, 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': True, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.21.2', 'WGET_VERSION': 'GNU Wget 1.21.2', 'YOUTUBEDL_ARGS': ['--restrict-filenames', '--trim-filenames', '128', '--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--write-sub', '--write-auto-subs', '--convert-subs=srt', '--yes-playlist', '--continue', '--no-abort-on-error', '--ignore-errors', '--geo-bypass', '--add-metadata', '--format=(bv*+ba/b)[filesize<=750m][filesize_approx<=?750m]/(bv*+ba/b)'], 'YOUTUBEDL_BINARY': 'yt-dlp', 'YOUTUBEDL_VERSION': '2023.12.30'}, show_help: bool = True) → None[source]

archivebox.config.check_data_folder(out_dir: str | ~pathlib.Path | None = None, config: ~archivebox.config_stubs.ConfigDict = {'ADMIN_PASSWORD': None, 'ADMIN_USERNAME': None, 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'BUILD_TIME': '2024-02-19 03:15:46 1708312546', 'CAN_UPGRADE': False, 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'CUSTOM_TEMPLATES_DIR': {'enabled': False, 'is_valid': None, 'path': None}, 'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates')}}, 'COMMIT_HASH': '841c01ec2c60e066f8d69528864a36ba80cd4a23', 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.81.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.81.0 (x86_64-pc-linux-gnu)', 'CUSTOM_TEMPLATES_DIR': None, 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources')}, 'SQL_INDEX': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:18bc286a2f948a74a8d0bb67650f7714', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'version': 'dev'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:714f2f5fa87eea8d1c7c96f22434a6f5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.81.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:a2f77691aaca42acce83c4af07a844c3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'version': '3.1.14 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:df8565e7b5e4b83a438cb12b52c20c74', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.34.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'postlight-parser', 'version': None}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:ac082a412acb9cf073ea54be7ded6cdc', 'is_valid': True, 'path': '/home/docs/.asdf/shims/node', 'version': 'v20.11.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:517ef976972c6ff05560c343b226dff8', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/bin/python3.12', 'version': '3.12.0'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'RIPGREP_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'rg', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'SQLITE_BINARY': {'enabled': True, 'hash': 'md5:0fe95ee6b2ca98b5b50963b81c6b3788', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'version': '2.6.0'}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:d4dbfd931aeb9931ba381178ad636e4f', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.21.2'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:a9dfe8014a1db56c50e370be4ce0ed69', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/yt-dlp', 'version': '2023.12.30'}}, 'DIR_OUTPUT_PERMISSIONS': '755', 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'DJANGO_VERSION': '3.1.14 final (0)', 'ENFORCE_ATOMIC_WRITES': True, 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FAVICON_PROVIDER': 'https://www.google.com/s2/favicons?domain={}', 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'FTS_SEPARATE_DATABASE': True, 'FTS_SQLITE_MAX_LENGTH': 1000000000, 'FTS_TOKENIZERS': 'porter unicode61 remove_diacritics 2', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com,gist.github.com,codeberg.org,gitea.com,git.sr.ht', 'GIT_VERSION': 'git version 2.34.1', 'IN_DOCKER': False, 'IN_QEMU': False, 'IS_TTY': False, 'LDAP': False, 'LDAP_BIND_DN': None, 'LDAP_BIND_PASSWORD': None, 'LDAP_CREATE_SUPERUSER': False, 'LDAP_EMAIL_ATTR': None, 'LDAP_FIRSTNAME_ATTR': None, 'LDAP_LASTNAME_ATTR': None, 'LDAP_SERVER_URI': None, 'LDAP_USERNAME_ATTR': None, 'LDAP_USER_BASE': None, 'LDAP_USER_FILTER': None, 'LOGOUT_REDIRECT_URL': '/', 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs'), 'MEDIA_MAX_SIZE': '750m', 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'postlight-parser', 'MERCURY_VERSION': None, 'NODE_BINARY': 'node', 'NODE_VERSION': 'v20.11.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest'), 'OUTPUT_PERMISSIONS': '644', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PGID': 205, 'POCKET_ACCESS_TOKENS': {}, 'POCKET_CONSUMER_KEY': None, 'PREVIEW_ORIGINALS': True, 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PUID': 1005, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.12.0', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'READWISE_READER_TOKENS': {}, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'REVERSE_PROXY_USER_HEADER': 'Remote-User', 'REVERSE_PROXY_WHITELIST': '', 'RIPGREP_BINARY': 'rg', 'RIPGREP_VERSION': None, 'SAVE_ALLOWLIST': {}, 'SAVE_ALLOWLIST_PTN': {}, 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DENYLIST': {}, 'SAVE_DENYLIST_PTN': {}, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_HTMLTOTEXT': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SEARCH_BACKEND_ENGINE': 'ripgrep', 'SEARCH_BACKEND_HOST_NAME': 'localhost', 'SEARCH_BACKEND_PASSWORD': 'SecretPassword', 'SEARCH_BACKEND_PORT': 1491, 'SEARCH_BACKEND_TIMEOUT': 90, 'SEARCH_PROCESS_HTML': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_ARGS': [], 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SNAPSHOTS_PER_PAGE': 40, 'SONIC_BUCKET': 'snapshots', 'SONIC_COLLECTION': 'archivebox', 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources'), 'SQLITE_BINARY': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'SQLITE_VERSION': '2.6.0', 'TAG_SEPARATOR_PATTERN': '[,]', 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'TIMEZONE': 'UTC', 'TIME_ZONE': 'UTC', 'URL_ALLOWLIST': None, 'URL_ALLOWLIST_PTN': None, 'URL_DENYLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_DENYLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_INDEXING_BACKEND': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_RIPGREP': True, 'USE_SEARCHING_BACKEND': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': 'dev', 'VERSIONS_AVAILABLE': None, 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': True, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.21.2', 'WGET_VERSION': 'GNU Wget 1.21.2', 'YOUTUBEDL_ARGS': ['--restrict-filenames', '--trim-filenames', '128', '--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--write-sub', '--write-auto-subs', '--convert-subs=srt', '--yes-playlist', '--continue', '--no-abort-on-error', '--ignore-errors', '--geo-bypass', '--add-metadata', '--format=(bv*+ba/b)[filesize<=750m][filesize_approx<=?750m]/(bv*+ba/b)'], 'YOUTUBEDL_BINARY': 'yt-dlp', 'YOUTUBEDL_VERSION': '2023.12.30'}) → None[source]

archivebox.config.check_migrations(out_dir: str | ~pathlib.Path | None = None, config: ~archivebox.config_stubs.ConfigDict = {'ADMIN_PASSWORD': None, 'ADMIN_USERNAME': None, 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'BUILD_TIME': '2024-02-19 03:15:46 1708312546', 'CAN_UPGRADE': False, 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'CUSTOM_TEMPLATES_DIR': {'enabled': False, 'is_valid': None, 'path': None}, 'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates')}}, 'COMMIT_HASH': '841c01ec2c60e066f8d69528864a36ba80cd4a23', 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.81.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.81.0 (x86_64-pc-linux-gnu)', 'CUSTOM_TEMPLATES_DIR': None, 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources')}, 'SQL_INDEX': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:18bc286a2f948a74a8d0bb67650f7714', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'version': 'dev'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:714f2f5fa87eea8d1c7c96f22434a6f5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.81.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:a2f77691aaca42acce83c4af07a844c3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'version': '3.1.14 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:df8565e7b5e4b83a438cb12b52c20c74', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.34.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'postlight-parser', 'version': None}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:ac082a412acb9cf073ea54be7ded6cdc', 'is_valid': True, 'path': '/home/docs/.asdf/shims/node', 'version': 'v20.11.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:517ef976972c6ff05560c343b226dff8', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/bin/python3.12', 'version': '3.12.0'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'RIPGREP_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'rg', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'SQLITE_BINARY': {'enabled': True, 'hash': 'md5:0fe95ee6b2ca98b5b50963b81c6b3788', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'version': '2.6.0'}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:d4dbfd931aeb9931ba381178ad636e4f', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.21.2'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:a9dfe8014a1db56c50e370be4ce0ed69', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/yt-dlp', 'version': '2023.12.30'}}, 'DIR_OUTPUT_PERMISSIONS': '755', 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'DJANGO_VERSION': '3.1.14 final (0)', 'ENFORCE_ATOMIC_WRITES': True, 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FAVICON_PROVIDER': 'https://www.google.com/s2/favicons?domain={}', 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'FTS_SEPARATE_DATABASE': True, 'FTS_SQLITE_MAX_LENGTH': 1000000000, 'FTS_TOKENIZERS': 'porter unicode61 remove_diacritics 2', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com,gist.github.com,codeberg.org,gitea.com,git.sr.ht', 'GIT_VERSION': 'git version 2.34.1', 'IN_DOCKER': False, 'IN_QEMU': False, 'IS_TTY': False, 'LDAP': False, 'LDAP_BIND_DN': None, 'LDAP_BIND_PASSWORD': None, 'LDAP_CREATE_SUPERUSER': False, 'LDAP_EMAIL_ATTR': None, 'LDAP_FIRSTNAME_ATTR': None, 'LDAP_LASTNAME_ATTR': None, 'LDAP_SERVER_URI': None, 'LDAP_USERNAME_ATTR': None, 'LDAP_USER_BASE': None, 'LDAP_USER_FILTER': None, 'LOGOUT_REDIRECT_URL': '/', 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs'), 'MEDIA_MAX_SIZE': '750m', 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'postlight-parser', 'MERCURY_VERSION': None, 'NODE_BINARY': 'node', 'NODE_VERSION': 'v20.11.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest'), 'OUTPUT_PERMISSIONS': '644', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PGID': 205, 'POCKET_ACCESS_TOKENS': {}, 'POCKET_CONSUMER_KEY': None, 'PREVIEW_ORIGINALS': True, 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PUID': 1005, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.12.0', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'READWISE_READER_TOKENS': {}, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'REVERSE_PROXY_USER_HEADER': 'Remote-User', 'REVERSE_PROXY_WHITELIST': '', 'RIPGREP_BINARY': 'rg', 'RIPGREP_VERSION': None, 'SAVE_ALLOWLIST': {}, 'SAVE_ALLOWLIST_PTN': {}, 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DENYLIST': {}, 'SAVE_DENYLIST_PTN': {}, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_HTMLTOTEXT': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SEARCH_BACKEND_ENGINE': 'ripgrep', 'SEARCH_BACKEND_HOST_NAME': 'localhost', 'SEARCH_BACKEND_PASSWORD': 'SecretPassword', 'SEARCH_BACKEND_PORT': 1491, 'SEARCH_BACKEND_TIMEOUT': 90, 'SEARCH_PROCESS_HTML': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_ARGS': [], 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SNAPSHOTS_PER_PAGE': 40, 'SONIC_BUCKET': 'snapshots', 'SONIC_COLLECTION': 'archivebox', 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources'), 'SQLITE_BINARY': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'SQLITE_VERSION': '2.6.0', 'TAG_SEPARATOR_PATTERN': '[,]', 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'TIMEZONE': 'UTC', 'TIME_ZONE': 'UTC', 'URL_ALLOWLIST': None, 'URL_ALLOWLIST_PTN': None, 'URL_DENYLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_DENYLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_INDEXING_BACKEND': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_RIPGREP': True, 'USE_SEARCHING_BACKEND': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': 'dev', 'VERSIONS_AVAILABLE': None, 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': True, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.21.2', 'WGET_VERSION': 'GNU Wget 1.21.2', 'YOUTUBEDL_ARGS': ['--restrict-filenames', '--trim-filenames', '128', '--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--write-sub', '--write-auto-subs', '--convert-subs=srt', '--yes-playlist', '--continue', '--no-abort-on-error', '--ignore-errors', '--geo-bypass', '--add-metadata', '--format=(bv*+ba/b)[filesize<=750m][filesize_approx<=?750m]/(bv*+ba/b)'], 'YOUTUBEDL_BINARY': 'yt-dlp', 'YOUTUBEDL_VERSION': '2023.12.30'})[source]

archivebox.config.setup_django(out_dir: ~pathlib.Path = None, check_db=False, config: ~archivebox.config_stubs.ConfigDict = {'ADMIN_PASSWORD': None, 'ADMIN_USERNAME': None, 'ALLOWED_HOSTS': '*', 'ANSI': {'black': '', 'blue': '', 'green': '', 'lightblue': '', 'lightred': '', 'lightyellow': '', 'red': '', 'reset': '', 'white': ''}, 'ARCHIVEBOX_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'ARCHIVE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive'), 'BIND_ADDR': '127.0.0.1:8000', 'BUILD_TIME': '2024-02-19 03:15:46 1708312546', 'CAN_UPGRADE': False, 'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_OPTIONS': {'CHECK_SSL_VALIDITY': True, 'CHROME_BINARY': None, 'CHROME_HEADLESS': True, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'RESOLUTION': '1440,2000', 'TIMEOUT': 60}, 'CHROME_SANDBOX': True, 'CHROME_TIMEOUT': 0, 'CHROME_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/)', 'CHROME_USER_DATA_DIR': None, 'CHROME_VERSION': None, 'CODE_LOCATIONS': {'CUSTOM_TEMPLATES_DIR': {'enabled': False, 'is_valid': None, 'path': None}, 'PACKAGE_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox')}, 'TEMPLATES_DIR': {'enabled': True, 'is_valid': True, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates')}}, 'COMMIT_HASH': '841c01ec2c60e066f8d69528864a36ba80cd4a23', 'CONFIG_FILE': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf'), 'COOKIES_FILE': None, 'CURL_ARGS': ['--silent', '--location', '--compressed'], 'CURL_BINARY': 'curl', 'CURL_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) curl/curl 7.81.0 (x86_64-pc-linux-gnu)', 'CURL_VERSION': 'curl 7.81.0 (x86_64-pc-linux-gnu)', 'CUSTOM_TEMPLATES_DIR': None, 'DATA_LOCATIONS': {'ARCHIVE_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archive')}, 'CONFIG_FILE': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/ArchiveBox.conf')}, 'LOGS_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs')}, 'OUTPUT_DIR': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest')}, 'SOURCES_DIR': {'enabled': True, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources')}, 'SQL_INDEX': {'enabled': True, 'is_mount': False, 'is_valid': False, 'path': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/index.sqlite3')}}, 'DEBUG': False, 'DEPENDENCIES': {'ARCHIVEBOX_BINARY': {'enabled': True, 'hash': 'md5:18bc286a2f948a74a8d0bb67650f7714', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/sphinx/__main__.py', 'version': 'dev'}, 'CHROME_BINARY': {'enabled': False, 'hash': None, 'is_valid': False, 'path': None, 'version': None}, 'CURL_BINARY': {'enabled': True, 'hash': 'md5:714f2f5fa87eea8d1c7c96f22434a6f5', 'is_valid': True, 'path': '/usr/bin/curl', 'version': 'curl 7.81.0 (x86_64-pc-linux-gnu)'}, 'DJANGO_BINARY': {'enabled': True, 'hash': 'md5:a2f77691aaca42acce83c4af07a844c3', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'version': '3.1.14 final (0)'}, 'GIT_BINARY': {'enabled': True, 'hash': 'md5:df8565e7b5e4b83a438cb12b52c20c74', 'is_valid': True, 'path': '/usr/bin/git', 'version': 'git version 2.34.1'}, 'MERCURY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'postlight-parser', 'version': None}, 'NODE_BINARY': {'enabled': True, 'hash': 'md5:ac082a412acb9cf073ea54be7ded6cdc', 'is_valid': True, 'path': '/home/docs/.asdf/shims/node', 'version': 'v20.11.0'}, 'PYTHON_BINARY': {'enabled': True, 'hash': 'md5:517ef976972c6ff05560c343b226dff8', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/bin/python3.12', 'version': '3.12.0'}, 'READABILITY_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'readability-extractor', 'version': None}, 'RIPGREP_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'rg', 'version': None}, 'SINGLEFILE_BINARY': {'enabled': True, 'hash': None, 'is_valid': False, 'path': 'single-file', 'version': None}, 'SQLITE_BINARY': {'enabled': True, 'hash': 'md5:0fe95ee6b2ca98b5b50963b81c6b3788', 'is_valid': True, 'path': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'version': '2.6.0'}, 'WGET_BINARY': {'enabled': True, 'hash': 'md5:d4dbfd931aeb9931ba381178ad636e4f', 'is_valid': True, 'path': '/usr/bin/wget', 'version': 'GNU Wget 1.21.2'}, 'YOUTUBEDL_BINARY': {'enabled': True, 'hash': 'md5:a9dfe8014a1db56c50e370be4ce0ed69', 'is_valid': True, 'path': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/yt-dlp', 'version': '2023.12.30'}}, 'DIR_OUTPUT_PERMISSIONS': '755', 'DJANGO_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/lib/python3.12/site-packages/django/__init__.py', 'DJANGO_VERSION': '3.1.14 final (0)', 'ENFORCE_ATOMIC_WRITES': True, 'EXTERNAL_LOCATIONS': {'CHROME_USER_DATA_DIR': {'enabled': False, 'is_valid': False, 'path': None}, 'COOKIES_FILE': {'enabled': None, 'is_valid': False, 'path': None}}, 'FAVICON_PROVIDER': 'https://www.google.com/s2/favicons?domain={}', 'FOOTER_INFO': 'Content is hosted for personal archiving purposes only. Contact server owner for any takedown requests.', 'FTS_SEPARATE_DATABASE': True, 'FTS_SQLITE_MAX_LENGTH': 1000000000, 'FTS_TOKENIZERS': 'porter unicode61 remove_diacritics 2', 'GIT_ARGS': ['--recursive'], 'GIT_BINARY': 'git', 'GIT_DOMAINS': 'github.com,bitbucket.org,gitlab.com,gist.github.com,codeberg.org,gitea.com,git.sr.ht', 'GIT_VERSION': 'git version 2.34.1', 'IN_DOCKER': False, 'IN_QEMU': False, 'IS_TTY': False, 'LDAP': False, 'LDAP_BIND_DN': None, 'LDAP_BIND_PASSWORD': None, 'LDAP_CREATE_SUPERUSER': False, 'LDAP_EMAIL_ATTR': None, 'LDAP_FIRSTNAME_ATTR': None, 'LDAP_LASTNAME_ATTR': None, 'LDAP_SERVER_URI': None, 'LDAP_USERNAME_ATTR': None, 'LDAP_USER_BASE': None, 'LDAP_USER_FILTER': None, 'LOGOUT_REDIRECT_URL': '/', 'LOGS_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/logs'), 'MEDIA_MAX_SIZE': '750m', 'MEDIA_TIMEOUT': 3600, 'MERCURY_BINARY': 'postlight-parser', 'MERCURY_VERSION': None, 'NODE_BINARY': 'node', 'NODE_VERSION': 'v20.11.0', 'ONLY_NEW': True, 'OUTPUT_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest'), 'OUTPUT_PERMISSIONS': '644', 'PACKAGE_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox'), 'PGID': 205, 'POCKET_ACCESS_TOKENS': {}, 'POCKET_CONSUMER_KEY': None, 'PREVIEW_ORIGINALS': True, 'PUBLIC_ADD_VIEW': False, 'PUBLIC_INDEX': True, 'PUBLIC_SNAPSHOTS': True, 'PUID': 1005, 'PYTHON_BINARY': '/home/docs/checkouts/readthedocs.org/user_builds/archivebox/envs/latest/bin/python', 'PYTHON_ENCODING': 'UTF-8', 'PYTHON_VERSION': '3.12.0', 'READABILITY_BINARY': 'readability-extractor', 'READABILITY_VERSION': None, 'READWISE_READER_TOKENS': {}, 'RESOLUTION': '1440,2000', 'RESTRICT_FILE_NAMES': 'windows', 'REVERSE_PROXY_USER_HEADER': 'Remote-User', 'REVERSE_PROXY_WHITELIST': '', 'RIPGREP_BINARY': 'rg', 'RIPGREP_VERSION': None, 'SAVE_ALLOWLIST': {}, 'SAVE_ALLOWLIST_PTN': {}, 'SAVE_ARCHIVE_DOT_ORG': True, 'SAVE_DENYLIST': {}, 'SAVE_DENYLIST_PTN': {}, 'SAVE_DOM': False, 'SAVE_FAVICON': True, 'SAVE_GIT': True, 'SAVE_HEADERS': True, 'SAVE_HTMLTOTEXT': True, 'SAVE_MEDIA': True, 'SAVE_MERCURY': True, 'SAVE_PDF': False, 'SAVE_READABILITY': True, 'SAVE_SCREENSHOT': False, 'SAVE_SINGLEFILE': False, 'SAVE_TITLE': True, 'SAVE_WARC': True, 'SAVE_WGET': True, 'SAVE_WGET_REQUISITES': True, 'SEARCH_BACKEND_ENGINE': 'ripgrep', 'SEARCH_BACKEND_HOST_NAME': 'localhost', 'SEARCH_BACKEND_PASSWORD': 'SecretPassword', 'SEARCH_BACKEND_PORT': 1491, 'SEARCH_BACKEND_TIMEOUT': 90, 'SEARCH_PROCESS_HTML': True, 'SECRET_KEY': None, 'SHOW_PROGRESS': False, 'SINGLEFILE_ARGS': [], 'SINGLEFILE_BINARY': 'single-file', 'SINGLEFILE_VERSION': None, 'SNAPSHOTS_PER_PAGE': 40, 'SONIC_BUCKET': 'snapshots', 'SONIC_COLLECTION': 'archivebox', 'SOURCES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/sources'), 'SQLITE_BINARY': '/home/docs/.asdf/installs/python/3.12.0/lib/python3.12/sqlite3/dbapi2.py', 'SQLITE_VERSION': '2.6.0', 'TAG_SEPARATOR_PATTERN': '[,]', 'TEMPLATES_DIR': PosixPath('/home/docs/checkouts/readthedocs.org/user_builds/archivebox/checkouts/latest/archivebox/templates'), 'TERM_WIDTH': <function <lambda>.<locals>.<lambda>>, 'TIMEOUT': 60, 'TIMEZONE': 'UTC', 'TIME_ZONE': 'UTC', 'URL_ALLOWLIST': None, 'URL_ALLOWLIST_PTN': None, 'URL_DENYLIST': '\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', 'URL_DENYLIST_PTN': re.compile('\\.(css|js|otf|ttf|woff|woff2|gstatic\\.com|googleapis\\.com/css)(\\?.*)?$', re.IGNORECASE|re.MULTILINE), 'USER': 'docs', 'USE_CHROME': False, 'USE_COLOR': False, 'USE_CURL': True, 'USE_GIT': True, 'USE_INDEXING_BACKEND': True, 'USE_MERCURY': True, 'USE_NODE': True, 'USE_READABILITY': True, 'USE_RIPGREP': True, 'USE_SEARCHING_BACKEND': True, 'USE_SINGLEFILE': True, 'USE_WGET': True, 'USE_YOUTUBEDL': True, 'VERSION': 'dev', 'VERSIONS_AVAILABLE': None, 'WGET_ARGS': ['--no-verbose', '--adjust-extension', '--convert-links', '--force-directories', '--backup-converted', '--span-hosts', '--no-parent', '-e', 'robots=off'], 'WGET_AUTO_COMPRESSION': True, 'WGET_BINARY': 'wget', 'WGET_USER_AGENT': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36 ArchiveBox/dev (+https://github.com/ArchiveBox/ArchiveBox/) wget/GNU Wget 1.21.2', 'WGET_VERSION': 'GNU Wget 1.21.2', 'YOUTUBEDL_ARGS': ['--restrict-filenames', '--trim-filenames', '128', '--write-description', '--write-info-json', '--write-annotations', '--write-thumbnail', '--no-call-home', '--write-sub', '--write-auto-subs', '--convert-subs=srt', '--yes-playlist', '--continue', '--no-abort-on-error', '--ignore-errors', '--geo-bypass', '--add-metadata', '--format=(bv*+ba/b)[filesize<=750m][filesize_approx<=?750m]/(bv*+ba/b)'], 'YOUTUBEDL_BINARY': 'yt-dlp', 'YOUTUBEDL_VERSION': '2023.12.30'}, in_memory_db=False) → None[source]

archivebox.config.TERM_WIDTH()

archivebox.config.stubs module

class archivebox.config_stubs.BaseConfig(*args, **kwargs)[source]: Bases: dict

class archivebox.config_stubs.ConfigDict(*args, **kwargs)[source]

Bases: dict

# Regenerate by pasting this quine into archivebox shell 🥚 from archivebox.config import ConfigDict, CONFIG_DEFAULTS print(‘class ConfigDict(BaseConfig, total=False):’) print(’ ‘ + ‘”’*3 + ConfigDict.__doc__ + ‘”’*3) for section, configs in CONFIG_DEFAULTS.items():

for key, attrs in configs.items():
Type, default = attrs[‘type’], attrs[‘default’] if default is None:

print(f’ {key}: Optional[{Type.__name__}]’)

else:
print(f’ {key}: {Type.__name__}’)

print()

IS_TTY: bool

USE_COLOR: bool

SHOW_PROGRESS: bool

IN_DOCKER: bool

PACKAGE_DIR: Path

OUTPUT_DIR: Path

CONFIG_FILE: Path

ONLY_NEW: bool

TIMEOUT: int

MEDIA_TIMEOUT: int

OUTPUT_PERMISSIONS: str

RESTRICT_FILE_NAMES: str

URL_DENYLIST: str

SECRET_KEY: str | None

BIND_ADDR: str

ALLOWED_HOSTS: str

DEBUG: bool

PUBLIC_INDEX: bool

PUBLIC_SNAPSHOTS: bool

FOOTER_INFO: str

SAVE_TITLE: bool

SAVE_FAVICON: bool

SAVE_WGET: bool

SAVE_WGET_REQUISITES: bool

SAVE_SINGLEFILE: bool

SAVE_READABILITY: bool

SAVE_MERCURY: bool

SAVE_PDF: bool

SAVE_SCREENSHOT: bool

SAVE_DOM: bool

SAVE_WARC: bool

SAVE_GIT: bool

SAVE_MEDIA: bool

SAVE_ARCHIVE_DOT_ORG: bool

RESOLUTION: str

GIT_DOMAINS: str

CHECK_SSL_VALIDITY: bool

CURL_USER_AGENT: str

WGET_USER_AGENT: str

CHROME_USER_AGENT: str

COOKIES_FILE: str | Path | None

CHROME_USER_DATA_DIR: str | Path | None

CHROME_TIMEOUT: int

CHROME_HEADLESS: bool

CHROME_SANDBOX: bool

USE_CURL: bool

USE_WGET: bool

USE_SINGLEFILE: bool

USE_READABILITY: bool

USE_MERCURY: bool

USE_GIT: bool

USE_CHROME: bool

USE_YOUTUBEDL: bool

CURL_BINARY: str

GIT_BINARY: str

WGET_BINARY: str

SINGLEFILE_BINARY: str

READABILITY_BINARY: str

MERCURY_BINARY: str

YOUTUBEDL_BINARY: str

CHROME_BINARY: str | None

YOUTUBEDL_ARGS: List[str]

WGET_ARGS: List[str]

CURL_ARGS: List[str]

GIT_ARGS: List[str]

TAG_SEPARATOR_PATTERN: str

class archivebox.config_stubs.ConfigDefault(*args, **kwargs)

Bases: dict

default: str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[ConfigDict], str | bool | int | None | Pattern | Dict[str, Any] | Dict[str, str | bool | int | None | Pattern | Dict[str, Any]] | Callable[[], str | bool | int | None | Pattern | Dict[str, Any]]]

type: Type | None

aliases: Tuple[str, ...] | None