Accounts and Settings¶
| Description / name | Input element |
|---|---|
| Your domain name |
Warning
This is a reference discussing an aspect of the install process. If you are looking for the steps to follow to install, they are here.
On this page, we break down the options available in the following files:
/srv/git/saltbox/adv_settings.yml
IMPORTANT: If you make changes to values in these files, you will have to run the relevant role(s) to make them take effect. For example, if you change traefik-related settings, you will need to rerun the traefik tag for them to take effect. The only thing that looks at these settings files is the Ansible script.
Validation¶
As of the Go-rewritten sb CLI introduced in late 2025, configuration files are checked for compliance and must pass for commands such as sb update to execute. You can also run this on demand with sb validate-config. The validation checks include:
- Required files exist
- Valid YAML syntax
- No duplicate settings
- Correct value formats (emails, passwords, paths, etc.)
- All required fields filled in
- API credentials work (Cloudflare, Docker Hub, etc.)
- Settings are logically consistent
If validation fails, the error messages will indicate which file and setting have the problem. You'll need to review the error output, understand what needs to be corrected, and edit the configuration files accordingly before trying again.
Options in accounts.yml¶
Note: There must always be a space between the key and the value in YAML files. key: value NOT key:value
-
apprise¶Apprise notification URL
This parameter is optional. Information about constructing the URL can be found here. This will be used to send out messages during certain tasks (e.g. backup).
This parameter is not nested:
apprise: somescheme://something_else_here/perhaps_a_tokennot
apprise: somescheme://something_else_here/perhaps_a_token -
cloudflare.api¶Preferred Global API Key.
-
cloudflare.email¶E-mail address required with the Global API Key.
These parameters are optional. Default is blank. Configure
scoped_token, or configureapiandemailtogether, to enable Cloudflare automation. The two authentication modes cannot be combined. Leave all three blank to disable Cloudflare functions. Cloudflare does not support all top-level domains though its API. Refer to this page. As of 2022/11/03: "DNS API cannot be used for domains with .cf, .ga, .gq, .ml, or .tk TLDs." -
cloudflare.scoped_token¶Supported alternative Cloudflare account-owned or user-owned API token. Follow the Cloudflare credential instructions for the exact dashboard sections, permissions, and zone scope.
-
dockerhub.user¶Docker Hub username.
-
dockerhub.token¶Docker Hub access token.
Note that this is a Docker Hub token, not your Docker Hub password. You create one of these in the security tab of your account settings at dockerhub, and it will look something like:
dckr_pat_EZ-YVvzrb_OzZyToNyGeEzErBiLlThis parameter is optional. Entering Dockerhub credentials increases the number of images one can pull.
-
user.name¶Username for the server.
This parameter is required. If user account with this name does not already exist, it will be created during install. Also used to create first-time logins for various apps. Default is
seed. -
user.pass¶Password for the user account and for misc apps.
This parameter is required. Minimum 12 characters. Sets password for the server's user account when creating a new account. This will not change the password of an existing account. Also used to create first-time logins for NZBGet, qbittorrent, NZBHydra2, and potentially other apps. Don't leave it blank, even if you are planning to use SSH keys to connect to your box. This user and password are used to set up authentication for some applications in this repo and Sandbox, and a blank password may cause trouble there. Don't leave it as
password1234. See the password considerations below. Relevant XKCD -
user.domain¶Domain name for the Saltbox server.
This parameter is required. If you don't have one, see here. This should be the domain "below" the saltbox subdomains. For example, if you want to access Sonarr at "sonarr.yourdomain.tld", enter "yourdomain.tld". If you want "sonarr.foo.yourdomain.tld", enter "foo.yourdomain.tld".
-
user.email¶E-mail address.
This parameter is required if you're using the reverse proxy. This is used for the Let's Encrypt SSL certificates. It does not have to be an email address at the domain above.
-
user.ssh_key¶SSH Key
This parameter is optional. This is used to provision a SSH key in your user's
authorized_keysfile This parameter accepts either the public key or a GitHub url (i.e. https://github.com/charlie.keys) which will pull the keys you have added to your GitHub account.
Options in settings.yml¶
Note: Having {{ user }} in the path tells Ansible to fill in the username, automatically. You do not need to fill in your actual username.
Note: There must always be a space between the key and the value in YAML files. key: value NOT key:value
-
authelia.master¶Is this the master machine in a split feeder/media setup?
-
authelia.subdomain¶Name of the Authelia login page subdomain.
Default is
login. -
downloads¶Where downloads go.
Default is
/mnt/unionfs/downloads. -
rclone.enabled¶Use this to toggle Rclone related deployments like mounts and cloudplow.
-
rclone.remotes¶This variable takes a list of dictionaries formatted like the example. Add as many remotes as you wish, like this:
rclone: enabled: yes remotes: - remote: google settings: mount: yes template: google ... - remote: dropbox settings: mount: no template: dropbox ... - remote: minio settings: mount: yes template: /opt/mount-templates/custom/myminio.j2 ...-
remote¶The name of the rclone remote for this mount. You can also specify a path to use for the remote.
remote: "google:Media"orremote: "my-sftp:/path/to/my/files"Quotes are important. -
settings.enable_refresh¶Toggles whether this remote required a refresh service to look for new files (for example, an
sftpremote). -
settings.mount¶Toggles whether you want this remote mounted in the file system.
-
settings.template¶The name of the template you want to use for the mount. Currently Saltbox supports 4 options:
google,dropbox,sftpand a path to a file ("/opt/mount-templates/remote.j2") containing either jinja2 template or an actual copy of a systemd service file. A community repo is maintained of user submitted mount options which can be referenced via path (i.e./opt/mount-templates/generic.j2.) We recommend saving your own custom templates/services in/opt/mount-templates/customto ensure they are backed up and not subject to being overwritten by the repo. -
settings.union¶Toggles whether you want to add this remote mount to
/mnt/unionfs. This requires thatmountbe enabled. -
settings.upload¶Toggles whether you intend to upload to this remote using Cloudplow.
-
settings.upload_from¶The local path Cloudplow will use to upload from if the remote was upload enabled.
-
settings.vfs_cache.enabled¶Toggle for using Rclone VFS file cache.
-
settings.vfs_cache.max_age¶Defines the max age of files in the cache.
-
settings.vfs_cache.size¶Defines the max size of the cache. The cache can grow above this value in actual usage (polls the cache once a minute) so leave some headroom when using this.
-
-
rclone.version¶Rclone version that is installed by Saltbox. Choices are
latest,current,beta, or a specific version number (e.g.1.42). Default islatest. -
shell¶Type of shell to use.
Choices are
bashorzsh. Default isbash. -
transcodes¶Path of temporary transcoding files.
Default is
"/mnt/local/transcodes".Note: It is recommended to not use
/tmpor/dev/shmas a transcode location because the paths are cleared on reboots, causing Docker to create the folder as root and Plex transcoder to crash. Another reason why not to: https://forums.plex.tv/discussion/comment/1502936/#Comment_1502936.
Options in adv_settings.yml¶
Note: There must always be a space between the key and the value in YAML files. key: value NOT key:value
-
dns.ipv4¶Enable/disable IPv4 configuration.
Default is
yes. -
dns.ipv6¶Enable/disable IPv6 configuration.
Default is
no. -
dns.proxied¶Controls whether Cloudflare records should be "proxied" or "DNS only".
Default is
no.This is a global flag; if you want to override this for individual apps you can do so in the inventory.
-
docker.json_driver¶make docker logs available as JSON
-
gpu.intel¶Should system be set up for Intel GPU?
Default is
yes. -
mounts.ipv4_only¶Should Rclone use IPv4 only?
Default is
no. -
system.timezone¶Timezone to use on the server.
Default is
auto, which will pick the timezone based on geolocation of the server. Enter a "TZ database name" as shown in this table. For example, "America/Costa_Rica".timedatectl list-timezonesat your server's command prompt will also list the options. -
traefik.cert.additional_domains¶Additional wildcard certificate bases managed by Traefik. Enter base domains such as
home.example.co.uk; Traefik requests both the base and*.home.example.co.uk. This requires DNS certificate validation. Cloudflare-backed domains must belong to a zone accessible to the configured credentials.Default is
[]. -
traefik.cert.http_validation¶Use HTTP (HTTP-01) certificate validation method. Required when you are not using one of the supported DNS validation providers.
Default is
no. -
traefik.cert.zerossl¶Use ZeroSSL instead of Let's Encrypt for generation of certificates.
Default is
no. -
traefik.error_pages¶enable styled error pages.
Default is
no. See here for configuration details. -
traefik.hsts¶enable HSTS.
Default is
no. -
traefik.metrics¶enable metrics subdomain.
Default is
no. -
traefik.provider¶DNS provider.
Default is
cloudflare. -
traefik.subdomain.dash¶traefik dashboard subdomain.
Default is
dash. -
traefik.subdomain.metrics¶traefik metrics subdomain.
Default is
metrics.
Password considerations¶
Your chosen password must have a minimum of 12 characters.
These are a YAML files, and values you enter here are subject to YAML file format rules. If you use special characters in your password, wrap the password in quotes (or escape the characters correctly, if you are familiar with that concept). It would be easiest to avoid using quote characters themselves within your password.
For example:
pass: MyP4s5w0rd1s4w350m3pass: "!@#$%^&*"(){pass: multiple words work fine unquotedpass: "or quote them to be safe"