n8n

Description / name	Input element
Your domain name

Overview

n8n is a workflow automation platform that gives technical teams the flexibility of code with the speed of no-code. With 400+ integrations, native AI capabilities, and a fair-code license, n8n lets you build powerful automations while maintaining full control over your data and deployments.

Manual

Releases

Community

---

Outdated role marked for deprecation

This role is no longer aligned with upstream changes and may not work as expected.

Pull requests to update this role (and remove this warning once compatibility is restored) are welcome. Outdated roles are eventually removed from the codebase.

Deployment

sb install sandbox-n8n

Usage

Visit https://n8n.iYOUR_DOMAIN_NAMEi.

Role Defaults

Variables can be customized using the Inventory. (1)

1. Example override

   n8n_name: "custom_value"
   

   Avoid overriding variables ending in _default

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

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

n8n_name

# Type: string
n8n_name: n8n

n8n_role_postgres_deploy

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

n8n_role_postgres_name

# Type: string
n8n_role_postgres_name: "{{ n8n_name }}-postgres"

n8n_role_postgres_user

# If empty it will fallback to postgres role default
# Type: string
n8n_role_postgres_user: ""

n8n_role_postgres_password

# If empty it will fallback to postgres role default
# Type: string
n8n_role_postgres_password: ""

n8n_role_postgres_docker_env_db

# Type: string
n8n_role_postgres_docker_env_db: "{{ n8n_name }}"

n8n_role_postgres_docker_image_tag

# Type: string
n8n_role_postgres_docker_image_tag: "14-alpine"

n8n_role_postgres_docker_image_repo

# Type: string
n8n_role_postgres_docker_image_repo: "postgres"

n8n_role_postgres_docker_healthcheck

# Type: dict
n8n_role_postgres_docker_healthcheck:
  test: ["CMD-SHELL", "pg_isready -d {{ lookup('role_var', '_postgres_docker_env_db', role='n8n') }} -U {{ lookup('role_var', '_postgres_user', role='n8n') if (lookup('role_var', '_postgres_user', role='n8n') | length > 0) else lookup('role_var', '_docker_env_user', role='postgres') }}"]
  start_period: 20s
  interval: 30s
  retries: 5
  timeout: 5s

n8n_role_postgres_paths_folder

# Type: string
n8n_role_postgres_paths_folder: "{{ n8n_name }}"

n8n_role_postgres_paths_location

# Type: string
n8n_role_postgres_paths_location: "{{ server_appdata_path }}/{{ n8n_role_postgres_paths_folder }}/postgres"

n8n_role_web_subdomain

# Type: string
n8n_role_web_subdomain: "{{ n8n_name }}"

n8n_role_web_domain

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

n8n_role_web_port

# Type: string
n8n_role_web_port: "5678"

n8n_role_web_url

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

n8n_role_dns_record

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

n8n_role_dns_zone

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

n8n_role_dns_proxy

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

n8n_role_traefik_sso_middleware

# Type: string
n8n_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

n8n_role_traefik_middleware_default

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

n8n_role_traefik_middleware_custom

# Type: string
n8n_role_traefik_middleware_custom: ""

n8n_role_traefik_certresolver

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

n8n_role_traefik_enabled

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

n8n_role_traefik_api_enabled

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

n8n_role_traefik_api_endpoint

# Type: string
n8n_role_traefik_api_endpoint: "PathPrefix(`/api`) || PathPrefix(`/webhook`)"

Container

n8n_role_docker_container

# Type: string
n8n_role_docker_container: "{{ n8n_name }}"

Image

n8n_role_docker_image_pull

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

n8n_role_docker_image_tag

# Type: string
n8n_role_docker_image_tag: "latest"

n8n_role_docker_image_repo

# Type: string
n8n_role_docker_image_repo: "n8nio/n8n"

n8n_role_docker_image

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

Envs

n8n_role_docker_envs_default

# Type: dict
n8n_role_docker_envs_default:
  GENERIC_TIMEZONE: "{{ tz }}"
  TZ: "{{ tz }}"
  DB_TYPE: "postgresdb"
  DB_POSTGRESDB_DATABASE: "{{ lookup('role_var', '_postgres_docker_env_db', role='n8n') }}"
  DB_POSTGRESDB_HOST: "{{ lookup('role_var', '_postgres_name', role='n8n') }}"
  DB_POSTGRESDB_PORT: "5432"
  DB_POSTGRESDB_USER: "{{ lookup('role_var', '_postgres_user', role='n8n')
                       if (lookup('role_var', '_postgres_user', role='n8n') | length > 0)
                       else lookup('role_var', '_docker_env_user', role='postgres') }}"
  DB_POSTGRESDB_PASSWORD: "{{ lookup('role_var', '_postgres_password', role='n8n')
                           if (lookup('role_var', '_postgres_password', role='n8n') | length > 0)
                           else lookup('role_var', '_docker_env_password', role='postgres') }}"
  N8N_EDITOR_BASE_URL: "{{ lookup('role_var', '_web_url', role='n8n') }}"
  N8N_DIAGNOSTICS_ENABLED: "false"
  N8N_HIRING_BANNER_ENABLED: "false"
  N8N_USER_MANAGEMENT_DISABLED: "true"
  N8N_ENFORCE_SETTINGS_FILE_PERMISSIONS: "true"
  WEBHOOK_URL: "{{ lookup('role_var', '_web_url', role='n8n') }}/"
  N8N_PROXY_HOPS: "1"
  N8N_RUNNERS_ENABLED: "true"
  N8N_USER_FOLDER: "/data"

n8n_role_docker_envs_custom

# Type: dict
n8n_role_docker_envs_custom: {}

Volumes

n8n_role_docker_volumes_default

# Type: list
n8n_role_docker_volumes_default:
  - "{{ lookup('role_var', '_paths_location', role='n8n') }}/data:/data"

n8n_role_docker_volumes_custom

# Type: list
n8n_role_docker_volumes_custom: []

Hostname

n8n_role_docker_hostname

# Type: string
n8n_role_docker_hostname: "{{ n8n_name }}"

Networks

n8n_role_docker_networks_alias

# Type: string
n8n_role_docker_networks_alias: "{{ n8n_name }}"

n8n_role_docker_networks_default

# Type: list
n8n_role_docker_networks_default: []

n8n_role_docker_networks_custom

# Type: list
n8n_role_docker_networks_custom: []

Restart Policy

n8n_role_docker_restart_policy

# Type: string
n8n_role_docker_restart_policy: unless-stopped

Dependencies

n8n_role_depends_on

# Type: string
n8n_role_depends_on: "{{ lookup('role_var', '_postgres_name', role='n8n') }}"

n8n_role_depends_on_delay

# Type: string (quoted number)
n8n_role_depends_on_delay: "0"

n8n_role_depends_on_healthchecks

# Type: string ("true"/"false")
n8n_role_depends_on_healthchecks: "false"

User

n8n_role_docker_user

# Type: string
n8n_role_docker_user: "{{ uid }}:{{ gid }}"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

n8n_role_docker_blkio_weight

# Type: int
n8n_role_docker_blkio_weight:

n8n_role_docker_cpu_period

# Type: int
n8n_role_docker_cpu_period:

n8n_role_docker_cpu_quota

# Type: int
n8n_role_docker_cpu_quota:

n8n_role_docker_cpu_shares

# Type: int
n8n_role_docker_cpu_shares:

n8n_role_docker_cpus

# Type: string
n8n_role_docker_cpus:

n8n_role_docker_cpuset_cpus

# Type: string
n8n_role_docker_cpuset_cpus:

n8n_role_docker_cpuset_mems

# Type: string
n8n_role_docker_cpuset_mems:

n8n_role_docker_kernel_memory

# Type: string
n8n_role_docker_kernel_memory:

n8n_role_docker_memory

# Type: string
n8n_role_docker_memory:

n8n_role_docker_memory_reservation

# Type: string
n8n_role_docker_memory_reservation:

n8n_role_docker_memory_swap

# Type: string
n8n_role_docker_memory_swap:

n8n_role_docker_memory_swappiness

# Type: int
n8n_role_docker_memory_swappiness:

n8n_role_docker_shm_size

# Type: string
n8n_role_docker_shm_size:

Security & Devices

n8n_role_docker_cap_drop

# Type: list
n8n_role_docker_cap_drop:

n8n_role_docker_cgroupns_mode

# Type: string
n8n_role_docker_cgroupns_mode:

n8n_role_docker_device_cgroup_rules

# Type: list
n8n_role_docker_device_cgroup_rules:

n8n_role_docker_device_read_bps

# Type: list
n8n_role_docker_device_read_bps:

n8n_role_docker_device_read_iops

# Type: list
n8n_role_docker_device_read_iops:

n8n_role_docker_device_requests

# Type: list
n8n_role_docker_device_requests:

n8n_role_docker_device_write_bps

# Type: list
n8n_role_docker_device_write_bps:

n8n_role_docker_device_write_iops

# Type: list
n8n_role_docker_device_write_iops:

n8n_role_docker_devices

# Type: list
n8n_role_docker_devices:

n8n_role_docker_groups

# Type: list
n8n_role_docker_groups:

n8n_role_docker_privileged

# Type: bool (true/false)
n8n_role_docker_privileged:

n8n_role_docker_security_opts

# Type: list
n8n_role_docker_security_opts:

n8n_role_docker_userns_mode

# Type: string
n8n_role_docker_userns_mode:

Networking

n8n_role_docker_dns_opts

# Type: list
n8n_role_docker_dns_opts:

n8n_role_docker_dns_search_domains

# Type: list
n8n_role_docker_dns_search_domains:

n8n_role_docker_dns_servers

# Type: list
n8n_role_docker_dns_servers:

n8n_role_docker_domainname

# Type: string
n8n_role_docker_domainname:

n8n_role_docker_exposed_ports

# Type: list
n8n_role_docker_exposed_ports:

n8n_role_docker_hosts

# Type: dict
n8n_role_docker_hosts:

n8n_role_docker_hosts_use_common

# Type: bool (true/false)
n8n_role_docker_hosts_use_common:

n8n_role_docker_ipc_mode

# Type: string
n8n_role_docker_ipc_mode:

n8n_role_docker_links

# Type: list
n8n_role_docker_links:

n8n_role_docker_network_mode

# Type: string
n8n_role_docker_network_mode:

n8n_role_docker_pid_mode

# Type: string
n8n_role_docker_pid_mode:

n8n_role_docker_ports

# Type: list
n8n_role_docker_ports:

n8n_role_docker_uts

# Type: string
n8n_role_docker_uts:

Storage

n8n_role_docker_keep_volumes

# Type: bool (true/false)
n8n_role_docker_keep_volumes:

n8n_role_docker_mounts

# Type: list
n8n_role_docker_mounts:

n8n_role_docker_storage_opts

# Type: dict
n8n_role_docker_storage_opts:

n8n_role_docker_tmpfs

# Type: list
n8n_role_docker_tmpfs:

n8n_role_docker_volume_driver

# Type: string
n8n_role_docker_volume_driver:

n8n_role_docker_volumes_from

# Type: list
n8n_role_docker_volumes_from:

n8n_role_docker_volumes_global

# Type: bool (true/false)
n8n_role_docker_volumes_global:

n8n_role_docker_working_dir

# Type: string
n8n_role_docker_working_dir:

Monitoring & Lifecycle

n8n_role_docker_auto_remove

# Type: bool (true/false)
n8n_role_docker_auto_remove:

n8n_role_docker_cleanup

# Type: bool (true/false)
n8n_role_docker_cleanup:

n8n_role_docker_force_kill

# Type: string
n8n_role_docker_force_kill:

n8n_role_docker_healthcheck

# Type: dict
n8n_role_docker_healthcheck:

n8n_role_docker_healthy_wait_timeout

# Type: int
n8n_role_docker_healthy_wait_timeout:

n8n_role_docker_init

# Type: bool (true/false)
n8n_role_docker_init:

n8n_role_docker_kill_signal

# Type: string
n8n_role_docker_kill_signal:

n8n_role_docker_log_driver

# Type: string
n8n_role_docker_log_driver:

n8n_role_docker_log_options

# Type: dict
n8n_role_docker_log_options:

n8n_role_docker_oom_killer

# Type: bool (true/false)
n8n_role_docker_oom_killer:

n8n_role_docker_oom_score_adj

# Type: int
n8n_role_docker_oom_score_adj:

n8n_role_docker_output_logs

# Type: bool (true/false)
n8n_role_docker_output_logs:

n8n_role_docker_paused

# Type: bool (true/false)
n8n_role_docker_paused:

n8n_role_docker_recreate

# Type: bool (true/false)
n8n_role_docker_recreate:

n8n_role_docker_restart_retries

# Type: int
n8n_role_docker_restart_retries:

n8n_role_docker_stop_signal

# Type: string
n8n_role_docker_stop_signal:

n8n_role_docker_stop_timeout

# Type: int
n8n_role_docker_stop_timeout:

Other Options

n8n_role_docker_capabilities

# Type: list
n8n_role_docker_capabilities:

n8n_role_docker_cgroup_parent

# Type: string
n8n_role_docker_cgroup_parent:

n8n_role_docker_commands

# Type: list
n8n_role_docker_commands:

n8n_role_docker_create_timeout

# Type: int
n8n_role_docker_create_timeout:

n8n_role_docker_entrypoint

# Type: string
n8n_role_docker_entrypoint:

n8n_role_docker_env_file

# Type: string
n8n_role_docker_env_file:

n8n_role_docker_labels

# Type: dict
n8n_role_docker_labels:

n8n_role_docker_labels_use_common

# Type: bool (true/false)
n8n_role_docker_labels_use_common:

n8n_role_docker_read_only

# Type: bool (true/false)
n8n_role_docker_read_only:

n8n_role_docker_runtime

# Type: string
n8n_role_docker_runtime:

n8n_role_docker_sysctls

# Type: list
n8n_role_docker_sysctls:

n8n_role_docker_ulimits

# Type: list
n8n_role_docker_ulimits:

n8n_role_autoheal_enabled

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

n8n_role_diun_enabled

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

n8n_role_dns_enabled

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

n8n_role_docker_controller

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

n8n_role_docker_networks_alias_custom

# Type: list
n8n_role_docker_networks_alias_custom:

n8n_role_docker_volumes_download

# Type: bool (true/false)
n8n_role_docker_volumes_download:

n8n_role_themepark_addons

# Type: string
n8n_role_themepark_addons:

n8n_role_themepark_app

# Type: string
n8n_role_themepark_app:

n8n_role_themepark_theme

# Type: string
n8n_role_themepark_theme:

n8n_role_traefik_api_middleware

# Type: string
n8n_role_traefik_api_middleware:

n8n_role_traefik_api_middleware_http

# Type: string
n8n_role_traefik_api_middleware_http:

n8n_role_traefik_autodetect_enabled

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

n8n_role_traefik_crowdsec_enabled

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

n8n_role_traefik_error_pages_enabled

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

n8n_role_traefik_gzip_enabled

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

n8n_role_traefik_middleware_http

# Type: string
n8n_role_traefik_middleware_http:

n8n_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
n8n_role_traefik_middleware_http_api_insecure:

n8n_role_traefik_middleware_http_insecure

# Type: bool (true/false)
n8n_role_traefik_middleware_http_insecure:

n8n_role_traefik_priority

# Type: string
n8n_role_traefik_priority:

n8n_role_traefik_robot_enabled

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

n8n_role_traefik_tailscale_enabled

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

n8n_role_traefik_wildcard_enabled

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

n8n_role_web_api_http_port

# Type: string (quoted number)
n8n_role_web_api_http_port:

n8n_role_web_api_http_scheme

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

n8n_role_web_api_http_serverstransport

# Type: dict/omit
n8n_role_web_api_http_serverstransport:

n8n_role_web_api_port

# Type: string (quoted number)
n8n_role_web_api_port:

n8n_role_web_api_scheme

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

n8n_role_web_api_serverstransport

# Type: dict/omit
n8n_role_web_api_serverstransport:

n8n_role_web_fqdn_override

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

Example Override

n8n_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "n8n2.{{ user.domain }}"
  - "n8n.otherdomain.tld"

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

n8n_role_web_host_override

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

Example Override

n8n_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'n8n2.' + user.domain }}`)"

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

n8n_role_web_http_port

# Type: string (quoted number)
n8n_role_web_http_port:

n8n_role_web_http_scheme

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

n8n_role_web_http_serverstransport

# Type: dict/omit
n8n_role_web_http_serverstransport:

n8n_role_web_scheme

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

n8n_role_web_serverstransport

# Type: dict/omit
n8n_role_web_serverstransport: