archivebox.config.common

Module Contents

Classes

ShellConfig

StorageConfig

GeneralConfig

ServerConfig

ArchivingConfig

SearchBackendConfig

Data

SHELL_CONFIG

STORAGE_CONFIG

GENERAL_CONFIG

SERVER_CONFIG

ARCHIVING_CONFIG

SEARCH_BACKEND_CONFIG

API

class archivebox.config.common.ShellConfig[source]

Bases: abx_spec_config.base_configset.BaseConfigSet

DEBUG: bool[source]

‘Field(…)’

IS_TTY: bool[source]

‘Field(…)’

USE_COLOR: bool[source]

‘Field(…)’

SHOW_PROGRESS: bool[source]

‘Field(…)’

IN_DOCKER: bool[source]

‘Field(…)’

IN_QEMU: bool[source]

‘Field(…)’

ANSI: Dict[str, str][source]

‘Field(…)’

property TERM_WIDTH: int[source]
property COMMIT_HASH: Optional[str][source]
property BUILD_TIME: str[source]
archivebox.config.common.SHELL_CONFIG[source]

‘ShellConfig(…)’

class archivebox.config.common.StorageConfig[source]

Bases: abx_spec_config.base_configset.BaseConfigSet

TMP_DIR: pathlib.Path[source]

‘Field(…)’

LIB_DIR: pathlib.Path[source]

‘Field(…)’

OUTPUT_PERMISSIONS: str[source]

‘Field(…)’

RESTRICT_FILE_NAMES: str[source]

‘Field(…)’

ENFORCE_ATOMIC_WRITES: bool[source]

‘Field(…)’

DIR_OUTPUT_PERMISSIONS: str[source]

‘Field(…)’

archivebox.config.common.STORAGE_CONFIG[source]

‘StorageConfig(…)’

class archivebox.config.common.GeneralConfig[source]

Bases: abx_spec_config.base_configset.BaseConfigSet

TAG_SEPARATOR_PATTERN: str[source]

‘Field(…)’

archivebox.config.common.GENERAL_CONFIG[source]

‘GeneralConfig(…)’

class archivebox.config.common.ServerConfig[source]

Bases: abx_spec_config.base_configset.BaseConfigSet

SECRET_KEY: str[source]

‘Field(…)’

BIND_ADDR: str[source]

‘Field(…)’

ALLOWED_HOSTS: str[source]

‘Field(…)’

CSRF_TRUSTED_ORIGINS: str[source]

‘Field(…)’

SNAPSHOTS_PER_PAGE: int[source]

‘Field(…)’

PREVIEW_ORIGINALS: bool[source]

‘Field(…)’

FOOTER_INFO: str[source]

‘Field(…)’

PUBLIC_INDEX: bool[source]

‘Field(…)’

PUBLIC_SNAPSHOTS: bool[source]

‘Field(…)’

PUBLIC_ADD_VIEW: bool[source]

‘Field(…)’

ADMIN_USERNAME: str[source]

‘Field(…)’

ADMIN_PASSWORD: str[source]

‘Field(…)’

REVERSE_PROXY_USER_HEADER: str[source]

‘Field(…)’

REVERSE_PROXY_WHITELIST: str[source]

‘Field(…)’

LOGOUT_REDIRECT_URL: str[source]

‘Field(…)’

archivebox.config.common.SERVER_CONFIG[source]

‘ServerConfig(…)’

class archivebox.config.common.ArchivingConfig[source]

Bases: abx_spec_config.base_configset.BaseConfigSet

ONLY_NEW: bool[source]

‘Field(…)’

TIMEOUT: int[source]

‘Field(…)’

MEDIA_TIMEOUT: int[source]

‘Field(…)’

MEDIA_MAX_SIZE: str[source]

‘Field(…)’

RESOLUTION: str[source]

‘Field(…)’

CHECK_SSL_VALIDITY: bool[source]

‘Field(…)’

USER_AGENT: str[source]

‘Field(…)’

COOKIES_FILE: pathlib.Path | None[source]

‘Field(…)’

URL_DENYLIST: str[source]

‘Field(…)’

URL_ALLOWLIST: str | None[source]

‘Field(…)’

SAVE_ALLOWLIST: Dict[str, List[str]][source]

‘Field(…)’

SAVE_DENYLIST: Dict[str, List[str]][source]

‘Field(…)’

DEFAULT_PERSONA: str[source]

‘Field(…)’

validate()[source]
validate_check_ssl_validity(v)[source]

SIDE EFFECT: disable “you really shouldnt disable ssl” warnings emitted by requests

property URL_ALLOWLIST_PTN: re.Pattern | None[source]
property URL_DENYLIST_PTN: re.Pattern[source]
property SAVE_ALLOWLIST_PTNS: Dict[re.Pattern, List[str]][source]
property SAVE_DENYLIST_PTNS: Dict[re.Pattern, List[str]][source]
archivebox.config.common.ARCHIVING_CONFIG[source]

‘ArchivingConfig(…)’

class archivebox.config.common.SearchBackendConfig[source]

Bases: abx_spec_config.base_configset.BaseConfigSet

USE_INDEXING_BACKEND: bool[source]

‘Field(…)’

USE_SEARCHING_BACKEND: bool[source]

‘Field(…)’

SEARCH_BACKEND_ENGINE: str[source]

‘Field(…)’

SEARCH_PROCESS_HTML: bool[source]

‘Field(…)’

SEARCH_BACKEND_TIMEOUT: int[source]

‘Field(…)’

archivebox.config.common.SEARCH_BACKEND_CONFIG[source]

‘SearchBackendConfig(…)’