NGINX

Description / name	Input element
Your domain name

Overview

NGINX is a high-performance web server, reverse proxy, and load balancer. This role deploys Nginx using the LinuxServer.io container, providing a simple way to host static websites or act as a reverse proxy for your applications.

Manual

Releases

Community

---

Configuration

Nginx is deployed with configuration files at /opt/nginx/. Place website files in /opt/nginx/www/ and edit site configs in /opt/nginx/nginx/site-confs/. Multiple instances are supported via the nginx_instances variable in your Saltbox inventory. Restart with docker restart nginx to apply changes.

Deployment

sb install nginx

Usage

Visit https://nginx.iYOUR_DOMAIN_NAMEi.

Role Defaults

Use the Inventory to customize variables. (1)

1. This role supports multiple instances via nginx_instances.

   Example override

   Role-levelInstance-level

   nginx_role_web_subdomain: "custom"
   

   Applies to all instances of nginx

   nginx2_web_subdomain: "custom2"
   

   Applies to the instance named nginx2

   Avoid overriding variables ending in _default

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

BasicsWebDNSTraefikDockerDocker+Global Override Options

nginx_instances

# Type: list
nginx_instances: ["nginx"]

Example Override

# Type: list
nginx_instances: ["nginx", "nginx2"]

nginx_role_web_subdomainnginx2_web_subdomain

# Type: string
nginx_role_web_subdomain: "{{ nginx_name }}"

# Type: string
nginx2_web_subdomain: "{{ nginx_name }}"

nginx_role_web_domainnginx2_web_domain

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

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

nginx_role_web_portnginx2_web_port

# Type: string
nginx_role_web_port: "80"

# Type: string
nginx2_web_port: "80"

nginx_role_web_urlnginx2_web_url

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

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

nginx_role_dns_recordnginx2_dns_record

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

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

nginx_role_dns_zonenginx2_dns_zone

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

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

nginx_role_dns_proxynginx2_dns_proxy

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

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

nginx_role_traefik_sso_middlewarenginx2_traefik_sso_middleware

# Type: string
nginx_role_traefik_sso_middleware: ""

# Type: string
nginx2_traefik_sso_middleware: ""

nginx_role_traefik_middleware_defaultnginx2_traefik_middleware_default

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

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

nginx_role_traefik_middleware_customnginx2_traefik_middleware_custom

# Type: string
nginx_role_traefik_middleware_custom: ""

# Type: string
nginx2_traefik_middleware_custom: ""

nginx_role_traefik_certresolvernginx2_traefik_certresolver

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

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

nginx_role_traefik_enablednginx2_traefik_enabled

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

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

nginx_role_traefik_api_enablednginx2_traefik_api_enabled

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

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

nginx_role_traefik_api_endpointnginx2_traefik_api_endpoint

# Type: string
nginx_role_traefik_api_endpoint: ""

# Type: string
nginx2_traefik_api_endpoint: ""

Container

nginx_role_docker_containernginx2_docker_container

# Type: string
nginx_role_docker_container: "{{ nginx_name }}"

# Type: string
nginx2_docker_container: "{{ nginx_name }}"

Image

nginx_role_docker_image_pullnginx2_docker_image_pull

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

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

nginx_role_docker_image_reponginx2_docker_image_repo

# Type: string
nginx_role_docker_image_repo: "lscr.io/linuxserver/nginx"

# Type: string
nginx2_docker_image_repo: "lscr.io/linuxserver/nginx"

nginx_role_docker_image_tagnginx2_docker_image_tag

# Type: string
nginx_role_docker_image_tag: "latest"

# Type: string
nginx2_docker_image_tag: "latest"

nginx_role_docker_imagenginx2_docker_image

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

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

Envs

nginx_role_docker_envs_defaultnginx2_docker_envs_default

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

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

nginx_role_docker_envs_customnginx2_docker_envs_custom

# Type: dict
nginx_role_docker_envs_custom: {}

# Type: dict
nginx2_docker_envs_custom: {}

Volumes

nginx_role_docker_volumes_defaultnginx2_docker_volumes_default

# Type: list
nginx_role_docker_volumes_default:
  - "{{ nginx_role_paths_location }}:/config"

# Type: list
nginx2_docker_volumes_default:
  - "{{ nginx_role_paths_location }}:/config"

nginx_role_docker_volumes_customnginx2_docker_volumes_custom

# Type: list
nginx_role_docker_volumes_custom: []

# Type: list
nginx2_docker_volumes_custom: []

Hostname

nginx_role_docker_hostnamenginx2_docker_hostname

# Type: string
nginx_role_docker_hostname: "{{ nginx_name }}"

# Type: string
nginx2_docker_hostname: "{{ nginx_name }}"

Networks

nginx_role_docker_networks_aliasnginx2_docker_networks_alias

# Type: string
nginx_role_docker_networks_alias: "{{ nginx_name }}"

# Type: string
nginx2_docker_networks_alias: "{{ nginx_name }}"

nginx_role_docker_networks_defaultnginx2_docker_networks_default

# Type: list
nginx_role_docker_networks_default: []

# Type: list
nginx2_docker_networks_default: []

nginx_role_docker_networks_customnginx2_docker_networks_custom

# Type: list
nginx_role_docker_networks_custom: []

# Type: list
nginx2_docker_networks_custom: []

Restart Policy

nginx_role_docker_restart_policynginx2_docker_restart_policy

# Type: string
nginx_role_docker_restart_policy: unless-stopped

# Type: string
nginx2_docker_restart_policy: unless-stopped

State

nginx_role_docker_statenginx2_docker_state

# Type: string
nginx_role_docker_state: started

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

nginx_role_docker_blkio_weightnginx2_docker_blkio_weight

# Type: int
nginx_role_docker_blkio_weight:

# Type: int
nginx2_docker_blkio_weight:

nginx_role_docker_cpu_periodnginx2_docker_cpu_period

# Type: int
nginx_role_docker_cpu_period:

# Type: int
nginx2_docker_cpu_period:

nginx_role_docker_cpu_quotanginx2_docker_cpu_quota

# Type: int
nginx_role_docker_cpu_quota:

# Type: int
nginx2_docker_cpu_quota:

nginx_role_docker_cpu_sharesnginx2_docker_cpu_shares

# Type: int
nginx_role_docker_cpu_shares:

# Type: int
nginx2_docker_cpu_shares:

nginx_role_docker_cpusnginx2_docker_cpus

# Type: string
nginx_role_docker_cpus:

# Type: string
nginx2_docker_cpus:

nginx_role_docker_cpuset_cpusnginx2_docker_cpuset_cpus

# Type: string
nginx_role_docker_cpuset_cpus:

# Type: string
nginx2_docker_cpuset_cpus:

nginx_role_docker_cpuset_memsnginx2_docker_cpuset_mems

# Type: string
nginx_role_docker_cpuset_mems:

# Type: string
nginx2_docker_cpuset_mems:

nginx_role_docker_kernel_memorynginx2_docker_kernel_memory

# Type: string
nginx_role_docker_kernel_memory:

# Type: string
nginx2_docker_kernel_memory:

nginx_role_docker_memorynginx2_docker_memory

# Type: string
nginx_role_docker_memory:

# Type: string
nginx2_docker_memory:

nginx_role_docker_memory_reservationnginx2_docker_memory_reservation

# Type: string
nginx_role_docker_memory_reservation:

# Type: string
nginx2_docker_memory_reservation:

nginx_role_docker_memory_swapnginx2_docker_memory_swap

# Type: string
nginx_role_docker_memory_swap:

# Type: string
nginx2_docker_memory_swap:

nginx_role_docker_memory_swappinessnginx2_docker_memory_swappiness

# Type: int
nginx_role_docker_memory_swappiness:

# Type: int
nginx2_docker_memory_swappiness:

nginx_role_docker_shm_sizenginx2_docker_shm_size

# Type: string
nginx_role_docker_shm_size:

# Type: string
nginx2_docker_shm_size:

Security & Devices

nginx_role_docker_cap_dropnginx2_docker_cap_drop

# Type: list
nginx_role_docker_cap_drop:

# Type: list
nginx2_docker_cap_drop:

nginx_role_docker_cgroupns_modenginx2_docker_cgroupns_mode

# Type: string
nginx_role_docker_cgroupns_mode:

# Type: string
nginx2_docker_cgroupns_mode:

nginx_role_docker_device_cgroup_rulesnginx2_docker_device_cgroup_rules

# Type: list
nginx_role_docker_device_cgroup_rules:

# Type: list
nginx2_docker_device_cgroup_rules:

nginx_role_docker_device_read_bpsnginx2_docker_device_read_bps

# Type: list
nginx_role_docker_device_read_bps:

# Type: list
nginx2_docker_device_read_bps:

nginx_role_docker_device_read_iopsnginx2_docker_device_read_iops

# Type: list
nginx_role_docker_device_read_iops:

# Type: list
nginx2_docker_device_read_iops:

nginx_role_docker_device_requestsnginx2_docker_device_requests

# Type: list
nginx_role_docker_device_requests:

# Type: list
nginx2_docker_device_requests:

nginx_role_docker_device_write_bpsnginx2_docker_device_write_bps

# Type: list
nginx_role_docker_device_write_bps:

# Type: list
nginx2_docker_device_write_bps:

nginx_role_docker_device_write_iopsnginx2_docker_device_write_iops

# Type: list
nginx_role_docker_device_write_iops:

# Type: list
nginx2_docker_device_write_iops:

nginx_role_docker_devicesnginx2_docker_devices

# Type: list
nginx_role_docker_devices:

# Type: list
nginx2_docker_devices:

nginx_role_docker_devices_defaultnginx2_docker_devices_default

# Type: string
nginx_role_docker_devices_default:

# Type: string
nginx2_docker_devices_default:

nginx_role_docker_groupsnginx2_docker_groups

# Type: list
nginx_role_docker_groups:

# Type: list
nginx2_docker_groups:

nginx_role_docker_privilegednginx2_docker_privileged

# Type: bool (true/false)
nginx_role_docker_privileged:

# Type: bool (true/false)
nginx2_docker_privileged:

nginx_role_docker_security_optsnginx2_docker_security_opts

# Type: list
nginx_role_docker_security_opts:

# Type: list
nginx2_docker_security_opts:

nginx_role_docker_usernginx2_docker_user

# Type: string
nginx_role_docker_user:

# Type: string
nginx2_docker_user:

nginx_role_docker_userns_modenginx2_docker_userns_mode

# Type: string
nginx_role_docker_userns_mode:

# Type: string
nginx2_docker_userns_mode:

Networking

nginx_role_docker_dns_optsnginx2_docker_dns_opts

# Type: list
nginx_role_docker_dns_opts:

# Type: list
nginx2_docker_dns_opts:

nginx_role_docker_dns_search_domainsnginx2_docker_dns_search_domains

# Type: list
nginx_role_docker_dns_search_domains:

# Type: list
nginx2_docker_dns_search_domains:

nginx_role_docker_dns_serversnginx2_docker_dns_servers

# Type: list
nginx_role_docker_dns_servers:

# Type: list
nginx2_docker_dns_servers:

nginx_role_docker_domainnamenginx2_docker_domainname

# Type: string
nginx_role_docker_domainname:

# Type: string
nginx2_docker_domainname:

nginx_role_docker_exposed_portsnginx2_docker_exposed_ports

# Type: list
nginx_role_docker_exposed_ports:

# Type: list
nginx2_docker_exposed_ports:

nginx_role_docker_hostsnginx2_docker_hosts

# Type: dict
nginx_role_docker_hosts:

# Type: dict
nginx2_docker_hosts:

nginx_role_docker_hosts_use_commonnginx2_docker_hosts_use_common

# Type: bool (true/false)
nginx_role_docker_hosts_use_common:

# Type: bool (true/false)
nginx2_docker_hosts_use_common:

nginx_role_docker_ipc_modenginx2_docker_ipc_mode

# Type: string
nginx_role_docker_ipc_mode:

# Type: string
nginx2_docker_ipc_mode:

nginx_role_docker_linksnginx2_docker_links

# Type: list
nginx_role_docker_links:

# Type: list
nginx2_docker_links:

nginx_role_docker_network_modenginx2_docker_network_mode

# Type: string
nginx_role_docker_network_mode:

# Type: string
nginx2_docker_network_mode:

nginx_role_docker_pid_modenginx2_docker_pid_mode

# Type: string
nginx_role_docker_pid_mode:

# Type: string
nginx2_docker_pid_mode:

nginx_role_docker_portsnginx2_docker_ports

# Type: list
nginx_role_docker_ports:

# Type: list
nginx2_docker_ports:

nginx_role_docker_utsnginx2_docker_uts

# Type: string
nginx_role_docker_uts:

# Type: string
nginx2_docker_uts:

Storage

nginx_role_docker_keep_volumesnginx2_docker_keep_volumes

# Type: bool (true/false)
nginx_role_docker_keep_volumes:

# Type: bool (true/false)
nginx2_docker_keep_volumes:

nginx_role_docker_mountsnginx2_docker_mounts

# Type: list
nginx_role_docker_mounts:

# Type: list
nginx2_docker_mounts:

nginx_role_docker_storage_optsnginx2_docker_storage_opts

# Type: dict
nginx_role_docker_storage_opts:

# Type: dict
nginx2_docker_storage_opts:

nginx_role_docker_tmpfsnginx2_docker_tmpfs

# Type: list
nginx_role_docker_tmpfs:

# Type: list
nginx2_docker_tmpfs:

nginx_role_docker_volume_drivernginx2_docker_volume_driver

# Type: string
nginx_role_docker_volume_driver:

# Type: string
nginx2_docker_volume_driver:

nginx_role_docker_volumes_fromnginx2_docker_volumes_from

# Type: list
nginx_role_docker_volumes_from:

# Type: list
nginx2_docker_volumes_from:

nginx_role_docker_volumes_globalnginx2_docker_volumes_global

# Type: bool (true/false)
nginx_role_docker_volumes_global:

# Type: bool (true/false)
nginx2_docker_volumes_global:

nginx_role_docker_working_dirnginx2_docker_working_dir

# Type: string
nginx_role_docker_working_dir:

# Type: string
nginx2_docker_working_dir:

Monitoring & Lifecycle

nginx_role_docker_auto_removenginx2_docker_auto_remove

# Type: bool (true/false)
nginx_role_docker_auto_remove:

# Type: bool (true/false)
nginx2_docker_auto_remove:

nginx_role_docker_cleanupnginx2_docker_cleanup

# Type: bool (true/false)
nginx_role_docker_cleanup:

# Type: bool (true/false)
nginx2_docker_cleanup:

nginx_role_docker_force_killnginx2_docker_force_kill

# Type: string
nginx_role_docker_force_kill:

# Type: string
nginx2_docker_force_kill:

nginx_role_docker_healthchecknginx2_docker_healthcheck

# Type: dict
nginx_role_docker_healthcheck:

# Type: dict
nginx2_docker_healthcheck:

nginx_role_docker_healthy_wait_timeoutnginx2_docker_healthy_wait_timeout

# Type: int
nginx_role_docker_healthy_wait_timeout:

# Type: int
nginx2_docker_healthy_wait_timeout:

nginx_role_docker_initnginx2_docker_init

# Type: bool (true/false)
nginx_role_docker_init:

# Type: bool (true/false)
nginx2_docker_init:

nginx_role_docker_kill_signalnginx2_docker_kill_signal

# Type: string
nginx_role_docker_kill_signal:

# Type: string
nginx2_docker_kill_signal:

nginx_role_docker_log_drivernginx2_docker_log_driver

# Type: string
nginx_role_docker_log_driver:

# Type: string
nginx2_docker_log_driver:

nginx_role_docker_log_optionsnginx2_docker_log_options

# Type: dict
nginx_role_docker_log_options:

# Type: dict
nginx2_docker_log_options:

nginx_role_docker_oom_killernginx2_docker_oom_killer

# Type: bool (true/false)
nginx_role_docker_oom_killer:

# Type: bool (true/false)
nginx2_docker_oom_killer:

nginx_role_docker_oom_score_adjnginx2_docker_oom_score_adj

# Type: int
nginx_role_docker_oom_score_adj:

# Type: int
nginx2_docker_oom_score_adj:

nginx_role_docker_output_logsnginx2_docker_output_logs

# Type: bool (true/false)
nginx_role_docker_output_logs:

# Type: bool (true/false)
nginx2_docker_output_logs:

nginx_role_docker_pausednginx2_docker_paused

# Type: bool (true/false)
nginx_role_docker_paused:

# Type: bool (true/false)
nginx2_docker_paused:

nginx_role_docker_recreatenginx2_docker_recreate

# Type: bool (true/false)
nginx_role_docker_recreate:

# Type: bool (true/false)
nginx2_docker_recreate:

nginx_role_docker_restart_retriesnginx2_docker_restart_retries

# Type: int
nginx_role_docker_restart_retries:

# Type: int
nginx2_docker_restart_retries:

nginx_role_docker_stop_timeoutnginx2_docker_stop_timeout

# Type: int
nginx_role_docker_stop_timeout:

# Type: int
nginx2_docker_stop_timeout:

Other Options

nginx_role_docker_capabilitiesnginx2_docker_capabilities

# Type: list
nginx_role_docker_capabilities:

# Type: list
nginx2_docker_capabilities:

nginx_role_docker_cgroup_parentnginx2_docker_cgroup_parent

# Type: string
nginx_role_docker_cgroup_parent:

# Type: string
nginx2_docker_cgroup_parent:

nginx_role_docker_commandsnginx2_docker_commands

# Type: list
nginx_role_docker_commands:

# Type: list
nginx2_docker_commands:

nginx_role_docker_create_timeoutnginx2_docker_create_timeout

# Type: int
nginx_role_docker_create_timeout:

# Type: int
nginx2_docker_create_timeout:

nginx_role_docker_entrypointnginx2_docker_entrypoint

# Type: string
nginx_role_docker_entrypoint:

# Type: string
nginx2_docker_entrypoint:

nginx_role_docker_env_filenginx2_docker_env_file

# Type: string
nginx_role_docker_env_file:

# Type: string
nginx2_docker_env_file:

nginx_role_docker_labelsnginx2_docker_labels

# Type: dict
nginx_role_docker_labels:

# Type: dict
nginx2_docker_labels:

nginx_role_docker_labels_use_commonnginx2_docker_labels_use_common

# Type: bool (true/false)
nginx_role_docker_labels_use_common:

# Type: bool (true/false)
nginx2_docker_labels_use_common:

nginx_role_docker_read_onlynginx2_docker_read_only

# Type: bool (true/false)
nginx_role_docker_read_only:

# Type: bool (true/false)
nginx2_docker_read_only:

nginx_role_docker_runtimenginx2_docker_runtime

# Type: string
nginx_role_docker_runtime:

# Type: string
nginx2_docker_runtime:

nginx_role_docker_sysctlsnginx2_docker_sysctls

# Type: list
nginx_role_docker_sysctls:

# Type: list
nginx2_docker_sysctls:

nginx_role_docker_ulimitsnginx2_docker_ulimits

# Type: list
nginx_role_docker_ulimits:

# Type: list
nginx2_docker_ulimits:

nginx_role_autoheal_enablednginx2_autoheal_enabled

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

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

nginx_role_depends_onnginx2_depends_on

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

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

nginx_role_depends_on_delaynginx2_depends_on_delay

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

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

nginx_role_depends_on_healthchecksnginx2_depends_on_healthchecks

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

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

nginx_role_diun_enablednginx2_diun_enabled

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

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

nginx_role_dns_enablednginx2_dns_enabled

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

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

nginx_role_docker_controllernginx2_docker_controller

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

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

nginx_role_docker_image_reponginx2_docker_image_repo

# Type: string
nginx_role_docker_image_repo:

# Type: string
nginx2_docker_image_repo:

nginx_role_docker_image_tagnginx2_docker_image_tag

# Type: string
nginx_role_docker_image_tag:

# Type: string
nginx2_docker_image_tag:

nginx_role_docker_volumes_downloadnginx2_docker_volumes_download

# Type: bool (true/false)
nginx_role_docker_volumes_download:

# Type: bool (true/false)
nginx2_docker_volumes_download:

nginx_role_themepark_addonsnginx2_themepark_addons

# Type: string
nginx_role_themepark_addons:

# Type: string
nginx2_themepark_addons:

nginx_role_themepark_appnginx2_themepark_app

# Type: string
nginx_role_themepark_app:

# Type: string
nginx2_themepark_app:

nginx_role_themepark_themenginx2_themepark_theme

# Type: string
nginx_role_themepark_theme:

# Type: string
nginx2_themepark_theme:

nginx_role_traefik_api_endpointnginx2_traefik_api_endpoint

# Type: dict/omit
nginx_role_traefik_api_endpoint:

# Type: dict/omit
nginx2_traefik_api_endpoint:

nginx_role_traefik_api_middlewarenginx2_traefik_api_middleware

# Type: string
nginx_role_traefik_api_middleware:

# Type: string
nginx2_traefik_api_middleware:

nginx_role_traefik_api_middleware_httpnginx2_traefik_api_middleware_http

# Type: string
nginx_role_traefik_api_middleware_http:

# Type: string
nginx2_traefik_api_middleware_http:

nginx_role_traefik_autodetect_enablednginx2_traefik_autodetect_enabled

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

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

nginx_role_traefik_certresolvernginx2_traefik_certresolver

# Type: string
nginx_role_traefik_certresolver:

# Type: string
nginx2_traefik_certresolver:

nginx_role_traefik_crowdsec_enablednginx2_traefik_crowdsec_enabled

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

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

nginx_role_traefik_error_pages_enablednginx2_traefik_error_pages_enabled

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

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

nginx_role_traefik_gzip_enablednginx2_traefik_gzip_enabled

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

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

nginx_role_traefik_middleware_httpnginx2_traefik_middleware_http

# Type: string
nginx_role_traefik_middleware_http:

# Type: string
nginx2_traefik_middleware_http:

nginx_role_traefik_middleware_http_api_insecurenginx2_traefik_middleware_http_api_insecure

# Type: bool (true/false)
nginx_role_traefik_middleware_http_api_insecure:

# Type: bool (true/false)
nginx2_traefik_middleware_http_api_insecure:

nginx_role_traefik_middleware_http_insecurenginx2_traefik_middleware_http_insecure

# Type: bool (true/false)
nginx_role_traefik_middleware_http_insecure:

# Type: bool (true/false)
nginx2_traefik_middleware_http_insecure:

nginx_role_traefik_prioritynginx2_traefik_priority

# Type: string
nginx_role_traefik_priority:

# Type: string
nginx2_traefik_priority:

nginx_role_traefik_robot_enablednginx2_traefik_robot_enabled

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

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

nginx_role_traefik_tailscale_enablednginx2_traefik_tailscale_enabled

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

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

nginx_role_traefik_wildcard_enablednginx2_traefik_wildcard_enabled

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

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

nginx_role_web_domainnginx2_web_domain

# Type: string
nginx_role_web_domain:

# Type: string
nginx2_web_domain:

nginx_role_web_fqdn_overridenginx2_web_fqdn_override

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

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

Example Override

nginx_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "nginx2.{{ user.domain }}"
  - "nginx.otherdomain.tld"

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

Example Override

nginx2_web_fqdn_override:
  - "{{ traefik_host }}"
  - "nginx2.{{ user.domain }}"
  - "nginx.otherdomain.tld"

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

nginx_role_web_host_overridenginx2_web_host_override

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

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

Example Override

nginx_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'nginx2.' + user.domain }}`)"

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

Example Override

nginx2_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'nginx2.' + user.domain }}`)"

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

nginx_role_web_http_portnginx2_web_http_port

# Type: string (quoted number)
nginx_role_web_http_port:

# Type: string (quoted number)
nginx2_web_http_port:

nginx_role_web_http_schemenginx2_web_http_scheme

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

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

nginx_role_web_http_serverstransportnginx2_web_http_serverstransport

# Type: dict/omit
nginx_role_web_http_serverstransport:

# Type: dict/omit
nginx2_web_http_serverstransport:

nginx_role_web_schemenginx2_web_scheme

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

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

nginx_role_web_serverstransportnginx2_web_serverstransport

# Type: dict/omit
nginx_role_web_serverstransport:

# Type: dict/omit
nginx2_web_serverstransport:

nginx_role_web_subdomainnginx2_web_subdomain

# Type: string
nginx_role_web_subdomain:

# Type: string
nginx2_web_subdomain: