{py:mod}archivebox.config.common

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`ShellConfig <archivebox.config.common.ShellConfig>`
  -
* - {py:obj}`StorageConfig <archivebox.config.common.StorageConfig>`
  -
* - {py:obj}`GeneralConfig <archivebox.config.common.GeneralConfig>`
  -
* - {py:obj}`ServerConfig <archivebox.config.common.ServerConfig>`
  -
* - {py:obj}`ArchivingConfig <archivebox.config.common.ArchivingConfig>`
  -
* - {py:obj}`SearchBackendConfig <archivebox.config.common.SearchBackendConfig>`
  -

Data

:class: autosummary longtable
:align: left

* - {py:obj}`SHELL_CONFIG <archivebox.config.common.SHELL_CONFIG>`
  - ```{autodoc2-docstring} archivebox.config.common.SHELL_CONFIG
    :summary:
    ```
* - {py:obj}`STORAGE_CONFIG <archivebox.config.common.STORAGE_CONFIG>`
  - ```{autodoc2-docstring} archivebox.config.common.STORAGE_CONFIG
    :summary:
    ```
* - {py:obj}`GENERAL_CONFIG <archivebox.config.common.GENERAL_CONFIG>`
  - ```{autodoc2-docstring} archivebox.config.common.GENERAL_CONFIG
    :summary:
    ```
* - {py:obj}`SERVER_CONFIG <archivebox.config.common.SERVER_CONFIG>`
  - ```{autodoc2-docstring} archivebox.config.common.SERVER_CONFIG
    :summary:
    ```
* - {py:obj}`ARCHIVING_CONFIG <archivebox.config.common.ARCHIVING_CONFIG>`
  - ```{autodoc2-docstring} archivebox.config.common.ARCHIVING_CONFIG
    :summary:
    ```
* - {py:obj}`SEARCH_BACKEND_CONFIG <archivebox.config.common.SEARCH_BACKEND_CONFIG>`
  - ```{autodoc2-docstring} archivebox.config.common.SEARCH_BACKEND_CONFIG
    :summary:
    ```

API

:canonical: archivebox.config.common.ShellConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} DEBUG
:canonical: archivebox.config.common.ShellConfig.DEBUG
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ShellConfig.DEBUG
```

````

````{py:attribute} IS_TTY
:canonical: archivebox.config.common.ShellConfig.IS_TTY
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ShellConfig.IS_TTY
```

````

````{py:attribute} USE_COLOR
:canonical: archivebox.config.common.ShellConfig.USE_COLOR
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ShellConfig.USE_COLOR
```

````

````{py:attribute} SHOW_PROGRESS
:canonical: archivebox.config.common.ShellConfig.SHOW_PROGRESS
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ShellConfig.SHOW_PROGRESS
```

````

````{py:attribute} IN_DOCKER
:canonical: archivebox.config.common.ShellConfig.IN_DOCKER
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ShellConfig.IN_DOCKER
```

````

````{py:attribute} IN_QEMU
:canonical: archivebox.config.common.ShellConfig.IN_QEMU
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ShellConfig.IN_QEMU
```

````

````{py:attribute} ANSI
:canonical: archivebox.config.common.ShellConfig.ANSI
:type: typing.Dict[str, str]
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ShellConfig.ANSI
```

````

````{py:property} TERM_WIDTH
:canonical: archivebox.config.common.ShellConfig.TERM_WIDTH
:type: int

```{autodoc2-docstring} archivebox.config.common.ShellConfig.TERM_WIDTH
```

````

````{py:property} COMMIT_HASH
:canonical: archivebox.config.common.ShellConfig.COMMIT_HASH
:type: typing.Optional[str]

```{autodoc2-docstring} archivebox.config.common.ShellConfig.COMMIT_HASH
```

````

````{py:property} BUILD_TIME
:canonical: archivebox.config.common.ShellConfig.BUILD_TIME
:type: str

```{autodoc2-docstring} archivebox.config.common.ShellConfig.BUILD_TIME
```

````

:canonical: archivebox.config.common.SHELL_CONFIG
:value: >
   'ShellConfig(...)'

```{autodoc2-docstring} archivebox.config.common.SHELL_CONFIG
```

:canonical: archivebox.config.common.StorageConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} TMP_DIR
:canonical: archivebox.config.common.StorageConfig.TMP_DIR
:type: pathlib.Path
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.StorageConfig.TMP_DIR
```

````

````{py:attribute} LIB_DIR
:canonical: archivebox.config.common.StorageConfig.LIB_DIR
:type: pathlib.Path
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.StorageConfig.LIB_DIR
```

````

````{py:attribute} OUTPUT_PERMISSIONS
:canonical: archivebox.config.common.StorageConfig.OUTPUT_PERMISSIONS
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.StorageConfig.OUTPUT_PERMISSIONS
```

````

````{py:attribute} RESTRICT_FILE_NAMES
:canonical: archivebox.config.common.StorageConfig.RESTRICT_FILE_NAMES
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.StorageConfig.RESTRICT_FILE_NAMES
```

````

````{py:attribute} ENFORCE_ATOMIC_WRITES
:canonical: archivebox.config.common.StorageConfig.ENFORCE_ATOMIC_WRITES
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.StorageConfig.ENFORCE_ATOMIC_WRITES
```

````

````{py:attribute} DIR_OUTPUT_PERMISSIONS
:canonical: archivebox.config.common.StorageConfig.DIR_OUTPUT_PERMISSIONS
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.StorageConfig.DIR_OUTPUT_PERMISSIONS
```

````

:canonical: archivebox.config.common.STORAGE_CONFIG
:value: >
   'StorageConfig(...)'

```{autodoc2-docstring} archivebox.config.common.STORAGE_CONFIG
```

:canonical: archivebox.config.common.GeneralConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} TAG_SEPARATOR_PATTERN
:canonical: archivebox.config.common.GeneralConfig.TAG_SEPARATOR_PATTERN
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.GeneralConfig.TAG_SEPARATOR_PATTERN
```

````

:canonical: archivebox.config.common.GENERAL_CONFIG
:value: >
   'GeneralConfig(...)'

```{autodoc2-docstring} archivebox.config.common.GENERAL_CONFIG
```

:canonical: archivebox.config.common.ServerConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} SECRET_KEY
:canonical: archivebox.config.common.ServerConfig.SECRET_KEY
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.SECRET_KEY
```

````

````{py:attribute} BIND_ADDR
:canonical: archivebox.config.common.ServerConfig.BIND_ADDR
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.BIND_ADDR
```

````

````{py:attribute} ALLOWED_HOSTS
:canonical: archivebox.config.common.ServerConfig.ALLOWED_HOSTS
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.ALLOWED_HOSTS
```

````

````{py:attribute} CSRF_TRUSTED_ORIGINS
:canonical: archivebox.config.common.ServerConfig.CSRF_TRUSTED_ORIGINS
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.CSRF_TRUSTED_ORIGINS
```

````

````{py:attribute} SNAPSHOTS_PER_PAGE
:canonical: archivebox.config.common.ServerConfig.SNAPSHOTS_PER_PAGE
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.SNAPSHOTS_PER_PAGE
```

````

````{py:attribute} PREVIEW_ORIGINALS
:canonical: archivebox.config.common.ServerConfig.PREVIEW_ORIGINALS
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.PREVIEW_ORIGINALS
```

````

````{py:attribute} FOOTER_INFO
:canonical: archivebox.config.common.ServerConfig.FOOTER_INFO
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.FOOTER_INFO
```

````

````{py:attribute} PUBLIC_INDEX
:canonical: archivebox.config.common.ServerConfig.PUBLIC_INDEX
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.PUBLIC_INDEX
```

````

````{py:attribute} PUBLIC_SNAPSHOTS
:canonical: archivebox.config.common.ServerConfig.PUBLIC_SNAPSHOTS
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.PUBLIC_SNAPSHOTS
```

````

````{py:attribute} PUBLIC_ADD_VIEW
:canonical: archivebox.config.common.ServerConfig.PUBLIC_ADD_VIEW
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.PUBLIC_ADD_VIEW
```

````

````{py:attribute} ADMIN_USERNAME
:canonical: archivebox.config.common.ServerConfig.ADMIN_USERNAME
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.ADMIN_USERNAME
```

````

````{py:attribute} ADMIN_PASSWORD
:canonical: archivebox.config.common.ServerConfig.ADMIN_PASSWORD
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.ADMIN_PASSWORD
```

````

````{py:attribute} REVERSE_PROXY_USER_HEADER
:canonical: archivebox.config.common.ServerConfig.REVERSE_PROXY_USER_HEADER
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.REVERSE_PROXY_USER_HEADER
```

````

````{py:attribute} REVERSE_PROXY_WHITELIST
:canonical: archivebox.config.common.ServerConfig.REVERSE_PROXY_WHITELIST
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.REVERSE_PROXY_WHITELIST
```

````

````{py:attribute} LOGOUT_REDIRECT_URL
:canonical: archivebox.config.common.ServerConfig.LOGOUT_REDIRECT_URL
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ServerConfig.LOGOUT_REDIRECT_URL
```

````

:canonical: archivebox.config.common.SERVER_CONFIG
:value: >
   'ServerConfig(...)'

```{autodoc2-docstring} archivebox.config.common.SERVER_CONFIG
```

:canonical: archivebox.config.common.ArchivingConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} ONLY_NEW
:canonical: archivebox.config.common.ArchivingConfig.ONLY_NEW
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.ONLY_NEW
```

````

````{py:attribute} TIMEOUT
:canonical: archivebox.config.common.ArchivingConfig.TIMEOUT
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.TIMEOUT
```

````

````{py:attribute} MEDIA_TIMEOUT
:canonical: archivebox.config.common.ArchivingConfig.MEDIA_TIMEOUT
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.MEDIA_TIMEOUT
```

````

````{py:attribute} MEDIA_MAX_SIZE
:canonical: archivebox.config.common.ArchivingConfig.MEDIA_MAX_SIZE
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.MEDIA_MAX_SIZE
```

````

````{py:attribute} RESOLUTION
:canonical: archivebox.config.common.ArchivingConfig.RESOLUTION
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.RESOLUTION
```

````

````{py:attribute} CHECK_SSL_VALIDITY
:canonical: archivebox.config.common.ArchivingConfig.CHECK_SSL_VALIDITY
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.CHECK_SSL_VALIDITY
```

````

````{py:attribute} USER_AGENT
:canonical: archivebox.config.common.ArchivingConfig.USER_AGENT
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.USER_AGENT
```

````

````{py:attribute} COOKIES_FILE
:canonical: archivebox.config.common.ArchivingConfig.COOKIES_FILE
:type: pathlib.Path | None
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.COOKIES_FILE
```

````

````{py:attribute} URL_DENYLIST
:canonical: archivebox.config.common.ArchivingConfig.URL_DENYLIST
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.URL_DENYLIST
```

````

````{py:attribute} URL_ALLOWLIST
:canonical: archivebox.config.common.ArchivingConfig.URL_ALLOWLIST
:type: str | None
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.URL_ALLOWLIST
```

````

````{py:attribute} SAVE_ALLOWLIST
:canonical: archivebox.config.common.ArchivingConfig.SAVE_ALLOWLIST
:type: typing.Dict[str, typing.List[str]]
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.SAVE_ALLOWLIST
```

````

````{py:attribute} SAVE_DENYLIST
:canonical: archivebox.config.common.ArchivingConfig.SAVE_DENYLIST
:type: typing.Dict[str, typing.List[str]]
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.SAVE_DENYLIST
```

````

````{py:attribute} DEFAULT_PERSONA
:canonical: archivebox.config.common.ArchivingConfig.DEFAULT_PERSONA
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.DEFAULT_PERSONA
```

````

````{py:method} validate()
:canonical: archivebox.config.common.ArchivingConfig.validate

````

````{py:method} validate_check_ssl_validity(v)
:canonical: archivebox.config.common.ArchivingConfig.validate_check_ssl_validity

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.validate_check_ssl_validity
```

````

````{py:property} URL_ALLOWLIST_PTN
:canonical: archivebox.config.common.ArchivingConfig.URL_ALLOWLIST_PTN
:type: re.Pattern | None

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.URL_ALLOWLIST_PTN
```

````

````{py:property} URL_DENYLIST_PTN
:canonical: archivebox.config.common.ArchivingConfig.URL_DENYLIST_PTN
:type: re.Pattern

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.URL_DENYLIST_PTN
```

````

````{py:property} SAVE_ALLOWLIST_PTNS
:canonical: archivebox.config.common.ArchivingConfig.SAVE_ALLOWLIST_PTNS
:type: typing.Dict[re.Pattern, typing.List[str]]

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.SAVE_ALLOWLIST_PTNS
```

````

````{py:property} SAVE_DENYLIST_PTNS
:canonical: archivebox.config.common.ArchivingConfig.SAVE_DENYLIST_PTNS
:type: typing.Dict[re.Pattern, typing.List[str]]

```{autodoc2-docstring} archivebox.config.common.ArchivingConfig.SAVE_DENYLIST_PTNS
```

````

:canonical: archivebox.config.common.ARCHIVING_CONFIG
:value: >
   'ArchivingConfig(...)'

```{autodoc2-docstring} archivebox.config.common.ARCHIVING_CONFIG
```

:canonical: archivebox.config.common.SearchBackendConfig

Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet`

````{py:attribute} USE_INDEXING_BACKEND
:canonical: archivebox.config.common.SearchBackendConfig.USE_INDEXING_BACKEND
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.SearchBackendConfig.USE_INDEXING_BACKEND
```

````

````{py:attribute} USE_SEARCHING_BACKEND
:canonical: archivebox.config.common.SearchBackendConfig.USE_SEARCHING_BACKEND
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.SearchBackendConfig.USE_SEARCHING_BACKEND
```

````

````{py:attribute} SEARCH_BACKEND_ENGINE
:canonical: archivebox.config.common.SearchBackendConfig.SEARCH_BACKEND_ENGINE
:type: str
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.SearchBackendConfig.SEARCH_BACKEND_ENGINE
```

````

````{py:attribute} SEARCH_PROCESS_HTML
:canonical: archivebox.config.common.SearchBackendConfig.SEARCH_PROCESS_HTML
:type: bool
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.SearchBackendConfig.SEARCH_PROCESS_HTML
```

````

````{py:attribute} SEARCH_BACKEND_TIMEOUT
:canonical: archivebox.config.common.SearchBackendConfig.SEARCH_BACKEND_TIMEOUT
:type: int
:value: >
   'Field(...)'

```{autodoc2-docstring} archivebox.config.common.SearchBackendConfig.SEARCH_BACKEND_TIMEOUT
```

````

:canonical: archivebox.config.common.SEARCH_BACKEND_CONFIG
:value: >
   'SearchBackendConfig(...)'

```{autodoc2-docstring} archivebox.config.common.SEARCH_BACKEND_CONFIG
```