Skip to content

Example Overrides

Description / nameInput element
Your domain name
Name of the role
Instance suffix
Name of your custom subdomain

Recommended or frequently requested configuration patterns.

Tags

##### Enabling different media servers, downloaders and indexers #####
media_servers_enabled: ["emby"]
download_clients_enabled: ["deluge", "nzbget"]
download_indexers_enabled: ["prowlarr"]

#### Customize the saltbox tag (sb install saltbox) - No sandbox roles
saltbox_roles: ["media_server", "download_clients", "download_indexers", "autoscan", "tautulli", "seerr", "portainer", "organizr", "sonarr", "radarr", "lidarr", "iperf3", "glances", "btop"]

#### Customize the mediabox tag (sb install mediabox) - No sandbox roles
mediabox_roles: ["media_server", "autoscan", "iperf3", "glances", "btop"]

#### Customize the feeerbox tag (sb install feederbox) - No sandbox roles
feederbox_roles: ["download_clients", "download_indexers", "portainer", "organizr", "sonarr", "radarr", "iperf3", "glances", "btop"]

#### Customize the sandbox-roles tag (sb install sandbox-roles)
sandbox_roles: ["jellyseerr", "jellystat"]

Routing

#### Make Organizr available only at the base domain ####
organizr_role_web_subdomain: ""

#### Make Seerr available only at `requests.yourdomain.tld` ####
seerr_role_web_subdomain: "requests"

#### Make Seerr available at a different base domain ####
seerr_role_web_domain: "example.com" # (1)!

  1. Combined with the above subdomain override, this sets all Seerr instances without instance-level domain or subdomain overrides to requests.example.com.

    Be aware that multiple instances cannot have the same FQDN.

#### Make specified Seerr instance available at a different base domain ####
seerr4k_web_domain: "bing.com" # (1)!
  1. Combined with the above subdomain override, this sets this specific Seerr instance to requests.bing.com, always superseding the role-level domain value.

Extra DNS records for the following examples will not be set up by Saltbox. Your options: create them manually, run DDNS (Cloudflare only), or use a wildcard DNS record.

#### Make Organizr available at `organizr.yourdomain.tld`, `yourdomain.tld` and `example.com` ####
organizr_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "{{ organizr_role_web_domain }}"
  - "example.com"

#### Make specified Seerr instance available at both `seerr.yourdomain.tld` and `requests.yourdomain.tld` ####
seerr_web_fqdn_override:
  - "{{ traefik_host }}"
  - "requests.{{ seerr_role_web_domain }}"

#### Disable Cloudflare proxy per-app ####
sonarr_dns_proxy: false

Docker Global

##### Container overrides ####
plex_docker_image_pull: false # (1)!
plex_docker_image_tag: beta # (2)!

  1. Can be used to version-pin the image to the current container's version (as long as the image is never pulled by other means)

  2. Will version-lock if the tag designates a specific version.

#### Examples of specified container images: ####
radarr_role_docker_image_tag: nightly
sonarr_role_docker_image_tag: nightly
petio_role_docker_image_tag: nightly

#### Specify Seerr DNS server - can fix name resolution issue with TMDb ####
seerr_role_docker_dns_servers:
  - 8.8.8.8
  - 8.8.4.4

Role-specific

#### Plex Ports for private access ####
#### To avoid port conflicts, do not enable on more than one instance ####
plex_open_main_ports: true
plex_open_local_ports: true

#### Configure Sonarr 4k/Radarr 4k Instance Name (assumed instances defined as `sonarr4k` and `radarr4k`)
sonarr4k_docker_envs_custom:
  SONARR__APP__INSTANCENAME: "Sonarr4k" # Must start or end with the word Sonarr
radarr4k_docker_envs_custom:
  RADARR__APP__INSTANCENAME: "Radarr4k" # Must start or end with the word Radarr

#### Bandwidth and rate limiting  ####
#### along with multiple env vars ####
transfer_role_docker_envs_custom:
  MAX_UPLOAD_SIZE: "104857546"
  RATE_LIMIT: "60"

#### Add custom aliases to bash shell ####
#### Note the syntax - a pipe and two space indentation for the contents ####
shell_bash_bashrc_block_custom: |
  alias sbu='sb update'
  alias sbi='sb install'
  sb-upgrade() { sb install saltbox,sandbox-roles "$@" }

#### Add custom aliases to zsh shell ###
#### Note the syntax - a pipe and two space indentation for the contents ####
shell_zsh_zshrc_block_custom: |
  alias sbu='sb update'
  alias sbi='sb install'
  sb-upgrade() { sb install saltbox,sandbox-roles "$@" }