Autoscan

Description / name	Input element
Your domain name

Overview

Autoscan is the official Saltbox continuation of Cloudbox/autoscan, an open-source tool designed to automatically trigger media scans in media servers like Plex, Emby, and Jellyfin when new content is added.

Manual

Releases

Community

---

Deployment

sb install autoscan

Usage

Manual scan URL: https://autoscan.iYOUR_DOMAIN_NAMEi/triggers/manual.

Basics

The Plex API is known to have trouble when scanning items into empty libraries. You should add at least one item to each Plex library and perform a manual scan as a first step. If you don't do this, things may not get scanned into Plex in response to autoscan's requests.

The Saltbox Autoscan role will attempt to partially configure your autoscan config file located at /opt/autoscan/config.yml. You should refer to the documentation and adjust this file as suits your own needs. The config generated is very minimal. a-train is now replacing the bernard trigger.

The generated config file will look something like this:

# <- processor ->

# Override the minimum age before a scan request is sent to the target (Default 10m):
minimum-age: 10m

# Override the delay between processed scans (Default 5s):
scan-delay: 5s

# Set anchor files for remote storage. If these are missing no scans will be sent to the target to avoid files being trashed when a mount fails
anchors:
  - /mnt/unionfs/mounted.bin

# <- triggers ->

# Optionally, protect your webhooks with authentication
authentication:
  username: USERNAME_FROM_SETTINGS
  password: PASSWORD_FROM_SETTINGS

# Port for Autoscan webhooks to listen on
port: 3030

triggers:
  a-train:
      priority: 5
      rewrite: # Global rewrites
        - from: ^/Media/
          to: /mnt/unionfs/Media/

  inotify:
    - priority: 0

      # Filter with regular expressions
      include:
        - ^/mnt/unionfs/Media/
      exclude:
        - '\.(srt|pdf)$'

      # rewrite inotify path to unified filesystem
      rewrite:
        - from: ^/mnt/local/Media/
          to: /mnt/unionfs/Media/

      # Local filesystem paths to monitor
      paths:
        - path: /mnt/local/Media

  sonarr:
    - name: sonarr # /triggers/sonarr
      priority: 2

  radarr:
    - name: radarr # /triggers/radarr
      priority: 2

  lidarr:
    - name: lidarr # /triggers/lidarr
      priority: 1

# <- targets ->

targets:
  plex:
    - url: https://plex.yourdomain.tld # plex
      token: YOUR_PLEX_TOKEN

Then edit the anchors section:

anchors:
  - /mnt/unionfs/mounted.bin

To reflect your own configuration.

YOU PROBABLY NEED TO CREATE THIS FILE OR FILES YOURSELF. The regular saltbox install does not do it for you.

If you went through the OPTIONAL google-drive rclone setup process, these files did get created for you, and you'll need to enter something like:

anchors:
  - /mnt/unionfs/bvoiwepopz-movies_mounted.bin
  - /mnt/unionfs/bvoiwepopz-tv_mounted.bin
  - /mnt/unionfs/bvoiwepopz-music_mounted.bin
  - /mnt/unionfs/bvoiwepopz-anime_mounted.bin
...

You should enter the entire list of bin files that were created by the automated script here.

If you didn't go through that process, use:

rclone touch NAME_OF_CLOUD_REMOTE:mounted.bin

To create one of these files on each distinct element of cloud storage. If you're using Dropbox, there is just one. If you have eleven OneDrive mounts, you need to create eleven of these.

Do this on each rclone remote that you have mounted. For example, if you're using box.com and have three remotes (box_remote, box_crypt, chunker_remote), run this command on the last one, chunker_remote, since that';s the remote that you are mounting.

Once you've done that, verify that they show up in the union mount with:

ls /mnt/unionfs/*.bin

then enter that list of files into the autoscan config as shown.

Everything else should be ready to go for standard usage.

What are those mount files?

Autoscan uses these to determine if your cloud storage is mounted and visible; if autoscan can't see these files, no scans will be sent to Plex since doing so would empty your library as Plex removed all the files it can no longer see (assuming that "empty trash on scan" is enabled).

There's nothing special about the contents of these files; autoscan just needs to see that they exist. Typically they are empty.

If you went through the saltbox rclone setup, these files got created for you.

Do I really need to include all seven or eight or however many?

Strictly speaking, no, not with the way saltbox sets up the mounts. All those shared drives are part of a union remote, and the union remote is mounted, so there's really no possibility that some of those files would be present but not others. Any one of them is probably sufficient.

However, there's no reason *not* to include them all as you can grab the list with a single command and a copy-paste. You save a few keystrokes by not including all of them (you don't have to copy-paste ` - ` in front of those few lines), but in thinking about it at all you've spent the same amount of time. Reading this question and answer have taken more time than it would have taken to include all of them as a belt-and-suspenders measure.

Is there something magic about the name `mounted.bin`?

No. These files can be named whatever you want. If you don't like `mounted.bin` and woudl rather use `black.sabbath` or whatever, go ahead. Autoscan is just going to verify that the file you specify exists so autoscan knows it is safe to send scans to Plex.

You will set up the webhooks for radarr/sonarr/lidarr as part of their setup, so they aren't discussed here

A-Train

Autoscan can monitor Google Drive changes via a trigger called "Bernard". The code behind Bernard can sometimes get out of sync with the state of Google Drive and miss things, so now we are using A-Train.

IMPORTANT: You only need to set this up if you are planning to add media to Google Drive directly, outside the usual Radarr/Sonarr channels, or if you are monitoring a Shared Drive where new media appears outside those channels. If you are not planning to do that, you can skip this portion of the setup.

IMPORTANT: A-Train does not support anything other than Google Drive, as it uses the Google Drive API to do its work.

"A-Train" is a rewrite of the Bernard concepts, and is currently available as a second docker image as part of Sandbox. It will likely be integrated into autoscan at some point in the future.

Warning

A-Train supports only unencrypted Google Shared Drives authenticated via Service Accounts. It does not support encrypted drives, My Drive, or authentication via Client ID/Secret or other means.

Enter the names of the remotes you want to monitor in the Inventory. The Remotes can be either drive remotes or union remotes. You may use rclone listremotes to get your drive remotes.

Example:

a_train:
  remotes: ["bvoiwepopz-Movies", "bvoiwepopz-TV"]

or

a_train:
  remotes: ["google"]

Run the a-train tag to create the container:

sb install sandbox-a-train

Copy one of your service account files from its current location to /opt/a-train/account.json. Remember to rename your service account file to "account.json".

Example:

cp /opt/sa/all/160.json /opt/a-train/account.json

Run the autoscan tag to rebuild the container:

sb install autoscan

Run the a-train tag to rebuild the container:

sb install sandbox-a-train

Bernard

IMPORTANT: Bernard does not support anything other than Google Drive, as it uses the Google Drive API to do its work.

If for some reason you still wanted to use Bernard, it would look like this:

triggers:
  bernard:
    - account: /config/sa.json # Path inside the container where your SA is located
      cron: "*/5 * * * *" # every five minutes (the "" are important)
      priority: 0
      drives:
        - id: drive_id #Friendly title
      # Rewrite gdrive to the local filesystem
      rewrite:
        - from: ^/Media/
          to: /mnt/unionfs/Media/
      # Filter with regular expressions
      include:
        - ^/mnt/unionfs/Media/
      exclude:
        - '\.srt$'

Further documentation:

• A-Train Docker page

• A-Train initial documentation

Next

Are you Setting Saltbox up for the first time?

Continue to SABnzbd

Role Defaults

Variables can be customized using the Inventory. (1)

1. This role supports multiple instances via autoscan_instances.

   Example override

   Role-scopedInstance-scoped

   autoscan_role_web_subdomain: "custom"
   

   Applies to all instances of autoscan

   autoscan2_web_subdomain: "custom2"
   

   Applies to the instance named autoscan2

   Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

autoscan_instances

# Type: list
autoscan_instances: ["autoscan"]

Example Override

# Type: list
autoscan_instances: ["autoscan", "autoscan2"]

autoscan_role_web_subdomainautoscan2_web_subdomain

# Type: string
autoscan_role_web_subdomain: "{{ autoscan_name }}"

# Type: string
autoscan2_web_subdomain: "{{ autoscan_name }}"

autoscan_role_web_domainautoscan2_web_domain

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

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

autoscan_role_web_portautoscan2_web_port

# Type: string
autoscan_role_web_port: "3030"

# Type: string
autoscan2_web_port: "3030"

autoscan_role_web_urlautoscan2_web_url

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

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

autoscan_role_dns_recordautoscan2_dns_record

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

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

autoscan_role_dns_zoneautoscan2_dns_zone

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

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

autoscan_role_dns_proxyautoscan2_dns_proxy

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

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

autoscan_role_traefik_regex_middleware_stringautoscan2_traefik_regex_middleware_string

# Type: string
autoscan_role_traefik_regex_middleware_string: ",{{ autoscan_name }}-replacepathregex"

# Type: string
autoscan2_traefik_regex_middleware_string: ",{{ autoscan_name }}-replacepathregex"

autoscan_role_traefik_sso_middlewareautoscan2_traefik_sso_middleware

# Type: string
autoscan_role_traefik_sso_middleware: ""

# Type: string
autoscan2_traefik_sso_middleware: ""

autoscan_role_traefik_middleware_defaultautoscan2_traefik_middleware_default

# Type: string
autoscan_role_traefik_middleware_default: "{{ traefik_default_middleware + autoscan_role_traefik_regex_middleware_string }}"

# Type: string
autoscan2_traefik_middleware_default: "{{ traefik_default_middleware + autoscan_role_traefik_regex_middleware_string }}"

autoscan_role_traefik_middleware_customautoscan2_traefik_middleware_custom

# Type: string
autoscan_role_traefik_middleware_custom: ""

# Type: string
autoscan2_traefik_middleware_custom: ""

autoscan_role_traefik_certresolverautoscan2_traefik_certresolver

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

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

autoscan_role_traefik_enabledautoscan2_traefik_enabled

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

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

autoscan_role_traefik_api_enabledautoscan2_traefik_api_enabled

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

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

autoscan_role_traefik_api_endpointautoscan2_traefik_api_endpoint

# Type: string
autoscan_role_traefik_api_endpoint: ""

# Type: string
autoscan2_traefik_api_endpoint: ""

Container

autoscan_role_docker_containerautoscan2_docker_container

# Type: string
autoscan_role_docker_container: "{{ autoscan_name }}"

# Type: string
autoscan2_docker_container: "{{ autoscan_name }}"

Image

autoscan_role_docker_image_pullautoscan2_docker_image_pull

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

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

autoscan_role_docker_image_repoautoscan2_docker_image_repo

# Type: string
autoscan_role_docker_image_repo: "saltydk/autoscan"

# Type: string
autoscan2_docker_image_repo: "saltydk/autoscan"

autoscan_role_docker_image_tagautoscan2_docker_image_tag

# Type: string
autoscan_role_docker_image_tag: "latest"

# Type: string
autoscan2_docker_image_tag: "latest"

autoscan_role_docker_imageautoscan2_docker_image

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

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

Envs

autoscan_role_docker_envs_defaultautoscan2_docker_envs_default

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

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

autoscan_role_docker_envs_customautoscan2_docker_envs_custom

# Type: dict
autoscan_role_docker_envs_custom: {}

# Type: dict
autoscan2_docker_envs_custom: {}

Volumes

autoscan_role_docker_volumes_defaultautoscan2_docker_volumes_default

# Type: list
autoscan_role_docker_volumes_default:
  - "{{ autoscan_role_paths_location }}:/config"

# Type: list
autoscan2_docker_volumes_default:
  - "{{ autoscan_role_paths_location }}:/config"

autoscan_role_docker_volumes_customautoscan2_docker_volumes_custom

# Type: list
autoscan_role_docker_volumes_custom: []

# Type: list
autoscan2_docker_volumes_custom: []

Labels

autoscan_role_docker_labels_defaultautoscan2_docker_labels_default

# Type: list
autoscan_role_docker_labels_default:
  - '{ "traefik.http.middlewares.{{ traefik_router }}-replacepathregex.replacepathregex.regex": "^/$" }'
  - '{ "traefik.http.middlewares.{{ traefik_router }}-replacepathregex.replacepathregex.replacement": "/triggers/manual" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.entrypoints": "{{ traefik_entrypoint_websecure }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.service": "{{ traefik_router }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.rule": "Host(`{{ traefik_host }}`) && PathPrefix(`/triggers`)" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.priority": "{{ lookup("role_var", "_traefik_priority", role="autoscan", default="40") }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.tls.certresolver": "{{ lookup("role_var", "_traefik_certresolver", role="autoscan", default=traefik_default_certresolver) }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.tls.options": "securetls@file" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.middlewares": "{{ traefik_middleware | regex_replace(autoscan_role_traefik_regex_middleware_string) }}" }'

# Type: list
autoscan2_docker_labels_default:
  - '{ "traefik.http.middlewares.{{ traefik_router }}-replacepathregex.replacepathregex.regex": "^/$" }'
  - '{ "traefik.http.middlewares.{{ traefik_router }}-replacepathregex.replacepathregex.replacement": "/triggers/manual" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.entrypoints": "{{ traefik_entrypoint_websecure }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.service": "{{ traefik_router }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.rule": "Host(`{{ traefik_host }}`) && PathPrefix(`/triggers`)" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.priority": "{{ lookup("role_var", "_traefik_priority", role="autoscan", default="40") }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.tls.certresolver": "{{ lookup("role_var", "_traefik_certresolver", role="autoscan", default=traefik_default_certresolver) }}" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.tls.options": "securetls@file" }'
  - '{ "traefik.http.routers.{{ traefik_router }}-triggers.middlewares": "{{ traefik_middleware | regex_replace(autoscan_role_traefik_regex_middleware_string) }}" }'

autoscan_role_docker_labels_customautoscan2_docker_labels_custom

# Type: dict
autoscan_role_docker_labels_custom: {}

# Type: dict
autoscan2_docker_labels_custom: {}

Hostname

autoscan_role_docker_hostnameautoscan2_docker_hostname

# Type: string
autoscan_role_docker_hostname: "{{ autoscan_name }}"

# Type: string
autoscan2_docker_hostname: "{{ autoscan_name }}"

Networks

autoscan_role_docker_networks_aliasautoscan2_docker_networks_alias

# Type: string
autoscan_role_docker_networks_alias: "{{ autoscan_name }}"

# Type: string
autoscan2_docker_networks_alias: "{{ autoscan_name }}"

autoscan_role_docker_networks_defaultautoscan2_docker_networks_default

# Type: list
autoscan_role_docker_networks_default: []

# Type: list
autoscan2_docker_networks_default: []

autoscan_role_docker_networks_customautoscan2_docker_networks_custom

# Type: list
autoscan_role_docker_networks_custom: []

# Type: list
autoscan2_docker_networks_custom: []

Restart Policy

autoscan_role_docker_restart_policyautoscan2_docker_restart_policy

# Type: string
autoscan_role_docker_restart_policy: unless-stopped

# Type: string
autoscan2_docker_restart_policy: unless-stopped

State

autoscan_role_docker_stateautoscan2_docker_state

# Type: string
autoscan_role_docker_state: started

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

autoscan_role_docker_blkio_weightautoscan2_docker_blkio_weight

# Type: int
autoscan_role_docker_blkio_weight:

# Type: int
autoscan2_docker_blkio_weight:

autoscan_role_docker_cpu_periodautoscan2_docker_cpu_period

# Type: int
autoscan_role_docker_cpu_period:

# Type: int
autoscan2_docker_cpu_period:

autoscan_role_docker_cpu_quotaautoscan2_docker_cpu_quota

# Type: int
autoscan_role_docker_cpu_quota:

# Type: int
autoscan2_docker_cpu_quota:

autoscan_role_docker_cpu_sharesautoscan2_docker_cpu_shares

# Type: int
autoscan_role_docker_cpu_shares:

# Type: int
autoscan2_docker_cpu_shares:

autoscan_role_docker_cpusautoscan2_docker_cpus

# Type: string
autoscan_role_docker_cpus:

# Type: string
autoscan2_docker_cpus:

autoscan_role_docker_cpuset_cpusautoscan2_docker_cpuset_cpus

# Type: string
autoscan_role_docker_cpuset_cpus:

# Type: string
autoscan2_docker_cpuset_cpus:

autoscan_role_docker_cpuset_memsautoscan2_docker_cpuset_mems

# Type: string
autoscan_role_docker_cpuset_mems:

# Type: string
autoscan2_docker_cpuset_mems:

autoscan_role_docker_kernel_memoryautoscan2_docker_kernel_memory

# Type: string
autoscan_role_docker_kernel_memory:

# Type: string
autoscan2_docker_kernel_memory:

autoscan_role_docker_memoryautoscan2_docker_memory

# Type: string
autoscan_role_docker_memory:

# Type: string
autoscan2_docker_memory:

autoscan_role_docker_memory_reservationautoscan2_docker_memory_reservation

# Type: string
autoscan_role_docker_memory_reservation:

# Type: string
autoscan2_docker_memory_reservation:

autoscan_role_docker_memory_swapautoscan2_docker_memory_swap

# Type: string
autoscan_role_docker_memory_swap:

# Type: string
autoscan2_docker_memory_swap:

autoscan_role_docker_memory_swappinessautoscan2_docker_memory_swappiness

# Type: int
autoscan_role_docker_memory_swappiness:

# Type: int
autoscan2_docker_memory_swappiness:

autoscan_role_docker_shm_sizeautoscan2_docker_shm_size

# Type: string
autoscan_role_docker_shm_size:

# Type: string
autoscan2_docker_shm_size:

Security & Devices

autoscan_role_docker_cap_dropautoscan2_docker_cap_drop

# Type: list
autoscan_role_docker_cap_drop:

# Type: list
autoscan2_docker_cap_drop:

autoscan_role_docker_cgroupns_modeautoscan2_docker_cgroupns_mode

# Type: string
autoscan_role_docker_cgroupns_mode:

# Type: string
autoscan2_docker_cgroupns_mode:

autoscan_role_docker_device_cgroup_rulesautoscan2_docker_device_cgroup_rules

# Type: list
autoscan_role_docker_device_cgroup_rules:

# Type: list
autoscan2_docker_device_cgroup_rules:

autoscan_role_docker_device_read_bpsautoscan2_docker_device_read_bps

# Type: list
autoscan_role_docker_device_read_bps:

# Type: list
autoscan2_docker_device_read_bps:

autoscan_role_docker_device_read_iopsautoscan2_docker_device_read_iops

# Type: list
autoscan_role_docker_device_read_iops:

# Type: list
autoscan2_docker_device_read_iops:

autoscan_role_docker_device_requestsautoscan2_docker_device_requests

# Type: list
autoscan_role_docker_device_requests:

# Type: list
autoscan2_docker_device_requests:

autoscan_role_docker_device_write_bpsautoscan2_docker_device_write_bps

# Type: list
autoscan_role_docker_device_write_bps:

# Type: list
autoscan2_docker_device_write_bps:

autoscan_role_docker_device_write_iopsautoscan2_docker_device_write_iops

# Type: list
autoscan_role_docker_device_write_iops:

# Type: list
autoscan2_docker_device_write_iops:

autoscan_role_docker_devicesautoscan2_docker_devices

# Type: list
autoscan_role_docker_devices:

# Type: list
autoscan2_docker_devices:

autoscan_role_docker_devices_defaultautoscan2_docker_devices_default

# Type: string
autoscan_role_docker_devices_default:

# Type: string
autoscan2_docker_devices_default:

autoscan_role_docker_groupsautoscan2_docker_groups

# Type: list
autoscan_role_docker_groups:

# Type: list
autoscan2_docker_groups:

autoscan_role_docker_privilegedautoscan2_docker_privileged

# Type: bool (true/false)
autoscan_role_docker_privileged:

# Type: bool (true/false)
autoscan2_docker_privileged:

autoscan_role_docker_security_optsautoscan2_docker_security_opts

# Type: list
autoscan_role_docker_security_opts:

# Type: list
autoscan2_docker_security_opts:

autoscan_role_docker_userautoscan2_docker_user

# Type: string
autoscan_role_docker_user:

# Type: string
autoscan2_docker_user:

autoscan_role_docker_userns_modeautoscan2_docker_userns_mode

# Type: string
autoscan_role_docker_userns_mode:

# Type: string
autoscan2_docker_userns_mode:

Networking

autoscan_role_docker_dns_optsautoscan2_docker_dns_opts

# Type: list
autoscan_role_docker_dns_opts:

# Type: list
autoscan2_docker_dns_opts:

autoscan_role_docker_dns_search_domainsautoscan2_docker_dns_search_domains

# Type: list
autoscan_role_docker_dns_search_domains:

# Type: list
autoscan2_docker_dns_search_domains:

autoscan_role_docker_dns_serversautoscan2_docker_dns_servers

# Type: list
autoscan_role_docker_dns_servers:

# Type: list
autoscan2_docker_dns_servers:

autoscan_role_docker_domainnameautoscan2_docker_domainname

# Type: string
autoscan_role_docker_domainname:

# Type: string
autoscan2_docker_domainname:

autoscan_role_docker_exposed_portsautoscan2_docker_exposed_ports

# Type: list
autoscan_role_docker_exposed_ports:

# Type: list
autoscan2_docker_exposed_ports:

autoscan_role_docker_hostsautoscan2_docker_hosts

# Type: dict
autoscan_role_docker_hosts:

# Type: dict
autoscan2_docker_hosts:

autoscan_role_docker_hosts_use_commonautoscan2_docker_hosts_use_common

# Type: bool (true/false)
autoscan_role_docker_hosts_use_common:

# Type: bool (true/false)
autoscan2_docker_hosts_use_common:

autoscan_role_docker_ipc_modeautoscan2_docker_ipc_mode

# Type: string
autoscan_role_docker_ipc_mode:

# Type: string
autoscan2_docker_ipc_mode:

autoscan_role_docker_linksautoscan2_docker_links

# Type: list
autoscan_role_docker_links:

# Type: list
autoscan2_docker_links:

autoscan_role_docker_network_modeautoscan2_docker_network_mode

# Type: string
autoscan_role_docker_network_mode:

# Type: string
autoscan2_docker_network_mode:

autoscan_role_docker_pid_modeautoscan2_docker_pid_mode

# Type: string
autoscan_role_docker_pid_mode:

# Type: string
autoscan2_docker_pid_mode:

autoscan_role_docker_portsautoscan2_docker_ports

# Type: list
autoscan_role_docker_ports:

# Type: list
autoscan2_docker_ports:

autoscan_role_docker_utsautoscan2_docker_uts

# Type: string
autoscan_role_docker_uts:

# Type: string
autoscan2_docker_uts:

Storage

autoscan_role_docker_keep_volumesautoscan2_docker_keep_volumes

# Type: bool (true/false)
autoscan_role_docker_keep_volumes:

# Type: bool (true/false)
autoscan2_docker_keep_volumes:

autoscan_role_docker_mountsautoscan2_docker_mounts

# Type: list
autoscan_role_docker_mounts:

# Type: list
autoscan2_docker_mounts:

autoscan_role_docker_storage_optsautoscan2_docker_storage_opts

# Type: dict
autoscan_role_docker_storage_opts:

# Type: dict
autoscan2_docker_storage_opts:

autoscan_role_docker_tmpfsautoscan2_docker_tmpfs

# Type: list
autoscan_role_docker_tmpfs:

# Type: list
autoscan2_docker_tmpfs:

autoscan_role_docker_volume_driverautoscan2_docker_volume_driver

# Type: string
autoscan_role_docker_volume_driver:

# Type: string
autoscan2_docker_volume_driver:

autoscan_role_docker_volumes_fromautoscan2_docker_volumes_from

# Type: list
autoscan_role_docker_volumes_from:

# Type: list
autoscan2_docker_volumes_from:

autoscan_role_docker_volumes_globalautoscan2_docker_volumes_global

# Type: bool (true/false)
autoscan_role_docker_volumes_global:

# Type: bool (true/false)
autoscan2_docker_volumes_global:

autoscan_role_docker_working_dirautoscan2_docker_working_dir

# Type: string
autoscan_role_docker_working_dir:

# Type: string
autoscan2_docker_working_dir:

Monitoring & Lifecycle

autoscan_role_docker_auto_removeautoscan2_docker_auto_remove

# Type: bool (true/false)
autoscan_role_docker_auto_remove:

# Type: bool (true/false)
autoscan2_docker_auto_remove:

autoscan_role_docker_cleanupautoscan2_docker_cleanup

# Type: bool (true/false)
autoscan_role_docker_cleanup:

# Type: bool (true/false)
autoscan2_docker_cleanup:

autoscan_role_docker_force_killautoscan2_docker_force_kill

# Type: string
autoscan_role_docker_force_kill:

# Type: string
autoscan2_docker_force_kill:

autoscan_role_docker_healthcheckautoscan2_docker_healthcheck

# Type: dict
autoscan_role_docker_healthcheck:

# Type: dict
autoscan2_docker_healthcheck:

autoscan_role_docker_healthy_wait_timeoutautoscan2_docker_healthy_wait_timeout

# Type: int
autoscan_role_docker_healthy_wait_timeout:

# Type: int
autoscan2_docker_healthy_wait_timeout:

autoscan_role_docker_initautoscan2_docker_init

# Type: bool (true/false)
autoscan_role_docker_init:

# Type: bool (true/false)
autoscan2_docker_init:

autoscan_role_docker_kill_signalautoscan2_docker_kill_signal

# Type: string
autoscan_role_docker_kill_signal:

# Type: string
autoscan2_docker_kill_signal:

autoscan_role_docker_log_driverautoscan2_docker_log_driver

# Type: string
autoscan_role_docker_log_driver:

# Type: string
autoscan2_docker_log_driver:

autoscan_role_docker_log_optionsautoscan2_docker_log_options

# Type: dict
autoscan_role_docker_log_options:

# Type: dict
autoscan2_docker_log_options:

autoscan_role_docker_oom_killerautoscan2_docker_oom_killer

# Type: bool (true/false)
autoscan_role_docker_oom_killer:

# Type: bool (true/false)
autoscan2_docker_oom_killer:

autoscan_role_docker_oom_score_adjautoscan2_docker_oom_score_adj

# Type: int
autoscan_role_docker_oom_score_adj:

# Type: int
autoscan2_docker_oom_score_adj:

autoscan_role_docker_output_logsautoscan2_docker_output_logs

# Type: bool (true/false)
autoscan_role_docker_output_logs:

# Type: bool (true/false)
autoscan2_docker_output_logs:

autoscan_role_docker_pausedautoscan2_docker_paused

# Type: bool (true/false)
autoscan_role_docker_paused:

# Type: bool (true/false)
autoscan2_docker_paused:

autoscan_role_docker_recreateautoscan2_docker_recreate

# Type: bool (true/false)
autoscan_role_docker_recreate:

# Type: bool (true/false)
autoscan2_docker_recreate:

autoscan_role_docker_restart_retriesautoscan2_docker_restart_retries

# Type: int
autoscan_role_docker_restart_retries:

# Type: int
autoscan2_docker_restart_retries:

autoscan_role_docker_stop_timeoutautoscan2_docker_stop_timeout

# Type: int
autoscan_role_docker_stop_timeout:

# Type: int
autoscan2_docker_stop_timeout:

Other Options

autoscan_role_docker_capabilitiesautoscan2_docker_capabilities

# Type: list
autoscan_role_docker_capabilities:

# Type: list
autoscan2_docker_capabilities:

autoscan_role_docker_cgroup_parentautoscan2_docker_cgroup_parent

# Type: string
autoscan_role_docker_cgroup_parent:

# Type: string
autoscan2_docker_cgroup_parent:

autoscan_role_docker_commandsautoscan2_docker_commands

# Type: list
autoscan_role_docker_commands:

# Type: list
autoscan2_docker_commands:

autoscan_role_docker_create_timeoutautoscan2_docker_create_timeout

# Type: int
autoscan_role_docker_create_timeout:

# Type: int
autoscan2_docker_create_timeout:

autoscan_role_docker_entrypointautoscan2_docker_entrypoint

# Type: string
autoscan_role_docker_entrypoint:

# Type: string
autoscan2_docker_entrypoint:

autoscan_role_docker_env_fileautoscan2_docker_env_file

# Type: string
autoscan_role_docker_env_file:

# Type: string
autoscan2_docker_env_file:

autoscan_role_docker_labels_use_commonautoscan2_docker_labels_use_common

# Type: bool (true/false)
autoscan_role_docker_labels_use_common:

# Type: bool (true/false)
autoscan2_docker_labels_use_common:

autoscan_role_docker_read_onlyautoscan2_docker_read_only

# Type: bool (true/false)
autoscan_role_docker_read_only:

# Type: bool (true/false)
autoscan2_docker_read_only:

autoscan_role_docker_runtimeautoscan2_docker_runtime

# Type: string
autoscan_role_docker_runtime:

# Type: string
autoscan2_docker_runtime:

autoscan_role_docker_sysctlsautoscan2_docker_sysctls

# Type: list
autoscan_role_docker_sysctls:

# Type: list
autoscan2_docker_sysctls:

autoscan_role_docker_ulimitsautoscan2_docker_ulimits

# Type: list
autoscan_role_docker_ulimits:

# Type: list
autoscan2_docker_ulimits:

autoscan_role_autoheal_enabledautoscan2_autoheal_enabled

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

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

autoscan_role_depends_onautoscan2_depends_on

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

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

autoscan_role_depends_on_delayautoscan2_depends_on_delay

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

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

autoscan_role_depends_on_healthchecksautoscan2_depends_on_healthchecks

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

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

autoscan_role_diun_enabledautoscan2_diun_enabled

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

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

autoscan_role_dns_enabledautoscan2_dns_enabled

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

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

autoscan_role_docker_controllerautoscan2_docker_controller

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

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

autoscan_role_docker_networks_alias_customautoscan2_docker_networks_alias_custom

# Type: list
autoscan_role_docker_networks_alias_custom:

# Type: list
autoscan2_docker_networks_alias_custom:

autoscan_role_docker_volumes_downloadautoscan2_docker_volumes_download

# Type: bool (true/false)
autoscan_role_docker_volumes_download:

# Type: bool (true/false)
autoscan2_docker_volumes_download:

autoscan_role_themepark_addonsautoscan2_themepark_addons

# Type: string
autoscan_role_themepark_addons:

# Type: string
autoscan2_themepark_addons:

autoscan_role_themepark_appautoscan2_themepark_app

# Type: string
autoscan_role_themepark_app:

# Type: string
autoscan2_themepark_app:

autoscan_role_themepark_themeautoscan2_themepark_theme

# Type: string
autoscan_role_themepark_theme:

# Type: string
autoscan2_themepark_theme:

autoscan_role_traefik_api_middlewareautoscan2_traefik_api_middleware

# Type: string
autoscan_role_traefik_api_middleware:

# Type: string
autoscan2_traefik_api_middleware:

autoscan_role_traefik_api_middleware_httpautoscan2_traefik_api_middleware_http

# Type: string
autoscan_role_traefik_api_middleware_http:

# Type: string
autoscan2_traefik_api_middleware_http:

autoscan_role_traefik_autodetect_enabledautoscan2_traefik_autodetect_enabled

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

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

autoscan_role_traefik_crowdsec_enabledautoscan2_traefik_crowdsec_enabled

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

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

autoscan_role_traefik_error_pages_enabledautoscan2_traefik_error_pages_enabled

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

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

autoscan_role_traefik_gzip_enabledautoscan2_traefik_gzip_enabled

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

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

autoscan_role_traefik_middleware_httpautoscan2_traefik_middleware_http

# Type: string
autoscan_role_traefik_middleware_http:

# Type: string
autoscan2_traefik_middleware_http:

autoscan_role_traefik_middleware_http_api_insecureautoscan2_traefik_middleware_http_api_insecure

# Type: bool (true/false)
autoscan_role_traefik_middleware_http_api_insecure:

# Type: bool (true/false)
autoscan2_traefik_middleware_http_api_insecure:

autoscan_role_traefik_middleware_http_insecureautoscan2_traefik_middleware_http_insecure

# Type: bool (true/false)
autoscan_role_traefik_middleware_http_insecure:

# Type: bool (true/false)
autoscan2_traefik_middleware_http_insecure:

autoscan_role_traefik_priorityautoscan2_traefik_priority

# Type: string
autoscan_role_traefik_priority:

# Type: string
autoscan2_traefik_priority:

autoscan_role_traefik_robot_enabledautoscan2_traefik_robot_enabled

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

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

autoscan_role_traefik_tailscale_enabledautoscan2_traefik_tailscale_enabled

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

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

autoscan_role_traefik_wildcard_enabledautoscan2_traefik_wildcard_enabled

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

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

autoscan_role_web_api_http_portautoscan2_web_api_http_port

# Type: string (quoted number)
autoscan_role_web_api_http_port:

# Type: string (quoted number)
autoscan2_web_api_http_port:

autoscan_role_web_api_http_schemeautoscan2_web_api_http_scheme

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

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

autoscan_role_web_api_http_serverstransportautoscan2_web_api_http_serverstransport

# Type: dict/omit
autoscan_role_web_api_http_serverstransport:

# Type: dict/omit
autoscan2_web_api_http_serverstransport:

autoscan_role_web_api_portautoscan2_web_api_port

# Type: string (quoted number)
autoscan_role_web_api_port:

# Type: string (quoted number)
autoscan2_web_api_port:

autoscan_role_web_api_schemeautoscan2_web_api_scheme

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

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

autoscan_role_web_api_serverstransportautoscan2_web_api_serverstransport

# Type: dict/omit
autoscan_role_web_api_serverstransport:

# Type: dict/omit
autoscan2_web_api_serverstransport:

autoscan_role_web_fqdn_overrideautoscan2_web_fqdn_override

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

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

Example Override

autoscan_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "autoscan2.{{ user.domain }}"
  - "autoscan.otherdomain.tld"

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

Example Override

autoscan2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "autoscan2.{{ user.domain }}"
  - "autoscan.otherdomain.tld"

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

autoscan_role_web_host_overrideautoscan2_web_host_override

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

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

Example Override

autoscan_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'autoscan2.' + user.domain }}`)"

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

Example Override

autoscan2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'autoscan2.' + user.domain }}`)"

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

autoscan_role_web_http_portautoscan2_web_http_port

# Type: string (quoted number)
autoscan_role_web_http_port:

# Type: string (quoted number)
autoscan2_web_http_port:

autoscan_role_web_http_schemeautoscan2_web_http_scheme

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

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

autoscan_role_web_http_serverstransportautoscan2_web_http_serverstransport

# Type: dict/omit
autoscan_role_web_http_serverstransport:

# Type: dict/omit
autoscan2_web_http_serverstransport:

autoscan_role_web_schemeautoscan2_web_scheme

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

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

autoscan_role_web_serverstransportautoscan2_web_serverstransport

# Type: dict/omit
autoscan_role_web_serverstransport:

# Type: dict/omit
autoscan2_web_serverstransport: