2022-01-27 17:39:58 -05:00
# Include{groups}
portals :
2022-02-24 13:15:06 -05:00
open :
2022-08-08 17:25:02 -04:00
# Include{portalLink}
2022-01-27 17:39:58 -05:00
questions :
# Include{global}
2022-08-08 17:25:02 -04:00
# Include{controller}
# Include{replicas}
# Include{replica1}
2022-08-12 04:40:46 -04:00
# Include{controllerExpertExtraArgs}
2022-07-11 05:39:28 -04:00
- variable : timezoneandlocale
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-07-11 05:39:28 -04:00
label : "Timezone and Localization"
schema :
additional_attrs : true
type : dict
attrs :
- variable : N8N_DEFAULT_LOCALE
label : "Default Locale (Leave empty for default)"
description : "A locale identifier, compatible with the Accept-Language header."
schema :
type : string
default : ""
2022-01-27 17:39:58 -05:00
- variable : deployment
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-01-27 17:39:58 -05:00
label : "Deployment"
schema :
additional_attrs : true
type : dict
attrs :
- variable : N8N_HOST
label : "Host"
2022-07-11 05:39:28 -04:00
description : "Host name n8n runs on."
2022-01-27 17:39:58 -05:00
schema :
type : string
required : true
default : ""
2022-07-11 05:39:28 -04:00
- variable : N8N_EDITOR_BASE_URL
label : "Base URL"
description : "Public URL where users can access the editor. Also used for emails sent from n8n."
schema :
type : string
default : ""
2022-01-27 17:39:58 -05:00
- variable : N8N_CONFIG_FILES
label : "Config Files (Leave empty for default)"
description : "Use to provide the path to any JSON configuration file(s)"
schema :
type : string
default : ""
- variable : N8N_DISABLE_UI
label : "Disable UI"
description : "Whether the UI should be disabled"
schema :
type : boolean
default : false
2022-07-11 05:39:28 -04:00
- variable : N8N_TEMPLATES_ENABLED
label : "Enable Templates"
description : "Enable workflow templates."
schema :
type : boolean
default : false
show_subquestions_if :
subquestions :
- variable : N8N_TEMPLATES_HOST
label : "Templates Host (Leave empty for default)"
description : "Change this if creating your own workflow template library."
schema :
type : string
default : ""
2022-01-27 17:39:58 -05:00
- variable : N8N_ENCRYPTION_KEY
label : "Encryption Key (Leave empty for default)"
description : "Provide a custom key used to encrypt credentials in the n8n database. By default a random key is generated on first launch"
schema :
type : string
default : ""
- variable : N8N_PERSONALIZATION_ENABLED
label : "Enable Personalization"
2022-07-11 05:39:28 -04:00
description : "Whether to ask users personalization questions and then customize n8n accordingly"
2022-01-27 17:39:58 -05:00
schema :
type : boolean
default : true
- variable : N8N_VERSION_NOTIFICATIONS_ENABLED
label : "Enable Version Notifications"
description : "When enabled, notifications of new versions and security updates are provided"
schema :
type : boolean
default : true
- variable : N8N_DIAGNOSTICS_ENABLED
label : "Enable Diagnostics"
description : "Whether to share selected, anonymous telemetry with n8n"
schema :
type : boolean
default : false
2022-07-11 05:39:28 -04:00
- variable : N8N_HIRING_BANNER_ENABLED
label : "Enable Hiring Banner"
description : "Whether to show the n8n hiring banner in the console."
schema :
type : boolean
default : false
2022-01-27 17:39:58 -05:00
- variable : workflows
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-01-27 17:39:58 -05:00
label : "Workflows"
schema :
additional_attrs : true
type : dict
attrs :
- variable : WORKFLOWS_DEFAULT_NAME
label : "Workflows Default Name (Leave empty for default)"
description : "The default name used for new workflows"
schema :
type : string
default : ""
2022-07-11 05:39:28 -04:00
- variable : N8N_ONBOARDING_FLOW_DISABLED
label : "Enable Onboarding Flow"
description : "Whether to show onboarding tips when creating a new workflow."
schema :
type : boolean
default : false
- variable : N8N_WORKFLOW_TAGS_DISABLED
label : "Disable Workflow Tags"
description : "Whether to disable workflow tags."
schema :
type : boolean
default : false
2022-01-27 17:39:58 -05:00
- variable : executions
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-01-27 17:39:58 -05:00
label : "Executions"
schema :
additional_attrs : true
type : dict
attrs :
- variable : EXECUTIONS_PROCESS
label : "Execution Process"
description : "Whether processes are executed in their own process or the main process"
schema :
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "main"
description : "Main"
- value : "own"
description : "Own"
- variable : EXECUTIONS_MODE
label : "Execution Mode"
description : "Whether processes should run directly or via queue"
schema :
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "regular"
description : "Regular"
- value : "queue"
description : "Queue"
- variable : EXECUTIONS_TIMEOUT
label : "Execution Timeout (Leave empty for default)"
2022-07-11 05:39:28 -04:00
description : "The maximum run time (in seconds) before stopping a workflow execution. Set to -1 to disable."
2022-01-27 17:39:58 -05:00
schema :
type : int
- variable : EXECUTIONS_TIMEOUT_MAX
label : "Max Execution Timeout (Leave empty for default)"
description : "The max execution time (in seconds) that can be set for a workflow individually"
schema :
type : int
- variable : EXECUTIONS_DATA_SAVE_ON_ERROR
label : "Execution Data Save on Error"
2022-07-11 05:39:28 -04:00
description : "Whether n8n saves execution data on error."
2022-01-27 17:39:58 -05:00
schema :
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "all"
description : "All"
- value : "none"
description : "None"
- variable : EXECUTIONS_DATA_SAVE_ON_SUCCESS
label : "Execution Data Save on Success"
description : "Whether execution data is saved on success"
schema :
type : string
default : ""
enum :
- value : ""
description : "Default"
- value : "all"
description : "All"
- value : "none"
description : "None"
- variable : EXECUTIONS_DATA_SAVE_ON_PROGRESS
label : "Execution Data Save on Progress"
description : "Whether to save progress for each node executed"
schema :
type : boolean
default : false
- variable : EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS
label : "Execution Data Save on Manual Executions"
description : "Whether to save data of executions when started manually"
schema :
type : boolean
default : false
- variable : EXECUTIONS_DATA_MAX_AGE
label : "Execution Data Max Age (Leave empty for default)"
description : "The execution age (in hours) before it is deleted"
schema :
type : int
2022-07-11 05:39:28 -04:00
- variable : EXECUTIONS_DATA_PRUNE
label : "Execution Data Prune"
description : "Whether to delete data of past executions on a rolling basis"
2022-01-27 17:39:58 -05:00
schema :
2022-07-11 05:39:28 -04:00
type : boolean
default : false
show_subquestions_if :
subquestions :
- variable : EXECUTIONS_DATA_PRUNE_TIMEOUT
label : "Data Prune Timeout (Leave empty for default)"
description : "The timeout (in seconds) after execution data has been pruned"
schema :
type : int
2022-05-28 07:16:21 -04:00
- variable : n8n_security
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-01-27 17:39:58 -05:00
label : "Security"
schema :
additional_attrs : true
type : dict
attrs :
2022-07-11 05:39:28 -04:00
- variable : N8N_BLOCK_ENV_ACCESS_IN_NODE
label : "Block Environment Access in Node"
description : "Whether to allow users to access environment variables in expressions and the function node"
2022-01-27 17:39:58 -05:00
schema :
2022-07-11 05:39:28 -04:00
type : boolean
default : false
2022-01-27 17:39:58 -05:00
- variable : N8N_BASIC_AUTH_ACTIVE
label : "Enable Basic Auth"
description : "Whether basic auth should be activated for editor and REST-API access"
schema :
type : boolean
default : false
2022-07-11 05:39:28 -04:00
show_subquestions_if : true
subquestions :
- variable : N8N_BASIC_AUTH_USER
label : "Basic Auth User (Leave empty for default)"
description : "The name of the n8n user for basic authentication"
schema :
type : string
default : ""
- variable : N8N_BASIC_AUTH_PASSWORD
label : "Basic Auth Password (Leave empty for default)"
description : "The password of the n8n user for basic authentication"
schema :
type : string
default : ""
- variable : N8N_BASIC_AUTH_HASH
label : "Enable Basic Auth Hash"
description : "Whether the basic authentication password is hashed"
schema :
type : boolean
default : false
2022-01-27 17:39:58 -05:00
- variable : N8N_JWT_AUTH_ACTIVE
label : "Enable JWT Auth"
description : "Whether JWT authentication should be activated for editor and REST-API access"
schema :
type : boolean
default : false
2022-07-11 05:39:28 -04:00
show_subquestions_if : true
subquestions :
- variable : N8N_JWT_AUTH_HEADER
label : "JWT Auth Header (Leave empty for default)"
description : "The request header containing a signed JWT"
schema :
type : string
default : ""
- variable : N8N_JWT_AUTH_HEADER_VALUE_PREFIX
label : "JWT Auth Header Prefix to strip (Leave empty for default)"
description : "Optional. The request header value prefix to strip"
schema :
type : string
default : ""
- variable : N8N_JWKS_URI
label : "JWT Set URI (Leave empty for default)"
description : "The URI to fetch JWK Set for JWT authentication"
schema :
type : string
default : ""
- variable : N8N_JWT_ISSUER
label : "JWT Issuer (Leave empty for default)"
description : "Optional. The expected JWT issuer"
schema :
type : string
default : ""
- variable : N8N_JWT_NAMESPACE
label : "JWT Namespace (Leave empty for default)"
description : "Optional. The expected JWT namespace"
schema :
type : string
default : ""
- variable : N8N_JWT_ALLOWED_TENANT
label : "JWT Allowed Tenant (Leave empty for default)"
description : "Optional. The allowed JWT tenant"
schema :
type : string
default : ""
- variable : N8N_JWT_ALLOWED_TENANT_KEY
label : "JWT Allowed Tenant Key (Leave empty for default)"
description : "Optional. The JWT tenant key name to inspect within the JWT namespace"
schema :
type : string
default : ""
- variable : N8N_AUTH_EXCLUDE_ENDPOINTS
label : "Additional Endpoints to Exclude Auth Checks (Leave empty for default)"
description : "Additional endpoints to exclude auth checks. Multiple endpoints can be provided separated by a colon (\":\"). The endpoints should not start with a forward slash (\"/\")"
2022-01-27 17:39:58 -05:00
schema :
type : string
default : ""
- variable : endpoints
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-01-27 17:39:58 -05:00
label : "Endpoints"
schema :
additional_attrs : true
type : dict
attrs :
- variable : WEBHOOK_URL
label : "Webhook URL"
description : "Used to manually provide the Webhook URL when running n8n behind a reverse proxy"
schema :
type : string
default : ""
- variable : N8N_PAYLOAD_SIZE_MAX
label : "Max Payload Size (Leave empty for default)"
description : "The maximum payload size in MB"
schema :
type : int
- variable : N8N_METRICS
label : "Enable Metrics endpoint"
description : "Whether to enable the metrics endpoint"
schema :
type : boolean
default : false
2022-07-11 05:39:28 -04:00
show_subquestions_if :
subquestions :
- variable : N8N_METRICS_PREFIX
label : "Metrics Prefix (Leave empty for default)"
description : "Optional prefix to be used for metrics names"
schema :
type : string
default : ""
2022-01-27 17:39:58 -05:00
- variable : N8N_ENDPOINT_REST
label : "Rest Endpoint Path (Leave empty for default)"
description : "The path used for REST endpoint"
schema :
type : string
default : ""
- variable : N8N_ENDPOINT_WEBHOOK
label : "Webhook Endpoint Path (Leave empty for default)"
description : "The path used for webhook endpoint"
schema :
type : string
default : ""
- variable : N8N_ENDPOINT_WEBHOOK_TEST
label : "Test-Webhook Endpoint Path (Leave empty for default)"
description : "The path used for test-webhook endpoin"
schema :
type : string
default : ""
- variable : N8N_ENDPOINT_WEBHOOK_WAIT
label : "Waiting-Webhook Endpoint Path (Leave empty for default)"
description : "The path used for waiting-webhook endpoint"
schema :
type : string
default : ""
- variable : N8N_DISABLE_PRODUCTION_MAIN_PROCESS
label : "Disable Production Webhooks"
description : "Disable production webhooks from main process. This helps ensures no HTTP traffic load to main process when using webhook-specific processes"
schema :
type : boolean
default : false
- variable : N8N_SKIP_WEBHOOK_DEREGISTRATION_SHUTDOWN
label : "Deregister External Webhooks"
description : "Deregister webhooks on external services only when workflows are deactivated"
schema :
type : boolean
default : false
- variable : credentials
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-01-27 17:39:58 -05:00
label : "Credentials"
schema :
additional_attrs : true
type : dict
attrs :
- variable : CREDENTIALS_OVERWRITE_DATA
2022-07-11 05:39:28 -04:00
label : "Credentials Overwrites (Leave empty for default)"
2022-01-27 17:39:58 -05:00
description : "Overwrites for credentials"
schema :
type : string
2022-01-28 03:55:02 -05:00
default : ""
2022-01-27 17:39:58 -05:00
- variable : CREDENTIALS_OVERWRITE_ENDPOINT
2022-01-28 03:55:02 -05:00
label : "Credentials Overwrite Endpoint (Leave empty for default)"
2022-01-27 17:39:58 -05:00
description : "The API endpoint to fetch credentials"
schema :
type : string
default : ""
- variable : CREDENTIALS_DEFAULT_NAME
label : "Credentials Default Name (Leave empty for default)"
description : "The default name for credentials"
schema :
type : string
default : ""
- variable : logs
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-01-27 17:39:58 -05:00
label : "Logs"
schema :
additional_attrs : true
type : dict
attrs :
- variable : N8N_LOG_LEVEL
label : "Log Level"
description : "Log output level"
schema :
type : string
2022-01-28 15:25:38 -05:00
default : ""
2022-01-27 17:39:58 -05:00
enum :
- value : ""
description : "Default"
- value : "info"
description : "Info"
- value : "warn"
description : "Warn"
- value : "error"
description : "Error"
- value : "verbose"
description : "Verbose"
- value : "debug"
description : "Debug"
- variable : N8N_LOG_OUTPUT
label : "Log Output"
description : "Where to output logs"
schema :
type : string
2022-01-28 15:25:38 -05:00
default : ""
2022-01-27 17:39:58 -05:00
enum :
- value : ""
description : "Default"
- value : "console"
description : "Console"
- value : "file"
description : "File"
- value : "console,file"
description : "Console and File"
- variable : N8N_LOG_FILE_COUNT_MAX
label : "Max Log File Count (Leave empty for default)"
description : "Max number of log files to keep"
schema :
type : int
- variable : N8N_LOG_FILE_SIZE_MAX
label : "Max Log File Size (Leave empty for default)"
description : "Max size of each log file in MB"
schema :
type : int
2022-07-11 05:39:28 -04:00
- variable : externalhooks
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-07-11 05:39:28 -04:00
label : "External Hooks"
schema :
additional_attrs : true
type : dict
attrs :
- variable : EXTERNAL_HOOK_FILES
label : "External Hook Files (Leave empty for default)"
description : "Files containing external hooks. Provide multiple files as a colon-separated list ':'."
schema :
type : string
default : ""
- variable : usermanagement
2022-11-10 11:56:28 -05:00
group : "App Configuration"
2022-07-11 05:39:28 -04:00
label : "User Management and SMTP"
schema :
additional_attrs : true
type : dict
attrs :
- variable : N8N_USER_MANAGEMENT_DISABLED
label : "Disable User Management"
description : "Set to true to disable the user management feature. Note that n8n ignores this environment variable if you have already set up an owner account."
schema :
type : boolean
default : false
- variable : N8N_EMAIL_MODE
label : "Email Mode"
description : "Enable emails."
schema :
type : string
default : "smtp"
- variable : N8N_SMTP_HOST
label : "SMTP Host"
description : "Your SMTP server name"
schema :
type : string
default : ""
- variable : N8N_SMTP_PORT
label : "SMTP Port"
description : "Your SMTP server port"
schema :
type : int
- variable : N8N_SMTP_USER
label : "SMTP User"
description : "Your SMTP username"
schema :
type : string
default : ""
- variable : N8N_SMTP_PASS
label : "SMTP Pass"
description : "Your SMTP password"
schema :
type : string
private : true
default : ""
- variable : N8N_SMTP_SENDER
label : "SMTP Sender"
description : "You can select the sender name from the sender addresses."
schema :
type : string
default : ""
- variable : N8N_SMTP_SSL
label : "SMTP SSL"
description : "Whether to use SSL for SMTP."
schema :
type : boolean
default : true
- variable : N8N_UM_EMAIL_TEMPLATES_INVITE
label : "Invite Email Templates (Leave empty for default)"
description : "Full path to your HTML email template. This overrides the default template for invite emails."
schema :
type : string
default : ""
- variable : N8N_UM_EMAIL_TEMPLATES_PWRESET
label : "Password Reset Email Templates (Leave empty for default)"
description : "Full path to your HTML email template. This overrides the default template for password reset emails."
schema :
type : string
default : ""
2022-01-27 17:39:58 -05:00
# Include{containerConfig}
2022-08-08 17:25:02 -04:00
# Include{serviceRoot}
2022-01-27 17:39:58 -05:00
- variable : main
label : "Main Service"
description : "The Primary service on which the healthcheck runs, often the webUI"
schema :
additional_attrs : true
type : dict
attrs :
2022-09-17 07:24:06 -04:00
# Include{serviceSelectorLoadBalancer}
2022-09-14 17:27:12 -04:00
# Include{serviceSelectorExtras}
2022-01-27 17:39:58 -05:00
- variable : main
label : "Main Service Port Configuration"
schema :
additional_attrs : true
type : dict
attrs :
- variable : port
label : "Port"
description : "This port exposes the container port on the service"
schema :
type : int
default : 5678
required : true
2022-08-08 17:25:02 -04:00
# Include{serviceExpertRoot}
2022-01-27 17:39:58 -05:00
default : false
# Include{serviceExpert}
# Include{serviceList}
2022-08-08 17:25:02 -04:00
# Include{persistenceRoot}
2022-01-27 17:39:58 -05:00
- variable : data
label : "App Data Storage"
description : "Stores the Application Data."
schema :
additional_attrs : true
type : dict
attrs :
# Include{persistenceBasic}
# Include{persistenceList}
2022-08-08 17:25:02 -04:00
# Include{ingressRoot}
2022-01-27 17:39:58 -05:00
- variable : main
label : "Main Ingress"
schema :
additional_attrs : true
type : dict
attrs :
# Include{ingressDefault}
# Include{ingressTLS}
# Include{ingressTraefik}
2022-11-11 13:09:57 -05:00
# Include{ingressList}
2022-03-03 09:04:31 -05:00
# Include{security}
2022-08-08 17:25:02 -04:00
# Include{securityContextAdvancedRoot}
2022-01-27 17:39:58 -05:00
- variable : privileged
label : "Privileged mode"
schema :
type : boolean
default : false
- variable : readOnlyRootFilesystem
label : "ReadOnly Root Filesystem"
schema :
type : boolean
default : false
- variable : allowPrivilegeEscalation
label : "Allow Privilege Escalation"
schema :
type : boolean
default : false
- variable : runAsNonRoot
label : "runAsNonRoot"
schema :
type : boolean
default : false
2022-08-08 17:25:02 -04:00
# Include{podSecurityContextRoot}
2022-01-27 17:39:58 -05:00
- variable : runAsUser
label : "runAsUser"
description : "The UserID of the user running the application"
schema :
type : int
default : 0
- variable : runAsGroup
label : "runAsGroup"
2022-04-20 03:35:54 -04:00
description : "The groupID this App of the user running the application"
2022-01-27 17:39:58 -05:00
schema :
type : int
2022-01-30 07:58:04 -05:00
default : 568
2022-01-27 17:39:58 -05:00
- variable : fsGroup
label : "fsGroup"
description : "The group that should own ALL storage."
schema :
type : int
2022-01-30 07:58:04 -05:00
default : 1000
2022-01-27 17:39:58 -05:00
# Include{podSecurityContextAdvanced}
# Include{resources}
# Include{advanced}
# Include{addons}
2022-10-01 17:39:52 -04:00
# Include{codeserver}
# Include{vpn}
2022-08-12 07:15:27 -04:00
# Include{documentation}