Saltbox Mod¶

Overview¶

Clones the saltbox_mod repository.

sb install saltbox-mod

Info

Variables can be overridden in /srv/git/saltbox/inventories/host_vars/localhost.yml.

Example Override

saltbox_mod_repo: "custom_value"

GeneralGlobal Override Options

saltbox_mod_repo

# Type: string
saltbox_mod_repo: "https://github.com/saltyorg/saltbox_mod.git"

saltbox_mod_branch

# Type: string
saltbox_mod_branch: "master"

saltbox_mod_force_overwrite

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

saltbox_mod_role_autoheal_enabled

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

saltbox_mod_role_depends_on

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

saltbox_mod_role_depends_on_delay

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

saltbox_mod_role_depends_on_healthchecks

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

saltbox_mod_role_diun_enabled

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

saltbox_mod_role_dns_enabled

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

saltbox_mod_role_docker_controller

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

saltbox_mod_role_traefik_autodetect_enabled

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

saltbox_mod_role_traefik_crowdsec_enabled

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

saltbox_mod_role_traefik_error_pages_enabled

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

saltbox_mod_role_traefik_gzip_enabled

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

saltbox_mod_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
saltbox_mod_role_traefik_middleware_http_api_insecure:

saltbox_mod_role_traefik_middleware_http_insecure

# Type: bool (true/false)
saltbox_mod_role_traefik_middleware_http_insecure:

saltbox_mod_role_traefik_robot_enabled

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

saltbox_mod_role_traefik_tailscale_enabled

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

saltbox_mod_role_traefik_wildcard_enabled

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

saltbox_mod_role_web_fqdn_override

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

Example Override

saltbox_mod_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "saltbox_mod2.{{ user.domain }}"
  - "saltbox_mod.otherdomain.tld"

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

saltbox_mod_role_web_host_override

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

Example Override

saltbox_mod_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'saltbox_mod2.' + user.domain }}`)"

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

saltbox_mod_role_web_scheme

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