ArchiveBox¶

By default, your new installation has a publicly accessible web index, snapshots, and archive addition access. You may not want this for a host of security reasons, so it's recommended to review the ArchiveBox Security Overview and tailoring these settings to your preference when setting up.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
archivebox_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like archivebox_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like archivebox_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

archivebox_name

# Type: string
archivebox_name: archivebox

archivebox_role_web_subdomain

# Type: string
archivebox_role_web_subdomain: "{{ archivebox_name }}"

archivebox_role_web_domain

# Type: string
archivebox_role_web_domain: "{{ user.domain }}"

archivebox_role_web_port

# Type: string
archivebox_role_web_port: "8000"

archivebox_role_web_url

# Type: string
archivebox_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='archivebox') + '.' + lookup('role_var', '_web_domain', role='archivebox')
                          if (lookup('role_var', '_web_subdomain', role='archivebox') | length > 0)
                          else lookup('role_var', '_web_domain', role='archivebox')) }}"

archivebox_role_dns_record

# Type: string
archivebox_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='archivebox') }}"

archivebox_role_dns_zone

# Type: string
archivebox_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='archivebox') }}"

archivebox_role_dns_proxy

# Type: bool (true/false)
archivebox_role_dns_proxy: "{{ dns_proxied }}"

archivebox_role_traefik_sso_middleware

# Type: string
archivebox_role_traefik_sso_middleware: ""

archivebox_role_traefik_middleware_default

# Type: string
archivebox_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

archivebox_role_traefik_middleware_custom

# Type: string
archivebox_role_traefik_middleware_custom: ""

archivebox_role_traefik_certresolver

# Type: string
archivebox_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

archivebox_role_traefik_enabled

# Type: bool (true/false)
archivebox_role_traefik_enabled: true

Container

archivebox_role_docker_container

# Type: string
archivebox_role_docker_container: "{{ archivebox_name }}"

Image

archivebox_role_docker_image_pull

# Type: bool (true/false)
archivebox_role_docker_image_pull: true

archivebox_role_docker_image_repo

# Type: string
archivebox_role_docker_image_repo: "archivebox/archivebox"

archivebox_role_docker_image_tag

# Type: string
archivebox_role_docker_image_tag: "latest"

archivebox_role_docker_image

# Type: string
archivebox_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='archivebox') }}:{{ lookup('role_var', '_docker_image_tag', role='archivebox') }}"

Envs

archivebox_role_docker_envs_default

# Type: dict
archivebox_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"

archivebox_role_docker_envs_custom

# Type: dict
archivebox_role_docker_envs_custom: {}

Volumes

archivebox_role_docker_volumes_default

# Type: list
archivebox_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='archivebox') }}:/data"

archivebox_role_docker_volumes_custom

# Type: list
archivebox_role_docker_volumes_custom: []

Hostname

archivebox_role_docker_hostname

# Type: string
archivebox_role_docker_hostname: "{{ archivebox_name }}"

Networks

archivebox_role_docker_networks_alias

# Type: string
archivebox_role_docker_networks_alias: "{{ archivebox_name }}"

archivebox_role_docker_networks_default

# Type: list
archivebox_role_docker_networks_default: []

archivebox_role_docker_networks_custom

# Type: list
archivebox_role_docker_networks_custom: []

Restart Policy

archivebox_role_docker_restart_policy

# Type: string
archivebox_role_docker_restart_policy: unless-stopped

State

archivebox_role_docker_state

# Type: string
archivebox_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

archivebox_role_docker_blkio_weight

# Type: int
archivebox_role_docker_blkio_weight:

archivebox_role_docker_cpu_period

# Type: int
archivebox_role_docker_cpu_period:

archivebox_role_docker_cpu_quota

# Type: int
archivebox_role_docker_cpu_quota:

archivebox_role_docker_cpu_shares

# Type: int
archivebox_role_docker_cpu_shares:

archivebox_role_docker_cpus

# Type: string
archivebox_role_docker_cpus:

archivebox_role_docker_cpuset_cpus

# Type: string
archivebox_role_docker_cpuset_cpus:

archivebox_role_docker_cpuset_mems

# Type: string
archivebox_role_docker_cpuset_mems:

archivebox_role_docker_kernel_memory

# Type: string
archivebox_role_docker_kernel_memory:

archivebox_role_docker_memory

# Type: string
archivebox_role_docker_memory:

archivebox_role_docker_memory_reservation

# Type: string
archivebox_role_docker_memory_reservation:

archivebox_role_docker_memory_swap

# Type: string
archivebox_role_docker_memory_swap:

archivebox_role_docker_memory_swappiness

# Type: int
archivebox_role_docker_memory_swappiness:

archivebox_role_docker_shm_size

# Type: string
archivebox_role_docker_shm_size:

Security & Devices

archivebox_role_docker_cap_drop

# Type: list
archivebox_role_docker_cap_drop:

archivebox_role_docker_cgroupns_mode

# Type: string
archivebox_role_docker_cgroupns_mode:

archivebox_role_docker_device_cgroup_rules

# Type: list
archivebox_role_docker_device_cgroup_rules:

archivebox_role_docker_device_read_bps

# Type: list
archivebox_role_docker_device_read_bps:

archivebox_role_docker_device_read_iops

# Type: list
archivebox_role_docker_device_read_iops:

archivebox_role_docker_device_requests

# Type: list
archivebox_role_docker_device_requests:

archivebox_role_docker_device_write_bps

# Type: list
archivebox_role_docker_device_write_bps:

archivebox_role_docker_device_write_iops

# Type: list
archivebox_role_docker_device_write_iops:

archivebox_role_docker_devices

# Type: list
archivebox_role_docker_devices:

archivebox_role_docker_devices_default

# Type: string
archivebox_role_docker_devices_default:

archivebox_role_docker_groups

# Type: list
archivebox_role_docker_groups:

archivebox_role_docker_privileged

# Type: bool (true/false)
archivebox_role_docker_privileged:

archivebox_role_docker_security_opts

# Type: list
archivebox_role_docker_security_opts:

archivebox_role_docker_user

# Type: string
archivebox_role_docker_user:

archivebox_role_docker_userns_mode

# Type: string
archivebox_role_docker_userns_mode:

Networking

archivebox_role_docker_dns_opts

# Type: list
archivebox_role_docker_dns_opts:

archivebox_role_docker_dns_search_domains

# Type: list
archivebox_role_docker_dns_search_domains:

archivebox_role_docker_dns_servers

# Type: list
archivebox_role_docker_dns_servers:

archivebox_role_docker_domainname

# Type: string
archivebox_role_docker_domainname:

archivebox_role_docker_exposed_ports

# Type: list
archivebox_role_docker_exposed_ports:

archivebox_role_docker_hosts

# Type: dict
archivebox_role_docker_hosts:

archivebox_role_docker_hosts_use_common

# Type: bool (true/false)
archivebox_role_docker_hosts_use_common:

archivebox_role_docker_ipc_mode

# Type: string
archivebox_role_docker_ipc_mode:

archivebox_role_docker_links

# Type: list
archivebox_role_docker_links:

archivebox_role_docker_network_mode

# Type: string
archivebox_role_docker_network_mode:

archivebox_role_docker_pid_mode

# Type: string
archivebox_role_docker_pid_mode:

archivebox_role_docker_ports

# Type: list
archivebox_role_docker_ports:

archivebox_role_docker_uts

# Type: string
archivebox_role_docker_uts:

Storage

archivebox_role_docker_keep_volumes

# Type: bool (true/false)
archivebox_role_docker_keep_volumes:

archivebox_role_docker_mounts

# Type: list
archivebox_role_docker_mounts:

archivebox_role_docker_storage_opts

# Type: dict
archivebox_role_docker_storage_opts:

archivebox_role_docker_tmpfs

# Type: list
archivebox_role_docker_tmpfs:

archivebox_role_docker_volume_driver

# Type: string
archivebox_role_docker_volume_driver:

archivebox_role_docker_volumes_from

# Type: list
archivebox_role_docker_volumes_from:

archivebox_role_docker_volumes_global

# Type: bool (true/false)
archivebox_role_docker_volumes_global:

archivebox_role_docker_working_dir

# Type: string
archivebox_role_docker_working_dir:

Monitoring & Lifecycle

archivebox_role_docker_auto_remove

# Type: bool (true/false)
archivebox_role_docker_auto_remove:

archivebox_role_docker_cleanup

# Type: bool (true/false)
archivebox_role_docker_cleanup:

archivebox_role_docker_force_kill

# Type: string
archivebox_role_docker_force_kill:

archivebox_role_docker_healthcheck

# Type: dict
archivebox_role_docker_healthcheck:

archivebox_role_docker_healthy_wait_timeout

# Type: int
archivebox_role_docker_healthy_wait_timeout:

archivebox_role_docker_init

# Type: bool (true/false)
archivebox_role_docker_init:

archivebox_role_docker_kill_signal

# Type: string
archivebox_role_docker_kill_signal:

archivebox_role_docker_log_driver

# Type: string
archivebox_role_docker_log_driver:

archivebox_role_docker_log_options

# Type: dict
archivebox_role_docker_log_options:

archivebox_role_docker_oom_killer

# Type: bool (true/false)
archivebox_role_docker_oom_killer:

archivebox_role_docker_oom_score_adj

# Type: int
archivebox_role_docker_oom_score_adj:

archivebox_role_docker_output_logs

# Type: bool (true/false)
archivebox_role_docker_output_logs:

archivebox_role_docker_paused

# Type: bool (true/false)
archivebox_role_docker_paused:

archivebox_role_docker_recreate

# Type: bool (true/false)
archivebox_role_docker_recreate:

archivebox_role_docker_restart_retries

# Type: int
archivebox_role_docker_restart_retries:

archivebox_role_docker_stop_timeout

# Type: int
archivebox_role_docker_stop_timeout:

Other Options

archivebox_role_docker_capabilities

# Type: list
archivebox_role_docker_capabilities:

archivebox_role_docker_cgroup_parent

# Type: string
archivebox_role_docker_cgroup_parent:

archivebox_role_docker_commands

# Type: list
archivebox_role_docker_commands:

archivebox_role_docker_create_timeout

# Type: int
archivebox_role_docker_create_timeout:

archivebox_role_docker_entrypoint

# Type: string
archivebox_role_docker_entrypoint:

archivebox_role_docker_env_file

# Type: string
archivebox_role_docker_env_file:

archivebox_role_docker_labels

# Type: dict
archivebox_role_docker_labels:

archivebox_role_docker_labels_use_common

# Type: bool (true/false)
archivebox_role_docker_labels_use_common:

archivebox_role_docker_read_only

# Type: bool (true/false)
archivebox_role_docker_read_only:

archivebox_role_docker_runtime

# Type: string
archivebox_role_docker_runtime:

archivebox_role_docker_sysctls

# Type: list
archivebox_role_docker_sysctls:

archivebox_role_docker_ulimits

# Type: list
archivebox_role_docker_ulimits:

archivebox_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
archivebox_role_autoheal_enabled: true

archivebox_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
archivebox_role_depends_on: ""

archivebox_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
archivebox_role_depends_on_delay: "0"

archivebox_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
archivebox_role_depends_on_healthchecks:

archivebox_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
archivebox_role_diun_enabled: true

archivebox_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
archivebox_role_dns_enabled: true

archivebox_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
archivebox_role_docker_controller: true

archivebox_role_docker_image_repo

# Type: string
archivebox_role_docker_image_repo:

archivebox_role_docker_image_tag

# Type: string
archivebox_role_docker_image_tag:

archivebox_role_docker_volumes_download

# Type: bool (true/false)
archivebox_role_docker_volumes_download:

archivebox_role_paths_location

# Type: string
archivebox_role_paths_location:

archivebox_role_themepark_addons

# Type: string
archivebox_role_themepark_addons:

archivebox_role_themepark_app

# Type: string
archivebox_role_themepark_app:

archivebox_role_themepark_theme

# Type: string
archivebox_role_themepark_theme:

archivebox_role_traefik_api_endpoint

# Type: dict/omit
archivebox_role_traefik_api_endpoint:

archivebox_role_traefik_api_middleware

# Type: string
archivebox_role_traefik_api_middleware:

archivebox_role_traefik_api_middleware_http

# Type: string
archivebox_role_traefik_api_middleware_http:

archivebox_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
archivebox_role_traefik_autodetect_enabled: false

archivebox_role_traefik_certresolver

# Type: string
archivebox_role_traefik_certresolver:

archivebox_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
archivebox_role_traefik_crowdsec_enabled: false

archivebox_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
archivebox_role_traefik_error_pages_enabled: false

archivebox_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
archivebox_role_traefik_gzip_enabled: false

archivebox_role_traefik_middleware_http

# Type: string
archivebox_role_traefik_middleware_http:

archivebox_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
archivebox_role_traefik_middleware_http_api_insecure:

archivebox_role_traefik_middleware_http_insecure

# Type: bool (true/false)
archivebox_role_traefik_middleware_http_insecure:

archivebox_role_traefik_priority

# Type: string
archivebox_role_traefik_priority:

archivebox_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
archivebox_role_traefik_robot_enabled: true

archivebox_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
archivebox_role_traefik_tailscale_enabled: false

archivebox_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
archivebox_role_traefik_wildcard_enabled: true

archivebox_role_web_domain

# Type: string
archivebox_role_web_domain:

archivebox_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
archivebox_role_web_fqdn_override:

Example Override

archivebox_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "archivebox2.{{ user.domain }}"
  - "archivebox.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

archivebox_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
archivebox_role_web_host_override:

Example Override

archivebox_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'archivebox2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

archivebox_role_web_http_port

# Type: string (quoted number)
archivebox_role_web_http_port:

archivebox_role_web_http_scheme

# Type: string ("http"/"https")
archivebox_role_web_http_scheme:

archivebox_role_web_http_serverstransport

# Type: dict/omit
archivebox_role_web_http_serverstransport:

archivebox_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
archivebox_role_web_scheme:

archivebox_role_web_serverstransport

# Type: dict/omit
archivebox_role_web_serverstransport:

archivebox_role_web_subdomain

# Type: string
archivebox_role_web_subdomain: