Shelfmark

Description / name	Input element
Your domain name

Overview

Shelfmark is a unified web interface for searching and aggregating books and audiobook downloads from multiple sources - all in one place.

Manual

Releases

Community

---

Deployment

sb install sandbox-shelfmark

Usage

Visit https://shelfmark.iYOUR_DOMAIN_NAMEi.

Role Defaults

Variables can be customized using the Inventory. (1)

1. This role supports multiple instances via shelfmark_instances.

   Example override

   Role-scopedInstance-scoped

   shelfmark_role_web_subdomain: "custom"
   

   Applies to all instances of shelfmark

   shelfmark2_web_subdomain: "custom2"
   

   Applies to the instance named shelfmark2

   Avoid overriding variables ending in _default

   When overriding variables that end in _default (like shelfmark_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 shelfmark_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikDockerDocker+Global Override Options

shelfmark_instances

# Type: list
shelfmark_instances: ["shelfmark"]

Example Override

# Type: list
shelfmark_instances: ["shelfmark", "shelfmark2"]

shelfmark_role_web_subdomainshelfmark2_web_subdomain

# Type: string
shelfmark_role_web_subdomain: "{{ shelfmark_name }}"

# Type: string
shelfmark2_web_subdomain: "{{ shelfmark_name }}"

shelfmark_role_web_domainshelfmark2_web_domain

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

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

shelfmark_role_web_portshelfmark2_web_port

# Type: string
shelfmark_role_web_port: "8084"

# Type: string
shelfmark2_web_port: "8084"

shelfmark_role_web_urlshelfmark2_web_url

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

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

shelfmark_role_dns_recordshelfmark2_dns_record

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

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

shelfmark_role_dns_zoneshelfmark2_dns_zone

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

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

shelfmark_role_dns_proxyshelfmark2_dns_proxy

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

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

shelfmark_role_traefik_sso_middlewareshelfmark2_traefik_sso_middleware

# Type: string
shelfmark_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

# Type: string
shelfmark2_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

shelfmark_role_traefik_middleware_defaultshelfmark2_traefik_middleware_default

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

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

shelfmark_role_traefik_middleware_customshelfmark2_traefik_middleware_custom

# Type: string
shelfmark_role_traefik_middleware_custom: ""

# Type: string
shelfmark2_traefik_middleware_custom: ""

shelfmark_role_traefik_certresolvershelfmark2_traefik_certresolver

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

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

shelfmark_role_traefik_enabledshelfmark2_traefik_enabled

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

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

shelfmark_role_traefik_api_enabledshelfmark2_traefik_api_enabled

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

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

shelfmark_role_traefik_api_endpointshelfmark2_traefik_api_endpoint

# Type: string
shelfmark_role_traefik_api_endpoint: "PathPrefix(`/api`)"

# Type: string
shelfmark2_traefik_api_endpoint: "PathPrefix(`/api`)"

Container

shelfmark_role_docker_containershelfmark2_docker_container

# Type: string
shelfmark_role_docker_container: "{{ shelfmark_name }}"

# Type: string
shelfmark2_docker_container: "{{ shelfmark_name }}"

Image

shelfmark_role_docker_image_pullshelfmark2_docker_image_pull

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

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

shelfmark_role_docker_image_reposhelfmark2_docker_image_repo

# Type: string
shelfmark_role_docker_image_repo: "ghcr.io/calibrain/shelfmark"

# Type: string
shelfmark2_docker_image_repo: "ghcr.io/calibrain/shelfmark"

shelfmark_role_docker_image_tagshelfmark2_docker_image_tag

# Type: string
shelfmark_role_docker_image_tag: "latest"

# Type: string
shelfmark2_docker_image_tag: "latest"

shelfmark_role_docker_imageshelfmark2_docker_image

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

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

Envs

shelfmark_role_docker_envs_defaultshelfmark2_docker_envs_default

# Type: dict
shelfmark_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  INGEST_DIR: "{{ shelfmark_role_paths_downloads_location }}"

# Type: dict
shelfmark2_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  TZ: "{{ tz }}"
  INGEST_DIR: "{{ shelfmark_role_paths_downloads_location }}"

shelfmark_role_docker_envs_customshelfmark2_docker_envs_custom

# Type: dict
shelfmark_role_docker_envs_custom: {}

# Type: dict
shelfmark2_docker_envs_custom: {}

Volumes

shelfmark_role_docker_volumes_defaultshelfmark2_docker_volumes_default

# Type: list
shelfmark_role_docker_volumes_default:
  - "{{ shelfmark_role_paths_location }}:/config"

# Type: list
shelfmark2_docker_volumes_default:
  - "{{ shelfmark_role_paths_location }}:/config"

shelfmark_role_docker_volumes_customshelfmark2_docker_volumes_custom

# Type: list
shelfmark_role_docker_volumes_custom: []

# Type: list
shelfmark2_docker_volumes_custom: []

Hostname

shelfmark_role_docker_hostnameshelfmark2_docker_hostname

# Type: string
shelfmark_role_docker_hostname: "{{ shelfmark_name }}"

# Type: string
shelfmark2_docker_hostname: "{{ shelfmark_name }}"

Networks

shelfmark_role_docker_networks_aliasshelfmark2_docker_networks_alias

# Type: string
shelfmark_role_docker_networks_alias: "{{ shelfmark_name }}"

# Type: string
shelfmark2_docker_networks_alias: "{{ shelfmark_name }}"

shelfmark_role_docker_networks_defaultshelfmark2_docker_networks_default

# Type: list
shelfmark_role_docker_networks_default: []

# Type: list
shelfmark2_docker_networks_default: []

shelfmark_role_docker_networks_customshelfmark2_docker_networks_custom

# Type: list
shelfmark_role_docker_networks_custom: []

# Type: list
shelfmark2_docker_networks_custom: []

Restart Policy

shelfmark_role_docker_restart_policyshelfmark2_docker_restart_policy

# Type: string
shelfmark_role_docker_restart_policy: unless-stopped

# Type: string
shelfmark2_docker_restart_policy: unless-stopped

State

shelfmark_role_docker_stateshelfmark2_docker_state

# Type: string
shelfmark_role_docker_state: started

# Type: string
shelfmark2_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

shelfmark_role_docker_blkio_weightshelfmark2_docker_blkio_weight

# Type: int
shelfmark_role_docker_blkio_weight:

# Type: int
shelfmark2_docker_blkio_weight:

shelfmark_role_docker_cpu_periodshelfmark2_docker_cpu_period

# Type: int
shelfmark_role_docker_cpu_period:

# Type: int
shelfmark2_docker_cpu_period:

shelfmark_role_docker_cpu_quotashelfmark2_docker_cpu_quota

# Type: int
shelfmark_role_docker_cpu_quota:

# Type: int
shelfmark2_docker_cpu_quota:

shelfmark_role_docker_cpu_sharesshelfmark2_docker_cpu_shares

# Type: int
shelfmark_role_docker_cpu_shares:

# Type: int
shelfmark2_docker_cpu_shares:

shelfmark_role_docker_cpusshelfmark2_docker_cpus

# Type: string
shelfmark_role_docker_cpus:

# Type: string
shelfmark2_docker_cpus:

shelfmark_role_docker_cpuset_cpusshelfmark2_docker_cpuset_cpus

# Type: string
shelfmark_role_docker_cpuset_cpus:

# Type: string
shelfmark2_docker_cpuset_cpus:

shelfmark_role_docker_cpuset_memsshelfmark2_docker_cpuset_mems

# Type: string
shelfmark_role_docker_cpuset_mems:

# Type: string
shelfmark2_docker_cpuset_mems:

shelfmark_role_docker_kernel_memoryshelfmark2_docker_kernel_memory

# Type: string
shelfmark_role_docker_kernel_memory:

# Type: string
shelfmark2_docker_kernel_memory:

shelfmark_role_docker_memoryshelfmark2_docker_memory

# Type: string
shelfmark_role_docker_memory:

# Type: string
shelfmark2_docker_memory:

shelfmark_role_docker_memory_reservationshelfmark2_docker_memory_reservation

# Type: string
shelfmark_role_docker_memory_reservation:

# Type: string
shelfmark2_docker_memory_reservation:

shelfmark_role_docker_memory_swapshelfmark2_docker_memory_swap

# Type: string
shelfmark_role_docker_memory_swap:

# Type: string
shelfmark2_docker_memory_swap:

shelfmark_role_docker_memory_swappinessshelfmark2_docker_memory_swappiness

# Type: int
shelfmark_role_docker_memory_swappiness:

# Type: int
shelfmark2_docker_memory_swappiness:

shelfmark_role_docker_shm_sizeshelfmark2_docker_shm_size

# Type: string
shelfmark_role_docker_shm_size:

# Type: string
shelfmark2_docker_shm_size:

Security & Devices

shelfmark_role_docker_cap_dropshelfmark2_docker_cap_drop

# Type: list
shelfmark_role_docker_cap_drop:

# Type: list
shelfmark2_docker_cap_drop:

shelfmark_role_docker_cgroupns_modeshelfmark2_docker_cgroupns_mode

# Type: string
shelfmark_role_docker_cgroupns_mode:

# Type: string
shelfmark2_docker_cgroupns_mode:

shelfmark_role_docker_device_cgroup_rulesshelfmark2_docker_device_cgroup_rules

# Type: list
shelfmark_role_docker_device_cgroup_rules:

# Type: list
shelfmark2_docker_device_cgroup_rules:

shelfmark_role_docker_device_read_bpsshelfmark2_docker_device_read_bps

# Type: list
shelfmark_role_docker_device_read_bps:

# Type: list
shelfmark2_docker_device_read_bps:

shelfmark_role_docker_device_read_iopsshelfmark2_docker_device_read_iops

# Type: list
shelfmark_role_docker_device_read_iops:

# Type: list
shelfmark2_docker_device_read_iops:

shelfmark_role_docker_device_requestsshelfmark2_docker_device_requests

# Type: list
shelfmark_role_docker_device_requests:

# Type: list
shelfmark2_docker_device_requests:

shelfmark_role_docker_device_write_bpsshelfmark2_docker_device_write_bps

# Type: list
shelfmark_role_docker_device_write_bps:

# Type: list
shelfmark2_docker_device_write_bps:

shelfmark_role_docker_device_write_iopsshelfmark2_docker_device_write_iops

# Type: list
shelfmark_role_docker_device_write_iops:

# Type: list
shelfmark2_docker_device_write_iops:

shelfmark_role_docker_devicesshelfmark2_docker_devices

# Type: list
shelfmark_role_docker_devices:

# Type: list
shelfmark2_docker_devices:

shelfmark_role_docker_groupsshelfmark2_docker_groups

# Type: list
shelfmark_role_docker_groups:

# Type: list
shelfmark2_docker_groups:

shelfmark_role_docker_privilegedshelfmark2_docker_privileged

# Type: bool (true/false)
shelfmark_role_docker_privileged:

# Type: bool (true/false)
shelfmark2_docker_privileged:

shelfmark_role_docker_security_optsshelfmark2_docker_security_opts

# Type: list
shelfmark_role_docker_security_opts:

# Type: list
shelfmark2_docker_security_opts:

shelfmark_role_docker_usershelfmark2_docker_user

# Type: string
shelfmark_role_docker_user:

# Type: string
shelfmark2_docker_user:

shelfmark_role_docker_userns_modeshelfmark2_docker_userns_mode

# Type: string
shelfmark_role_docker_userns_mode:

# Type: string
shelfmark2_docker_userns_mode:

Networking

shelfmark_role_docker_dns_optsshelfmark2_docker_dns_opts

# Type: list
shelfmark_role_docker_dns_opts:

# Type: list
shelfmark2_docker_dns_opts:

shelfmark_role_docker_dns_search_domainsshelfmark2_docker_dns_search_domains

# Type: list
shelfmark_role_docker_dns_search_domains:

# Type: list
shelfmark2_docker_dns_search_domains:

shelfmark_role_docker_dns_serversshelfmark2_docker_dns_servers

# Type: list
shelfmark_role_docker_dns_servers:

# Type: list
shelfmark2_docker_dns_servers:

shelfmark_role_docker_domainnameshelfmark2_docker_domainname

# Type: string
shelfmark_role_docker_domainname:

# Type: string
shelfmark2_docker_domainname:

shelfmark_role_docker_exposed_portsshelfmark2_docker_exposed_ports

# Type: list
shelfmark_role_docker_exposed_ports:

# Type: list
shelfmark2_docker_exposed_ports:

shelfmark_role_docker_hostsshelfmark2_docker_hosts

# Type: dict
shelfmark_role_docker_hosts:

# Type: dict
shelfmark2_docker_hosts:

shelfmark_role_docker_hosts_use_commonshelfmark2_docker_hosts_use_common

# Type: bool (true/false)
shelfmark_role_docker_hosts_use_common:

# Type: bool (true/false)
shelfmark2_docker_hosts_use_common:

shelfmark_role_docker_ipc_modeshelfmark2_docker_ipc_mode

# Type: string
shelfmark_role_docker_ipc_mode:

# Type: string
shelfmark2_docker_ipc_mode:

shelfmark_role_docker_linksshelfmark2_docker_links

# Type: list
shelfmark_role_docker_links:

# Type: list
shelfmark2_docker_links:

shelfmark_role_docker_network_modeshelfmark2_docker_network_mode

# Type: string
shelfmark_role_docker_network_mode:

# Type: string
shelfmark2_docker_network_mode:

shelfmark_role_docker_pid_modeshelfmark2_docker_pid_mode

# Type: string
shelfmark_role_docker_pid_mode:

# Type: string
shelfmark2_docker_pid_mode:

shelfmark_role_docker_portsshelfmark2_docker_ports

# Type: list
shelfmark_role_docker_ports:

# Type: list
shelfmark2_docker_ports:

shelfmark_role_docker_utsshelfmark2_docker_uts

# Type: string
shelfmark_role_docker_uts:

# Type: string
shelfmark2_docker_uts:

Storage

shelfmark_role_docker_keep_volumesshelfmark2_docker_keep_volumes

# Type: bool (true/false)
shelfmark_role_docker_keep_volumes:

# Type: bool (true/false)
shelfmark2_docker_keep_volumes:

shelfmark_role_docker_mountsshelfmark2_docker_mounts

# Type: list
shelfmark_role_docker_mounts:

# Type: list
shelfmark2_docker_mounts:

shelfmark_role_docker_storage_optsshelfmark2_docker_storage_opts

# Type: dict
shelfmark_role_docker_storage_opts:

# Type: dict
shelfmark2_docker_storage_opts:

shelfmark_role_docker_tmpfsshelfmark2_docker_tmpfs

# Type: list
shelfmark_role_docker_tmpfs:

# Type: list
shelfmark2_docker_tmpfs:

shelfmark_role_docker_volume_drivershelfmark2_docker_volume_driver

# Type: string
shelfmark_role_docker_volume_driver:

# Type: string
shelfmark2_docker_volume_driver:

shelfmark_role_docker_volumes_fromshelfmark2_docker_volumes_from

# Type: list
shelfmark_role_docker_volumes_from:

# Type: list
shelfmark2_docker_volumes_from:

shelfmark_role_docker_volumes_globalshelfmark2_docker_volumes_global

# Type: bool (true/false)
shelfmark_role_docker_volumes_global:

# Type: bool (true/false)
shelfmark2_docker_volumes_global:

shelfmark_role_docker_working_dirshelfmark2_docker_working_dir

# Type: string
shelfmark_role_docker_working_dir:

# Type: string
shelfmark2_docker_working_dir:

Monitoring & Lifecycle

shelfmark_role_docker_auto_removeshelfmark2_docker_auto_remove

# Type: bool (true/false)
shelfmark_role_docker_auto_remove:

# Type: bool (true/false)
shelfmark2_docker_auto_remove:

shelfmark_role_docker_cleanupshelfmark2_docker_cleanup

# Type: bool (true/false)
shelfmark_role_docker_cleanup:

# Type: bool (true/false)
shelfmark2_docker_cleanup:

shelfmark_role_docker_force_killshelfmark2_docker_force_kill

# Type: string
shelfmark_role_docker_force_kill:

# Type: string
shelfmark2_docker_force_kill:

shelfmark_role_docker_healthcheckshelfmark2_docker_healthcheck

# Type: dict
shelfmark_role_docker_healthcheck:

# Type: dict
shelfmark2_docker_healthcheck:

shelfmark_role_docker_healthy_wait_timeoutshelfmark2_docker_healthy_wait_timeout

# Type: int
shelfmark_role_docker_healthy_wait_timeout:

# Type: int
shelfmark2_docker_healthy_wait_timeout:

shelfmark_role_docker_initshelfmark2_docker_init

# Type: bool (true/false)
shelfmark_role_docker_init:

# Type: bool (true/false)
shelfmark2_docker_init:

shelfmark_role_docker_kill_signalshelfmark2_docker_kill_signal

# Type: string
shelfmark_role_docker_kill_signal:

# Type: string
shelfmark2_docker_kill_signal:

shelfmark_role_docker_log_drivershelfmark2_docker_log_driver

# Type: string
shelfmark_role_docker_log_driver:

# Type: string
shelfmark2_docker_log_driver:

shelfmark_role_docker_log_optionsshelfmark2_docker_log_options

# Type: dict
shelfmark_role_docker_log_options:

# Type: dict
shelfmark2_docker_log_options:

shelfmark_role_docker_oom_killershelfmark2_docker_oom_killer

# Type: bool (true/false)
shelfmark_role_docker_oom_killer:

# Type: bool (true/false)
shelfmark2_docker_oom_killer:

shelfmark_role_docker_oom_score_adjshelfmark2_docker_oom_score_adj

# Type: int
shelfmark_role_docker_oom_score_adj:

# Type: int
shelfmark2_docker_oom_score_adj:

shelfmark_role_docker_output_logsshelfmark2_docker_output_logs

# Type: bool (true/false)
shelfmark_role_docker_output_logs:

# Type: bool (true/false)
shelfmark2_docker_output_logs:

shelfmark_role_docker_pausedshelfmark2_docker_paused

# Type: bool (true/false)
shelfmark_role_docker_paused:

# Type: bool (true/false)
shelfmark2_docker_paused:

shelfmark_role_docker_recreateshelfmark2_docker_recreate

# Type: bool (true/false)
shelfmark_role_docker_recreate:

# Type: bool (true/false)
shelfmark2_docker_recreate:

shelfmark_role_docker_restart_retriesshelfmark2_docker_restart_retries

# Type: int
shelfmark_role_docker_restart_retries:

# Type: int
shelfmark2_docker_restart_retries:

shelfmark_role_docker_stop_signalshelfmark2_docker_stop_signal

# Type: string
shelfmark_role_docker_stop_signal:

# Type: string
shelfmark2_docker_stop_signal:

shelfmark_role_docker_stop_timeoutshelfmark2_docker_stop_timeout

# Type: int
shelfmark_role_docker_stop_timeout:

# Type: int
shelfmark2_docker_stop_timeout:

Other Options

shelfmark_role_docker_capabilitiesshelfmark2_docker_capabilities

# Type: list
shelfmark_role_docker_capabilities:

# Type: list
shelfmark2_docker_capabilities:

shelfmark_role_docker_cgroup_parentshelfmark2_docker_cgroup_parent

# Type: string
shelfmark_role_docker_cgroup_parent:

# Type: string
shelfmark2_docker_cgroup_parent:

shelfmark_role_docker_commandsshelfmark2_docker_commands

# Type: list
shelfmark_role_docker_commands:

# Type: list
shelfmark2_docker_commands:

shelfmark_role_docker_create_timeoutshelfmark2_docker_create_timeout

# Type: int
shelfmark_role_docker_create_timeout:

# Type: int
shelfmark2_docker_create_timeout:

shelfmark_role_docker_entrypointshelfmark2_docker_entrypoint

# Type: string
shelfmark_role_docker_entrypoint:

# Type: string
shelfmark2_docker_entrypoint:

shelfmark_role_docker_env_fileshelfmark2_docker_env_file

# Type: string
shelfmark_role_docker_env_file:

# Type: string
shelfmark2_docker_env_file:

shelfmark_role_docker_labelsshelfmark2_docker_labels

# Type: dict
shelfmark_role_docker_labels:

# Type: dict
shelfmark2_docker_labels:

shelfmark_role_docker_labels_use_commonshelfmark2_docker_labels_use_common

# Type: bool (true/false)
shelfmark_role_docker_labels_use_common:

# Type: bool (true/false)
shelfmark2_docker_labels_use_common:

shelfmark_role_docker_read_onlyshelfmark2_docker_read_only

# Type: bool (true/false)
shelfmark_role_docker_read_only:

# Type: bool (true/false)
shelfmark2_docker_read_only:

shelfmark_role_docker_runtimeshelfmark2_docker_runtime

# Type: string
shelfmark_role_docker_runtime:

# Type: string
shelfmark2_docker_runtime:

shelfmark_role_docker_sysctlsshelfmark2_docker_sysctls

# Type: list
shelfmark_role_docker_sysctls:

# Type: list
shelfmark2_docker_sysctls:

shelfmark_role_docker_ulimitsshelfmark2_docker_ulimits

# Type: list
shelfmark_role_docker_ulimits:

# Type: list
shelfmark2_docker_ulimits:

shelfmark_role_autoheal_enabledshelfmark2_autoheal_enabled

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
shelfmark_role_autoheal_enabled: true

# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
shelfmark2_autoheal_enabled: true

shelfmark_role_depends_onshelfmark2_depends_on

# List of container dependencies that must be running before containers start
# Type: string
shelfmark_role_depends_on: ""

# List of container dependencies that must be running before containers start
# Type: string
shelfmark2_depends_on: ""

shelfmark_role_depends_on_delayshelfmark2_depends_on_delay

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
shelfmark_role_depends_on_delay: "0"

# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
shelfmark2_depends_on_delay: "0"

shelfmark_role_depends_on_healthchecksshelfmark2_depends_on_healthchecks

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

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

shelfmark_role_diun_enabledshelfmark2_diun_enabled

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
shelfmark_role_diun_enabled: true

# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
shelfmark2_diun_enabled: true

shelfmark_role_dns_enabledshelfmark2_dns_enabled

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
shelfmark_role_dns_enabled: true

# Enable or disable automatic DNS record creation for containers
# Type: bool (true/false)
shelfmark2_dns_enabled: true

shelfmark_role_docker_controllershelfmark2_docker_controller

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
shelfmark_role_docker_controller: true

# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
shelfmark2_docker_controller: true

shelfmark_role_docker_networks_alias_customshelfmark2_docker_networks_alias_custom

# Type: list
shelfmark_role_docker_networks_alias_custom:

# Type: list
shelfmark2_docker_networks_alias_custom:

shelfmark_role_docker_volumes_downloadshelfmark2_docker_volumes_download

# Type: bool (true/false)
shelfmark_role_docker_volumes_download:

# Type: bool (true/false)
shelfmark2_docker_volumes_download:

shelfmark_role_themepark_addonsshelfmark2_themepark_addons

# Type: string
shelfmark_role_themepark_addons:

# Type: string
shelfmark2_themepark_addons:

shelfmark_role_themepark_appshelfmark2_themepark_app

# Type: string
shelfmark_role_themepark_app:

# Type: string
shelfmark2_themepark_app:

shelfmark_role_themepark_themeshelfmark2_themepark_theme

# Type: string
shelfmark_role_themepark_theme:

# Type: string
shelfmark2_themepark_theme:

shelfmark_role_traefik_api_middlewareshelfmark2_traefik_api_middleware

# Type: string
shelfmark_role_traefik_api_middleware:

# Type: string
shelfmark2_traefik_api_middleware:

shelfmark_role_traefik_api_middleware_httpshelfmark2_traefik_api_middleware_http

# Type: string
shelfmark_role_traefik_api_middleware_http:

# Type: string
shelfmark2_traefik_api_middleware_http:

shelfmark_role_traefik_autodetect_enabledshelfmark2_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
shelfmark_role_traefik_autodetect_enabled: false

# Enable Traefik autodetect middleware for containers
# Type: bool (true/false)
shelfmark2_traefik_autodetect_enabled: false

shelfmark_role_traefik_crowdsec_enabledshelfmark2_traefik_crowdsec_enabled

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
shelfmark_role_traefik_crowdsec_enabled: false

# Enable CrowdSec middleware for containers
# Type: bool (true/false)
shelfmark2_traefik_crowdsec_enabled: false

shelfmark_role_traefik_error_pages_enabledshelfmark2_traefik_error_pages_enabled

# Enable custom error pages middleware for containers
# Type: bool (true/false)
shelfmark_role_traefik_error_pages_enabled: false

# Enable custom error pages middleware for containers
# Type: bool (true/false)
shelfmark2_traefik_error_pages_enabled: false

shelfmark_role_traefik_gzip_enabledshelfmark2_traefik_gzip_enabled

# Enable gzip compression middleware for containers
# Type: bool (true/false)
shelfmark_role_traefik_gzip_enabled: false

# Enable gzip compression middleware for containers
# Type: bool (true/false)
shelfmark2_traefik_gzip_enabled: false

shelfmark_role_traefik_middleware_httpshelfmark2_traefik_middleware_http

# Type: string
shelfmark_role_traefik_middleware_http:

# Type: string
shelfmark2_traefik_middleware_http:

shelfmark_role_traefik_middleware_http_api_insecureshelfmark2_traefik_middleware_http_api_insecure

# Type: bool (true/false)
shelfmark_role_traefik_middleware_http_api_insecure:

# Type: bool (true/false)
shelfmark2_traefik_middleware_http_api_insecure:

shelfmark_role_traefik_middleware_http_insecureshelfmark2_traefik_middleware_http_insecure

# Type: bool (true/false)
shelfmark_role_traefik_middleware_http_insecure:

# Type: bool (true/false)
shelfmark2_traefik_middleware_http_insecure:

shelfmark_role_traefik_priorityshelfmark2_traefik_priority

# Type: string
shelfmark_role_traefik_priority:

# Type: string
shelfmark2_traefik_priority:

shelfmark_role_traefik_robot_enabledshelfmark2_traefik_robot_enabled

# Enable robots.txt middleware for containers
# Type: bool (true/false)
shelfmark_role_traefik_robot_enabled: true

# Enable robots.txt middleware for containers
# Type: bool (true/false)
shelfmark2_traefik_robot_enabled: true

shelfmark_role_traefik_tailscale_enabledshelfmark2_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
shelfmark_role_traefik_tailscale_enabled: false

# Enable Tailscale-specific Traefik configuration for containers
# Type: bool (true/false)
shelfmark2_traefik_tailscale_enabled: false

shelfmark_role_traefik_wildcard_enabledshelfmark2_traefik_wildcard_enabled

# Enable wildcard certificate for containers
# Type: bool (true/false)
shelfmark_role_traefik_wildcard_enabled: true

# Enable wildcard certificate for containers
# Type: bool (true/false)
shelfmark2_traefik_wildcard_enabled: true

shelfmark_role_web_api_http_portshelfmark2_web_api_http_port

# Type: string (quoted number)
shelfmark_role_web_api_http_port:

# Type: string (quoted number)
shelfmark2_web_api_http_port:

shelfmark_role_web_api_http_schemeshelfmark2_web_api_http_scheme

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

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

shelfmark_role_web_api_http_serverstransportshelfmark2_web_api_http_serverstransport

# Type: dict/omit
shelfmark_role_web_api_http_serverstransport:

# Type: dict/omit
shelfmark2_web_api_http_serverstransport:

shelfmark_role_web_api_portshelfmark2_web_api_port

# Type: string (quoted number)
shelfmark_role_web_api_port:

# Type: string (quoted number)
shelfmark2_web_api_port:

shelfmark_role_web_api_schemeshelfmark2_web_api_scheme

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

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

shelfmark_role_web_api_serverstransportshelfmark2_web_api_serverstransport

# Type: dict/omit
shelfmark_role_web_api_serverstransport:

# Type: dict/omit
shelfmark2_web_api_serverstransport:

shelfmark_role_web_fqdn_overrideshelfmark2_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
shelfmark_role_web_fqdn_override:

# Override the Traefik fully qualified domain name (FQDN) for containers
# Type: list
shelfmark2_web_fqdn_override:

Example Override

shelfmark_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "shelfmark2.{{ user.domain }}"
  - "shelfmark.otherdomain.tld"

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

Example Override

shelfmark2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "shelfmark2.{{ user.domain }}"
  - "shelfmark.otherdomain.tld"

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

shelfmark_role_web_host_overrideshelfmark2_web_host_override

# Override the Traefik web host configuration for containers
# Type: string
shelfmark_role_web_host_override:

# Override the Traefik web host configuration for containers
# Type: string
shelfmark2_web_host_override:

Example Override

shelfmark_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'shelfmark2.' + user.domain }}`)"

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

Example Override

shelfmark2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'shelfmark2.' + user.domain }}`)"

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

shelfmark_role_web_http_portshelfmark2_web_http_port

# Type: string (quoted number)
shelfmark_role_web_http_port:

# Type: string (quoted number)
shelfmark2_web_http_port:

shelfmark_role_web_http_schemeshelfmark2_web_http_scheme

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

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

shelfmark_role_web_http_serverstransportshelfmark2_web_http_serverstransport

# Type: dict/omit
shelfmark_role_web_http_serverstransport:

# Type: dict/omit
shelfmark2_web_http_serverstransport:

shelfmark_role_web_schemeshelfmark2_web_scheme

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
shelfmark_role_web_scheme:

# URL scheme to use for web access to containers
# Type: string ("http"/"https")
shelfmark2_web_scheme:

shelfmark_role_web_serverstransportshelfmark2_web_serverstransport

# Type: dict/omit
shelfmark_role_web_serverstransport:

# Type: dict/omit
shelfmark2_web_serverstransport: