diff --git a/docs/_extra/css/extra.css b/docs/_extra/css/extra.css index eeb01ad1b..0dd20aab8 100644 --- a/docs/_extra/css/extra.css +++ b/docs/_extra/css/extra.css @@ -174,6 +174,14 @@ .md-typeset table:not([class]) { font-size: 0.75rem } + + .md-typeset__table { + width: 100%; + } + + .md-typeset__table table:not([class]) { + display: table + } /* img borders */ diff --git a/docs/hosting/configuration/configuration-examples/base-url.md b/docs/hosting/configuration/configuration-examples/base-url.md index cbe9856f0..6deb5b420 100644 --- a/docs/hosting/configuration/configuration-examples/base-url.md +++ b/docs/hosting/configuration/configuration-examples/base-url.md @@ -15,4 +15,4 @@ You can configure the Base URL that the front end uses to connect to the back en ```bash export VUE_APP_URL_BASE_API=https://n8n.example.com/ ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#deployment) for more information on this variable. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/custom-nodes-location.md b/docs/hosting/configuration/configuration-examples/custom-nodes-location.md index 379f4dd99..fee49425e 100644 --- a/docs/hosting/configuration/configuration-examples/custom-nodes-location.md +++ b/docs/hosting/configuration/configuration-examples/custom-nodes-location.md @@ -14,4 +14,4 @@ You can define more folders with an environment variable: ```bash export N8N_CUSTOM_EXTENSIONS="/home/jim/n8n/custom-nodes;/data/n8n/nodes" ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#nodes) for more information on this variable. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/nodes) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/encryption-key.md b/docs/hosting/configuration/configuration-examples/encryption-key.md index 3fc50a5bb..e2e8e2c0c 100644 --- a/docs/hosting/configuration/configuration-examples/encryption-key.md +++ b/docs/hosting/configuration/configuration-examples/encryption-key.md @@ -17,4 +17,4 @@ In [queue mode](https://docs.n8n.io/hosting/scaling/queue-mode/), you must speci ```bash export N8N_ENCRYPTION_KEY= ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#deployment) for more information on this variable. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/execution-timeout.md b/docs/hosting/configuration/configuration-examples/execution-timeout.md index a95c34881..9d2786be9 100644 --- a/docs/hosting/configuration/configuration-examples/execution-timeout.md +++ b/docs/hosting/configuration/configuration-examples/execution-timeout.md @@ -19,4 +19,4 @@ You can also set maximum execution time (in seconds) for each workflow individua ```bash export EXECUTIONS_TIMEOUT_MAX=7200 ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#executions) for more information on these variables. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/executions) for more information on these variables. diff --git a/docs/hosting/configuration/configuration-examples/isolation.md b/docs/hosting/configuration/configuration-examples/isolation.md index 5d86622c6..955c8e376 100644 --- a/docs/hosting/configuration/configuration-examples/isolation.md +++ b/docs/hosting/configuration/configuration-examples/isolation.md @@ -26,4 +26,4 @@ N8N_DIAGNOSTICS_CONFIG_FRONTEND= N8N_DIAGNOSTICS_CONFIG_BACKEND= ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#deployment) for more information on these variables. +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment) for more information on these variables. diff --git a/docs/hosting/configuration/configuration-examples/modules-in-code-node.md b/docs/hosting/configuration/configuration-examples/modules-in-code-node.md index f0656733e..10bbbf638 100644 --- a/docs/hosting/configuration/configuration-examples/modules-in-code-node.md +++ b/docs/hosting/configuration/configuration-examples/modules-in-code-node.md @@ -24,4 +24,4 @@ export NODE_FUNCTION_ALLOW_BUILTIN=crypto,fs # Allow usage of external npm modules. export NODE_FUNCTION_ALLOW_EXTERNAL=moment,lodash ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#nodes) for more information on these variables. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/nodes) for more information on these variables. diff --git a/docs/hosting/configuration/configuration-examples/prometheus.md b/docs/hosting/configuration/configuration-examples/prometheus.md index 62ec671ce..b5d02ff2b 100644 --- a/docs/hosting/configuration/configuration-examples/prometheus.md +++ b/docs/hosting/configuration/configuration-examples/prometheus.md @@ -17,4 +17,4 @@ The `/metrics` endpoint is disabled by default, but it's possible to enable it u export N8N_METRICS=true ``` -Refer to the respective [Environment Variables](/hosting/configuration/environment-variables/#endpoints) (`N8N_METRICS_INCLUDE_*`) for configuring which metrics and labels should get exposed. +Refer to the respective [Environment Variables](/hosting/configuration/environment-variables/endpoints) (`N8N_METRICS_INCLUDE_*`) for configuring which metrics and labels should get exposed. diff --git a/docs/hosting/configuration/configuration-examples/time-zone.md b/docs/hosting/configuration/configuration-examples/time-zone.md index 7eddc399d..f70dc7916 100644 --- a/docs/hosting/configuration/configuration-examples/time-zone.md +++ b/docs/hosting/configuration/configuration-examples/time-zone.md @@ -14,4 +14,4 @@ export GENERIC_TIMEZONE=Europe/Berlin You can find the name of your timezone [here](https://momentjs.com/timezone/). -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#timezone-and-localization) for more information on this variable. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/timezone-and-localization) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/user-folder.md b/docs/hosting/configuration/configuration-examples/user-folder.md index 56d0456e8..f752af4f8 100644 --- a/docs/hosting/configuration/configuration-examples/user-folder.md +++ b/docs/hosting/configuration/configuration-examples/user-folder.md @@ -12,4 +12,4 @@ the ID of the tunnel (if used) in the subfolder `.n8n` of the user who started n ```bash export N8N_USER_FOLDER=/home/jim/n8n ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#deployment) for more information on this variable. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/deployment) for more information on this variable. diff --git a/docs/hosting/configuration/configuration-examples/webhook-url.md b/docs/hosting/configuration/configuration-examples/webhook-url.md index 25ce7f3a8..b8f3eb23a 100644 --- a/docs/hosting/configuration/configuration-examples/webhook-url.md +++ b/docs/hosting/configuration/configuration-examples/webhook-url.md @@ -11,4 +11,4 @@ n8n creates the webhook URL by combining `N8N_PROTOCOL`, `N8N_HOST` and `N8N_POR ```bash export WEBHOOK_URL=https://n8n.example.com/ ``` -Refer to [Environment variables reference](/hosting/configuration/environment-variables/#endpoints) for more information on this variable. \ No newline at end of file +Refer to [Environment variables reference](/hosting/configuration/environment-variables/endpoints) for more information on this variable. diff --git a/docs/hosting/configuration/environment-variables.md b/docs/hosting/configuration/environment-variables.md deleted file mode 100644 index e125da933..000000000 --- a/docs/hosting/configuration/environment-variables.md +++ /dev/null @@ -1,296 +0,0 @@ ---- -description: Configuration environment variables for self-hosted n8n. -contentType: reference -tags: - - environment variables -hide: - - tags ---- - -# Configuration environment variables - -/// note | File-based configuration -You can provide a [configuration file](/hosting/configuration/configuration-methods/) for n8n. You can also append `_FILE` to certain variables to provide their configuration in a separate file. Variables that support this have the "/`_FILE`" option listed below. -/// -## Credentials - -Enabling overwrites for credentials allows you to set default values for credentials which get automatically populated. The user can't see or change these credentials. The format is `{ CREDENTIAL_NAME: { PARAMETER: VALUE }}`. - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `CREDENTIALS_OVERWRITE_DATA`
/`_FILE` | * | - | Overwrites for credentials. | -| `CREDENTIALS_OVERWRITE_ENDPOINT` | String | - | The API endpoint to fetch credentials. | -| `CREDENTIALS_DEFAULT_NAME` | String | `My credentials` | The default name for credentials. | - -## Database - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `DB_TYPE`
/`_FILE` | Enum string:
`sqlite`, `postgresdb` | `sqlite` | The database to use. | -| `DB_TABLE_PREFIX` | * | - | Prefix to use for table names. | - -### PostgreSQL - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `DB_POSTGRESDB_DATABASE`
/`_FILE` | String | `n8n` | The name of the PostgreSQL database. Default value is `n8n`. | -| `DB_POSTGRESDB_HOST`
/`_FILE` | String | `localhost` | The PostgreSQL host. Default value is `localhost`. | -| `DB_POSTGRESDB_PORT`
/`_FILE` | Number | `5432` | The PostgreSQL port. Default value is `5432`. | -| `DB_POSTGRESDB_USER`
/`_FILE` | String | `root` | The PostgreSQL user. Default value is `root`. | -| `DB_POSTGRESDB_PASSWORD`
/`_FILE` | String | - | The PostgreSQL password. | -| `DB_POSTGRESDB_SCHEMA`
/`_FILE` | String | `public` | The PostgreSQL schema. Default value is `public`. | -| `DB_POSTGRESDB_SSL_CA`
/`_FILE` | String | - | The PostgreSQL SSL certificate authority. | -| `DB_POSTGRESDB_SSL_CERT`
/`_FILE` | String | - | The PostgreSQL SSL certificate. | -| `DB_POSTGRESDB_SSL_KEY`
/`_FILE` | String | - | The PostgreSQL SSL key. | -| `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED`
/`_FILE` | Boolean | `true` | If n8n should reject unauthorized SSL connections (true) or not (false). | - -### SQLite - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `DB_SQLITE_VACUUM_ON_STARTUP` | Boolean | `false` | Runs [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target="_blank" .external-link} operation on startup to rebuild the database. Reduces file size and optimizes indexes. This is a long running blocking operation and increases start-up time. | - -## Deployment - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_EDITOR_BASE_URL` | String | - | Public URL where users can access the editor. Also used for emails sent from n8n. | -| `N8N_CONFIG_FILES` | String | - | Use to provide the path to any JSON [configuration file](/hosting/configuration/configuration-methods/). | -| `N8N_DISABLE_UI` | Boolean | `false` | Disable the UI (true) or not (false). | -| `N8N_TEMPLATES_ENABLED` | Boolean | `true` | Enable workflow templates (true) or disable (false). | -| `N8N_TEMPLATES_HOST` | String | `https://api.n8n.io` | Change this if creating your own workflow template library. Note that to use your own workflow templates library, your API must provide the same endpoints and response structure as n8n's. Refer to [Workflow templates](/workflows/templates/) for more information. | -| `N8N_ENCRYPTION_KEY` | String | Random key generated by n8n | Provide a custom key used to encrypt credentials in the n8n database. By default n8n generates a random key on first launch. | -| `N8N_USER_FOLDER` | String | `user-folder` | Provide the path where n8n will create the `.n8n` folder. This directory stores user-specific data, such as database file and encryption key. | -| `N8N_PATH` | String | `/` | The path n8n deploys to. | -| `N8N_HOST` | String | `localhost` | Host name n8n runs on. | -| `N8N_PORT` | Number | `5678` | The HTTP port n8n runs on. | -| `N8N_LISTEN_ADDRESS` | String | `0.0.0.0` | The IP address n8n should listen on. | -| `N8N_PROTOCOL` | Enum string: `http`, `https` | `http` | The protocol used to reach n8n. | -| `N8N_SSL_KEY` | String | - | The SSL key for HTTPS protocol. | -| `N8N_SSL_CERT` | String | - | The SSL certificate for HTTPS protocol. | -| `N8N_PERSONALIZATION_ENABLED` | Boolean | `true` | Whether to ask users personalisation questions and then customise n8n accordingly. | -| `N8N_VERSION_NOTIFICATIONS_ENABLED` | Boolean | `true` | When enabled, n8n sends notifications of new versions and security updates. | -| `N8N_VERSION_NOTIFICATIONS_ENDPOINT` | String | `https://api.n8n.io/versions/` | The endpoint to retrieve where version information. | -| `N8N_VERSION_NOTIFICATIONS_INFO_URL` | String | `https://docs.n8n.io/getting-started/installation/updating.html` | The URL displayed in the New Versions panel for additional information. | -| `N8N_DIAGNOSTICS_ENABLED` | Boolean | `true` | Whether to share selected, anonymous [telemetry](/privacy-security/privacy/) with n8n | -| `N8N_DIAGNOSTICS_CONFIG_FRONTEND` | String | `1zPn9bgWPzlQc0p8Gj1uiK6DOTn;https://telemetry.n8n.io` | Telemetry configuration for the frontend. | -| `N8N_DIAGNOSTICS_CONFIG_BACKEND` | String | `1zPn7YoGC3ZXE9zLeTKLuQCB4F6;https://telemetry.n8n.io/v1/batch` | Telemetry configuration for the backend. | -| `N8N_PUSH_BACKEND` | String | `websocket` | Choose whether the n8n backend uses server-sent events (`sse`) or WebSockets (`websocket`) to send changes to the UI. | -| `VUE_APP_URL_BASE_API` | String | `http://localhost:5678/` | Used when building the `n8n-editor-ui` package manually to set how the frontend can reach the backend API. | -| `N8N_HIRING_BANNER_ENABLED` | Boolean | `true` | Whether to show the n8n hiring banner in the console (true) or not (false). | -| `N8N_PUBLIC_API_SWAGGERUI_DISABLED` | Boolean | `false` | Whether the Swagger UI (API playground) is disabled (true) or not (false). | -| `N8N_PUBLIC_API_DISABLED` | Boolean | `false` | Whether to disable the public API (false) or not (true). | -| `N8N_PUBLIC_API_ENDPOINT` | String | `api` | Path for the public API endpoints. | -| `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | Number | `30` | How long should the n8n process wait (in seconds) for components to shut down before exiting the process. | - -## Binary data - -By default, n8n uses memory to store binary data. Enterprise users can choose to use an external service instead. Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data. - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_AVAILABLE_BINARY_DATA_MODES` | String | `filesystem` | A comma separated list of available binary data modes. | -| `N8N_BINARY_DATA_STORAGE_PATH` | String | `N8N_USE_FOLDER/binaryData` | The path where n8n stores binary data. | -| `N8N_DEFAULT_BINARY_DATA_MODE` | String | `default` | The default binary data mode. `default` keeps binary data in memory. Set to `filesystem` to use the filesystem, or `s3` to AWS S3. | - -## User management SMTP, and two-factor authentication - -Refer to [User management](/hosting/configuration/user-management-self-hosted/) for more information on setting up user management and emails. - -| Variable | Type | Default | Description | -| :------- | :--- | :------ | :---------- | -| `N8N_EMAIL_MODE` | String | `smtp` | Enable emails. | -| `N8N_SMTP_HOST` | String | - | _your_SMTP_server_name_ | -| `N8N_SMTP_PORT` | Number | - | _your_SMTP_server_port_ | -| `N8N_SMTP_USER` | String | - | _your_SMTP_username_ | -| `N8N_SMTP_PASS` | String | - | _your_SMTP_password_ | -| `N8N_SMTP_OAUTH_SERVICE_CLIENT` | String | - | If using 2LO with a service account this is your client ID | -| `N8N_SMTP_OAUTH_PRIVATE_KEY` | String | - | If using 2LO with a service account this is your private key | -| `N8N_SMTP_SENDER` | String | - | Sender email address. You can optionally include the sender name. Example with name: _N8N ``_ | -| `N8N_SMTP_SSL` | Boolean | `true` | Whether to use SSL for SMTP (true) or not (false). | -| `N8N_UM_EMAIL_TEMPLATES_INVITE` | String | - | Full path to your HTML email template. This overrides the default template for invite emails. | -| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | String | - | Full path to your HTML email template. This overrides the default template for password reset emails. | -| `N8N_UM_EMAIL_TEMPLATES_WORKFLOW_SHARED` | String | - | Overrides the default HTML template for notifying users that a workflow was shared. Provide the full path to the template. | -| `N8N_UM_EMAIL_TEMPLATES_CREDENTIALS_SHARED` | String | - | Overrides the default HTML template for notifying users that a credential was shared. Provide the full path to the template. | -| `N8N_USER_MANAGEMENT_JWT_SECRET` | String | - | Set a specific JWT secret. By default, n8n generates one on start. | -| `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS` | Number | 168 | Set an expiration date for the JWTs in hours. | -| `N8N_USER_MANAGEMENT_JWT_REFRESH_TIMEOUT_HOURS` | Number | 0 | How many hours before the JWT expires to automatically refresh it. 0 means 25% of `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. -1 means it will never refresh, which forces users to log in again after the period defined in `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. | -| `N8N_MFA_ENABLED` | Boolean | `true` | Whether to enable two-factor authentication (true) or disable (false). n8n ignores this if existing users have 2FA enabled. | - - -## Endpoints - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_PAYLOAD_SIZE_MAX` | Number | `16` | The maximum payload size in MB. | -| `N8N_METRICS` | Boolean | `false` | Whether to enable the `/metrics` endpoint. | -| `N8N_METRICS_PREFIX` | String | `n8n_` | Optional prefix for n8n specific metrics names. | -| `N8N_METRICS_INCLUDE_DEFAULT_METRICS` | Boolean | `true` | Whether to expose default system and node.js metrics. | -| `N8N_METRICS_INCLUDE_CACHE_METRICS` | Boolean | false | Whether to include metrics (true) for cache hits and misses, or not include them (false). | -| `N8N_METRICS_INCLUDE_MESSAGE_EVENT_BUS_METRICS` | Boolean | `false` | Whether to include metrics (true) for events, or not include them (false). | -| `N8N_METRICS_INCLUDE_WORKFLOW_ID_LABEL` | Boolean | `false` | Whether to include a label for the workflow ID on workflow metrics. | -| `N8N_METRICS_INCLUDE_NODE_TYPE_LABEL` | Boolean | `false` | Whether to include a label for the node type on node metrics. | -| `N8N_METRICS_INCLUDE_CREDENTIAL_TYPE_LABEL` | Boolean | `false` | Whether to include a label for the credential type on credential metrics. | -| `N8N_METRICS_INCLUDE_API_ENDPOINTS` | Boolean | `false` | Whether to expose metrics for API endpoints. | -| `N8N_METRICS_INCLUDE_API_PATH_LABEL` | Boolean | `false` | Whether to include a label for the path of API invocations. | -| `N8N_METRICS_INCLUDE_API_METHOD_LABEL` | Boolean | `false` | Whether to include a label for the HTTP method (GET, POST, ...) of API invocations. | -| `N8N_METRICS_INCLUDE_API_STATUS_CODE_LABEL` | Boolean | `false` | Whether to include a label for the HTTP status code (200, 404, ...) of API invocations. | -| `N8N_ENDPOINT_REST` | String | `rest` | The path used for REST endpoint. | -| `N8N_ENDPOINT_WEBHOOK` | String | `webhook` | The path used for webhook endpoint. | -| `N8N_ENDPOINT_WEBHOOK_TEST` | String | `webhook-test` | The path used for test-webhook endpoint. | -| `N8N_ENDPOINT_WEBHOOK_WAIT` | String | `webhook-waiting` | The path used for waiting-webhook endpoint. | -| `WEBHOOK_URL` | String | - | Used to manually provide the Webhook URL when running n8n behind a reverse proxy. See [here](/hosting/configuration/configuration-examples/webhook-url) for more details. | -| `N8N_DISABLE_PRODUCTION_MAIN_PROCESS` | Boolean | `false` | Disable production webhooks from main process. This helps ensure no HTTP traffic load to main process when using webhook-specific processes. | - -## External hooks - -| Variable | Type | Description | -| :------- | :---- | :---------- | -| `EXTERNAL_HOOK_FILES` | String | Files containing external hooks. Provide multiple files as a colon-separated list ("`:`"). | - -## Executions - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `EXECUTIONS_MODE` | Enum string: `regular`, `queue` | `regular` | Whether executions should run directly or using queue.

Refer to [Queue mode](/hosting/scaling/queue-mode/) for more details. | -| `EXECUTIONS_TIMEOUT` | Number | `-1` | Sets a default timeout (in seconds) to all workflows after which n8n stops their execution. Users can override this for individual workflows up to the duration set in `EXECUTIONS_TIMEOUT_MAX`. Set `EXECUTIONS_TIMEOUT` to `-1` to disable. | -| `EXECUTIONS_TIMEOUT_MAX` | Number | `3600` | The maximum execution time (in seconds) that users can set for an individual workflow. | -| `EXECUTIONS_DATA_SAVE_ON_ERROR` | Enum string: `all`, `none` | `all` | Whether n8n saves execution data on error. | -| `EXECUTIONS_DATA_SAVE_ON_SUCCESS` | Enum string: `all`, `none` | `all` | Whether n8n saves execution data on success. | -| `EXECUTIONS_DATA_SAVE_ON_PROGRESS` | Boolean | `false` | Whether to save progress for each node executed (true) or not (false). | -| `EXECUTIONS_DATA_SAVE_MANUAL_EXECUTIONS` | Boolean | `true` | Whether to save data of executions when started manually. | -| `EXECUTIONS_DATA_PRUNE` | Boolean | `true` | Whether to delete data of past executions on a rolling basis. | -| `EXECUTIONS_DATA_MAX_AGE` | Number | `336` | The execution age (in hours) before it's deleted. | -| `EXECUTIONS_DATA_PRUNE_MAX_COUNT` | Number | `10000` | Maximum number of executions to keep in the database. 0 = no limit | -| `EXECUTIONS_DATA_HARD_DELETE_BUFFER` | Number | `1` | How old (hours) the finished execution data has to be to get hard-deleted. By default, this buffer excludes recent executions as the user may need them while building a workflow. | -| `EXECUTIONS_DATA_PRUNE_HARD_DELETE_INTERVAL` | Number | `15` | How often (minutes) execution data should be hard-deleted. | -| `EXECUTIONS_DATA_PRUNE_SOFT_DELETE_INTERVAL` | Number | `60` | How often (minutes) execution data should be soft-deleted. | - -## Logs - -### n8n logs - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_LOG_LEVEL` | Enum string: `info`, `warn`, `error`, `verbose`, `debug` | `info` | Log output level. | -| `N8N_LOG_OUTPUT` | Enum string: `console`, `file` | `console` | Where to output logs. Provide multiple values as a comma-seperated list. | -| `N8N_LOG_FILE_COUNT_MAX` | Number | `100` | Max number of log files to keep. | -| `N8N_LOG_FILE_SIZE_MAX` | Number | `16` | Max size of each log file in MB. | -| `N8N_LOG_FILE_LOCATION` | String | `file` | Log file location. Requires N8N_LOG_OUTPUT set to `file`. | -| `DB_LOGGING_ENABLED` | Boolean | `false` | Whether to enable database-specific logging. | -| `DB_LOGGING_OPTIONS` | Enum string: `query`, `error`, `schema`, `warn`, `info`, `log` | `error` | Database log output level. To enable all logging, specify `all`. | -| `DB_LOGGING_MAX_EXECUTION_TIME` | Number | `1000` | Maximum execution time (in milliseconds) before n8n logs a warning. Set to `0` to disable long running query warning. | - -### Log streaming - -Refer to [Log streaming](/log-streaming/) for more information on this feature. - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_EVENTBUS_CHECKUNSENTINTERVAL` | Number | `0` | How often (in milliseconds) to check for unsent event messages. Can in rare cases cause a message to be sent twice. Set to `0` to disable it. | -| `N8N_EVENTBUS_LOGWRITER_SYNCFILEACCESS` | Boolean | `false` | Whether all file access happens synchronously within the thread (true) or not (false). | -| `N8N_EVENTBUS_LOGWRITER_KEEPLOGCOUNT` | Number | `3` | How many event log files to keep. | -| `N8N_EVENTBUS_LOGWRITER_MAXFILESIZEINKB` | Number | `10240` | Maximum size (in kilo-bytes) of an event log file before a new one is started. | -| `N8N_EVENTBUS_LOGWRITER_LOGBASENAME` | String | `n8nEventLog` | Basename of the event log file. | - -## External data storage - -Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data. - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_EXTERNAL_STORAGE_S3_HOST` | String | - | Host of the n8n bucket in S3-compatible external storage. For example, `s3.us-east-1.amazonaws.com` | -| `N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME` | String | - | Name of the n8n bucket in S3-compatible external storage. | -| `N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION` | String | - | Region of the n8n bucket in S3-compatible external storage. For example, `us-east-1`| -| `N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY` | String | - | Access key in S3-compatible external storage | -| `N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET` | String | - | Access secret in S3-compatible external storage. | - - -## Nodes - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `NODES_INCLUDE` | Array of strings | - | Specify which nodes to load. | -| `NODES_EXCLUDE` | Array of strings | - | Specify which nodes not to load. For example, to block nodes that can be a security risk if users aren't trustworthy: `NODES_EXCLUDE: "[\"n8n-nodes-base.executeCommand\", \"n8n-nodes-base.filesreadwrite\"]"` | -| `NODE_FUNCTION_ALLOW_BUILTIN` | String | - | Permit users to import specific built-in modules in the Code node. Use * to allow all. n8n disables importing modules by default. | -| `NODE_FUNCTION_ALLOW_EXTERNAL` | String | - | Permit users to import specific external modules (from `n8n/node_modules`) in the Code node. n8n disables importing modules by default. | -| `NODES_ERROR_TRIGGER_TYPE` | String | `n8n-nodes-base.errorTrigger` | Specify which node type to use as Error Trigger. | -| `N8N_CUSTOM_EXTENSIONS` | String | - | Specify the path to additional directories containing your custom nodes. | -| `N8N_COMMUNITY_PACKAGES_ENABLED` | Boolean | `true` | Whether community nodes are enabled (true) or not (false). | - -## Queue mode - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `QUEUE_BULL_PREFIX` | String | - | Prefix to use for all queue keys. | -| `QUEUE_BULL_REDIS_DB` | Number | `0` | The Redis database used. | -| `QUEUE_BULL_REDIS_HOST` | String | `localhost` | The Redis host. | -| `QUEUE_BULL_REDIS_PORT` | Number | `6379` | The Redis port used. | -| `QUEUE_BULL_REDIS_USERNAME` | String | - | The Redis username (needs Redis version 6 or above). Don't define it for Redis < 6 compatibility | -| `QUEUE_BULL_REDIS_PASSWORD` | String | - | The Redis password. | -| `QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD` | Number | `10000` | The Redis timeout threshold (in seconds). | -| `QUEUE_BULL_REDIS_CLUSTER_NODES` | String | - | Expects a comma-separated list of Redis Cluster nodes in the format `host:port`, for the Redis client to initially connect to. If running in queue mode (`EXECUTIONS_MODE = queue`), setting this variable will create a Redis Cluster client instead of a Redis client, and n8n will ignore `QUEUE_BULL_REDIS_HOST` and `QUEUE_BULL_REDIS_PORT`. | -| `QUEUE_BULL_REDIS_TLS` | Boolean | `false` | Enable TLS on Redis connections. | -| `QUEUE_RECOVERY_INTERVAL` | Number | `60` | Interval (in seconds) for active polling to the queue to recover from Redis crashes. `0` disables recovery. May increase Redis traffic significantly. | -| `QUEUE_WORKER_TIMEOUT` (**deprecated**) | Number | `30` | **Deprecated** Use `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` instead.

How long should n8n wait (seconds) for running executions before exiting worker process on shutdown. | -| `QUEUE_HEALTH_CHECK_ACTIVE` | Boolean | `false` | Whether to enable health checks (true) or disable (false). | -| `QUEUE_HEALTH_CHECK_PORT` | Number | - | The port to serve health checks on. | -| `QUEUE_WORKER_LOCK_DURATION` | Number | `30000` | How long (in ms) is the lease period for a worker to work on a message. | -| `QUEUE_WORKER_LOCK_RENEW_TIME` | Number | `15000` | How frequently (in ms) should a worker renew the lease time. | -| `QUEUE_WORKER_STALLED_INTERVAL` | Number | `30000` | How often should a worker check for stalled jobs (use 0 for never). | -| `QUEUE_WORKER_MAX_STALLED_COUNT` | Number | `1` | Maximum amount of times a stalled job will be re-processed. | - -### Multi-main setup - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_MULTI_MAIN_SETUP_ENABLED` | Boolean | `false` | Whether to enable multi-main setup for queue mode (license required). | -| `N8N_MULTI_MAIN_SETUP_KEY_TTL` | Number | `10` | Time to live (in seconds) for leader key in multi-main setup. | -| `N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL` | Number | `3` | Interval (in seconds) for leader check in multi-main setup. | - -## Security - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_AUTH_EXCLUDE_ENDPOINTS` | String | - | Exclude endpoints from authentication checks. Provide multiple endpoints as a colon-seperated list ("`:`"). The endpoints must not start with a forward slash ("`/`"). | -| `N8N_BLOCK_ENV_ACCESS_IN_NODE` | Boolean | `false` | Whether to allow users to access environment variables in expressions and the Code node (false) or not (true). | - -## Source control - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_SOURCECONTROL_DEFAULT_SSH_KEY_TYPE` | String | `ed25519` | Set to `rsa` to make RSA the default SSH key type for [Source control setup](/source-control-environments/setup/). | - -## External secrets - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_EXTERNAL_SECRETS_UPDATE_INTERVAL` | Number | `300` (5 minutes) | How often (in seconds) to check for secret updates. | - -## Timezone and localization - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `GENERIC_TIMEZONE` | * | `America/New_York` |The n8n instance timezone. Important for schedule nodes (such as Cron). | -| `N8N_DEFAULT_LOCALE` | String | `en` | A locale identifier, compatible with the [Accept-Language header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Accept-Language){:target="_blank" .external-link}. n8n doesn't support regional identifiers, such as `de-AT`. When running in a locale other than the default, n8n displays UI strings in the selected locale, and falls back to `en` for any untranslated strings. | - -## Workflows - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `WORKFLOWS_DEFAULT_NAME` | String | `My workflow` | The default name used for new workflows. | -| `N8N_ONBOARDING_FLOW_DISABLED` | Boolean | `false` | Whether to show onboarding tips when creating a new workflow (true) or not (false). | -| `N8N_WORKFLOW_TAGS_DISABLED` | Boolean | `false` | Whether to disable workflow tags (true) or enable tags (false). | -| `N8N_WORKFLOW_CALLER_POLICY_DEFAULT_OPTION` | String | `workflowsFromSameOwner` | Which workflows can call a workflow. Options are: `any`, `none`, `workflowsFromAList`, `workflowsFromSameOwner`. This feature requires [Workflow sharing](/workflows/sharing/). | - -## License - -| Variable | Type | Default | Description | -| :------- | :---- | :------- | :---------- | -| `N8N_HIDE_USAGE_PAGE` | boolean | `false` | Hide the usage and plans page in the app. | -| `N8N_LICENSE_ACTIVATION_KEY` | String | `''` | Activation key to initialize license. Not applicable if the n8n instance was already activated. | -| `N8N_LICENSE_AUTO_RENEW_ENABLED` | Boolean | `true` | Whether autorenew for licenses is enabled (true) or not (false). | -| `N8N_LICENSE_AUTO_RENEW_OFFSET` | Number | `60 * 60 * 72` (72 hours) | How many seconds before expiry a license should automatically renew. | -| `N8N_LICENSE_SERVER_URL` | String | `http://license.n8n.io/v1` | Server URL to retrieve license. | - - diff --git a/docs/hosting/configuration/environment-variables/binary-data.md b/docs/hosting/configuration/environment-variables/binary-data.md index a63517e86..25f6c779f 100644 --- a/docs/hosting/configuration/environment-variables/binary-data.md +++ b/docs/hosting/configuration/environment-variables/binary-data.md @@ -1,12 +1,15 @@ --- -title: Managing binary data -description: Environment variables to customize binary data storage modes and paths. +title: Binary data environment variables +description: Customize binary data storage modes and paths with environment variables for your self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Managing binary data +# Binary data environment variables By default, n8n uses memory to store binary data. Enterprise users can choose to use an external service instead. Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data. @@ -14,4 +17,4 @@ By default, n8n uses memory to store binary data. Enterprise users can choose to | :------- | :---- | :------- | :---------- | | `N8N_AVAILABLE_BINARY_DATA_MODES` | String | `filesystem` | A comma separated list of available binary data modes. | | `N8N_BINARY_DATA_STORAGE_PATH` | String | `N8N_USE_FOLDER/binaryData` | The path where n8n stores binary data. | -| `N8N_DEFAULT_BINARY_DATA_MODE` | String | `default` | The default binary data mode. `default` keeps binary data in memory. Set to `filesystem` to use the filesystem, or `s3` to AWS S3. | \ No newline at end of file +| `N8N_DEFAULT_BINARY_DATA_MODE` | String | `default` | The default binary data mode. `default` keeps binary data in memory. Set to `filesystem` to use the filesystem, or `s3` to AWS S3. | diff --git a/docs/hosting/configuration/environment-variables/credentials.md b/docs/hosting/configuration/environment-variables/credentials.md index 16123f51d..8e79e1384 100644 --- a/docs/hosting/configuration/environment-variables/credentials.md +++ b/docs/hosting/configuration/environment-variables/credentials.md @@ -1,14 +1,18 @@ --- -title: Managing credentials +title: Credentials environment variables description: Manage default credentials and override them through environment variables your self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Managing credentials +# Credentials environment variables -Enabling overwrites for credentials allows you to set default values for credentials which get automatically populated. The user can't see or change these credentials. The format is `{ CREDENTIAL_NAME: { PARAMETER: VALUE }}`. +Enabling overwrites for credentials allows you to set default values for credentials which get automatically populated. The user can't see or change these credentials. +The format is `{ CREDENTIAL_NAME: { PARAMETER: VALUE }}`. | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/database.md b/docs/hosting/configuration/environment-variables/database.md index faec6c272..fc109bd6f 100644 --- a/docs/hosting/configuration/environment-variables/database.md +++ b/docs/hosting/configuration/environment-variables/database.md @@ -1,14 +1,17 @@ --- -title: Database configuration -description: Set up and configure databases for your self-hosted n8n instance. +title: Database environment variables +description: Set up and configure databases with environment variables for your self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Database configuration +# Database environment variables -By default, n8n uses SQLite to save credentials, past executions, and workflows. n8n also supports PostgresDB but has [removed support for MySQL and MariaDB](docs/1-0-migration-checklist). This section outlines environment variables to configure your chosen database for self-hosted n8n instance. +By default, n8n uses **SQLite** to save credentials, past executions, and workflows. n8n also supports **PostgresDB** but has [removed support for MySQL and MariaDB](/docs/1-0-migration-checklist). This section outlines environment variables to configure your chosen database for self-hosted n8n instance. | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | @@ -34,4 +37,4 @@ By default, n8n uses SQLite to save credentials, past executions, and workflows. | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | -| `DB_SQLITE_VACUUM_ON_STARTUP` | Boolean | `false` | Runs [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target="_blank" .external-link} operation on startup to rebuild the database. Reduces file size and optimizes indexes. This is a long running blocking operation and increases start-up time. | \ No newline at end of file +| `DB_SQLITE_VACUUM_ON_STARTUP` | Boolean | `false` | Runs [VACUUM](https://www.sqlite.org/lang_vacuum.html){:target="_blank" .external-link} operation on startup to rebuild the database. Reduces file size and optimizes indexes. This is a long running blocking operation and increases start-up time. | diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index 516ed637f..fd54186e2 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -1,12 +1,15 @@ --- -title: Deployment configuration -description: Configure deployment options and application accessibility for self-hosted n8n. +title: Deployment environment variables +description: Configure deployment options and application accessibility with environment variables for your self-hosted n8n intance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Deployment +# Deployment environment variables This section outlines the deployment configurations for self-hosted n8n instance, including setting up access URLs, enabling templates, customizing encryption, and configuring server details. diff --git a/docs/hosting/configuration/environment-variables/endpoints.md b/docs/hosting/configuration/environment-variables/endpoints.md index 8b5f75db1..25dc1932f 100644 --- a/docs/hosting/configuration/environment-variables/endpoints.md +++ b/docs/hosting/configuration/environment-variables/endpoints.md @@ -1,12 +1,15 @@ --- -title: API and Endpoint Configuration -description: Customize the application's API and webhook endpoints. +title: Endpoints environment variables +description: Customize the application's API and webhook endpoints with environment variables for your self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Endpoints +# Endpoints environment variables This section outlines environment variable configurations for setting payload size limits, enabling and customizing metrics, managing REST and webhook endpoints, and providing options for proxy compatibility. @@ -30,4 +33,4 @@ This section outlines environment variable configurations for setting payload si | `N8N_ENDPOINT_WEBHOOK_TEST` | String | `webhook-test` | The path used for test-webhook endpoint. | | `N8N_ENDPOINT_WEBHOOK_WAIT` | String | `webhook-waiting` | The path used for waiting-webhook endpoint. | | `WEBHOOK_URL` | String | - | Used to manually provide the Webhook URL when running n8n behind a reverse proxy. See [here](/hosting/configuration/configuration-examples/webhook-url) for more details. | -| `N8N_DISABLE_PRODUCTION_MAIN_PROCESS` | Boolean | `false` | Disable production webhooks from main process. This helps ensure no HTTP traffic load to main process when using webhook-specific processes. | \ No newline at end of file +| `N8N_DISABLE_PRODUCTION_MAIN_PROCESS` | Boolean | `false` | Disable production webhooks from main process. This helps ensure no HTTP traffic load to main process when using webhook-specific processes. | diff --git a/docs/hosting/configuration/environment-variables/executions.md b/docs/hosting/configuration/environment-variables/executions.md index e702dbad6..0b21c7bf9 100644 --- a/docs/hosting/configuration/environment-variables/executions.md +++ b/docs/hosting/configuration/environment-variables/executions.md @@ -1,12 +1,15 @@ --- -title: Workflow Executions +title: Executions environment variables description: Environment variables to configure settings related to workflow executions. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Executions +# Executions environment variables This section outlines environment variables to configure settings related to workflow executions. @@ -24,4 +27,4 @@ This section outlines environment variables to configure settings related to wor | `EXECUTIONS_DATA_PRUNE_MAX_COUNT` | Number | `10000` | Maximum number of executions to keep in the database. 0 = no limit | | `EXECUTIONS_DATA_HARD_DELETE_BUFFER` | Number | `1` | How old (hours) the finished execution data has to be to get hard-deleted. By default, this buffer excludes recent executions as the user may need them while building a workflow. | | `EXECUTIONS_DATA_PRUNE_HARD_DELETE_INTERVAL` | Number | `15` | How often (minutes) execution data should be hard-deleted. | -| `EXECUTIONS_DATA_PRUNE_SOFT_DELETE_INTERVAL` | Number | `60` | How often (minutes) execution data should be soft-deleted. | \ No newline at end of file +| `EXECUTIONS_DATA_PRUNE_SOFT_DELETE_INTERVAL` | Number | `60` | How often (minutes) execution data should be soft-deleted. | diff --git a/docs/hosting/configuration/environment-variables/external-data-storage.md b/docs/hosting/configuration/environment-variables/external-data-storage.md index 3162a2b27..cb303dc91 100644 --- a/docs/hosting/configuration/environment-variables/external-data-storage.md +++ b/docs/hosting/configuration/environment-variables/external-data-storage.md @@ -1,12 +1,15 @@ --- -title: External data storage -description: +title: External data storage environment variables +description: Environment variables to configure external data storage for your self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# External data storage +# External data storage environment variables Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data. @@ -16,4 +19,4 @@ Refer to [External storage](/hosting/scaling/external-storage/) for more informa | `N8N_EXTERNAL_STORAGE_S3_BUCKET_NAME` | String | - | Name of the n8n bucket in S3-compatible external storage. | | `N8N_EXTERNAL_STORAGE_S3_BUCKET_REGION` | String | - | Region of the n8n bucket in S3-compatible external storage. For example, `us-east-1`| | `N8N_EXTERNAL_STORAGE_S3_ACCESS_KEY` | String | - | Access key in S3-compatible external storage | -| `N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET` | String | - | Access secret in S3-compatible external storage. | \ No newline at end of file +| `N8N_EXTERNAL_STORAGE_S3_ACCESS_SECRET` | String | - | Access secret in S3-compatible external storage. | diff --git a/docs/hosting/configuration/environment-variables/external-hooks.md b/docs/hosting/configuration/environment-variables/external-hooks.md index 98f74ca62..30b95503f 100644 --- a/docs/hosting/configuration/environment-variables/external-hooks.md +++ b/docs/hosting/configuration/environment-variables/external-hooks.md @@ -1,15 +1,18 @@ --- -title: External hooks +title: External hooks environment variables description: Environment variables to integrate external hooks into your self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# External hooks +# External hooks environment variables You can define external hooks that n8n executes whenever a specific operation runs. Refer to [Backend hooks](/embed/configuration/#backend-hooks) for examples of available hooks and [Hook files](/embed/configuration/#hook-files_1) on file formatting. | Variable | Type | Description | | :------- | :---- | :---------- | -| `EXTERNAL_HOOK_FILES` | String | Files containing external hooks. Provide multiple files as a colon-separated list ("`:`"). | \ No newline at end of file +| `EXTERNAL_HOOK_FILES` | String | Files containing external hooks. Provide multiple files as a colon-separated list ("`:`"). | diff --git a/docs/hosting/configuration/environment-variables/external-secrets.md b/docs/hosting/configuration/environment-variables/external-secrets.md index 06d89ed8e..32d6c4265 100644 --- a/docs/hosting/configuration/environment-variables/external-secrets.md +++ b/docs/hosting/configuration/environment-variables/external-secrets.md @@ -1,13 +1,16 @@ --- -title: External secrets +title: External secrets environment variables description: Configure the interval for checking updates to external secrets in self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# External secrets +# External secrets environment variables | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | -| `N8N_EXTERNAL_SECRETS_UPDATE_INTERVAL` | Number | `300` (5 minutes) | How often (in seconds) to check for secret updates. | \ No newline at end of file +| `N8N_EXTERNAL_SECRETS_UPDATE_INTERVAL` | Number | `300` (5 minutes) | How often (in seconds) to check for secret updates. | diff --git a/docs/hosting/configuration/environment-variables/index.md b/docs/hosting/configuration/environment-variables/index.md index f773d5f70..b0694d91b 100644 --- a/docs/hosting/configuration/environment-variables/index.md +++ b/docs/hosting/configuration/environment-variables/index.md @@ -1,12 +1,15 @@ --- -title: Environment Variables +title: Environment Variables Overview description: An overview of configuration environment variables for self-hosted n8n. contentType: overview +tags: + - environment variables hide: - toc + - tags --- -# Environment Variables +# Environment Variables Overview This section contains lists of environment variables that you can use to change n8n's configuration settings. @@ -16,4 +19,4 @@ You can provide a [configuration file](/hosting/configuration/configuration-meth [[% import "_macros/section-toc.html" as sectionToc %]] -[[ sectionToc.sectionToc(page) ]] \ No newline at end of file +[[ sectionToc.sectionToc(page) ]] diff --git a/docs/hosting/configuration/environment-variables/licenses.md b/docs/hosting/configuration/environment-variables/licenses.md index 9f9db53bf..e1c9914c1 100644 --- a/docs/hosting/configuration/environment-variables/licenses.md +++ b/docs/hosting/configuration/environment-variables/licenses.md @@ -1,12 +1,15 @@ --- -title: License +title: License environment variables description: Environment variables to configure license settings in n8n, including options to hide the usage page, manage license activation and auto-renewal settings, and specify the server URL for license retrieval. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# License +# License environment variables | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index 002f64037..cf0c6f42d 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -1,12 +1,15 @@ --- -title: Logs and diagnostics +title: Logs environment variables description: Environment variables to configure logging and diagnostic data. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Logs +# Logs environment variables ## n8n logs @@ -29,8 +32,8 @@ Refer to [Log streaming](/log-streaming/) for more information on this feature. | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | -| `N8N_EVENTBUS_CHECKUNSENTINTERVAL` | Number | `0` | How often (in milliseconds) to check for unsent event messages. Can in rare cases cause a message to be sent twice. Set to `0` to disable it. | +| `N8N_EVENTBUS_CHECKUNSENTINTERVAL` | Number | `0` | How often (in milliseconds) to check for unsent event messages. Can in rare cases send message twice. Set to `0` to disable it. | | `N8N_EVENTBUS_LOGWRITER_SYNCFILEACCESS` | Boolean | `false` | Whether all file access happens synchronously within the thread (true) or not (false). | -| `N8N_EVENTBUS_LOGWRITER_KEEPLOGCOUNT` | Number | `3` | How many event log files to keep. | -| `N8N_EVENTBUS_LOGWRITER_MAXFILESIZEINKB` | Number | `10240` | Maximum size (in kilo-bytes) of an event log file before a new one is started. | -| `N8N_EVENTBUS_LOGWRITER_LOGBASENAME` | String | `n8nEventLog` | Basename of the event log file. | \ No newline at end of file +| `N8N_EVENTBUS_LOGWRITER_KEEPLOGCOUNT` | Number | `3` | Number of event log files to keep. | +| `N8N_EVENTBUS_LOGWRITER_MAXFILESIZEINKB` | Number | `10240` | Maximum size (in kilo-bytes) of an event log file before a new one starts. | +| `N8N_EVENTBUS_LOGWRITER_LOGBASENAME` | String | `n8nEventLog` | Basename of the event log file. | diff --git a/docs/hosting/configuration/environment-variables/nodes.md b/docs/hosting/configuration/environment-variables/nodes.md index 1f0741017..2ddb7840b 100644 --- a/docs/hosting/configuration/environment-variables/nodes.md +++ b/docs/hosting/configuration/environment-variables/nodes.md @@ -1,12 +1,15 @@ --- -title: Managing Nodes +title: Nodes environment variables description: Environment variable to configure nodes management in self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Nodes +# Nodes environment variables This section outlines the environment variables configuration options for managing nodes in n8n, including specifying which nodes to load or exclude, importing built-in or external modules in the Code node and enabling community nodes. diff --git a/docs/hosting/configuration/environment-variables/queue-mode.md b/docs/hosting/configuration/environment-variables/queue-mode.md index db5c5a636..5eb240db5 100644 --- a/docs/hosting/configuration/environment-variables/queue-mode.md +++ b/docs/hosting/configuration/environment-variables/queue-mode.md @@ -1,12 +1,15 @@ --- -title: Queue mode +title: Queue mode environment variables description: Environment variables to configure queue mode on your self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Queue mode +# Queue mode environment variables You can run n8n in different modes depending on your needs, and the queue mode provides the best scalability. Refer to [Queue mode](/hosting/scaling/queue-mode/) for its configuration details. @@ -38,4 +41,4 @@ Refer to [Configuring multi-main setup](/hosting/scaling/queue-mode/#configuring | :------- | :---- | :------- | :---------- | | `N8N_MULTI_MAIN_SETUP_ENABLED` | Boolean | `false` | Whether to enable multi-main setup for queue mode (license required). | | `N8N_MULTI_MAIN_SETUP_KEY_TTL` | Number | `10` | Time to live (in seconds) for leader key in multi-main setup. | -| `N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL` | Number | `3` | Interval (in seconds) for leader check in multi-main setup. | \ No newline at end of file +| `N8N_MULTI_MAIN_SETUP_CHECK_INTERVAL` | Number | `3` | Interval (in seconds) for leader check in multi-main setup. | diff --git a/docs/hosting/configuration/environment-variables/security.md b/docs/hosting/configuration/environment-variables/security.md index 063df4b8a..341abaad3 100644 --- a/docs/hosting/configuration/environment-variables/security.md +++ b/docs/hosting/configuration/environment-variables/security.md @@ -1,14 +1,17 @@ --- -title: Security +title: Security environment variables description: Configure authentication and environment variable access in self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Security +# Security environment variables | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | | `N8N_AUTH_EXCLUDE_ENDPOINTS` | String | - | Exclude endpoints from authentication checks. Provide multiple endpoints as a colon-seperated list ("`:`"). The endpoints must not start with a forward slash ("`/`"). | -| `N8N_BLOCK_ENV_ACCESS_IN_NODE` | Boolean | `false` | Whether to allow users to access environment variables in expressions and the Code node (false) or not (true). | \ No newline at end of file +| `N8N_BLOCK_ENV_ACCESS_IN_NODE` | Boolean | `false` | Whether to allow users to access environment variables in expressions and the Code node (false) or not (true). | diff --git a/docs/hosting/configuration/environment-variables/source-control.md b/docs/hosting/configuration/environment-variables/source-control.md index 69c210160..5446f4c85 100644 --- a/docs/hosting/configuration/environment-variables/source-control.md +++ b/docs/hosting/configuration/environment-variables/source-control.md @@ -1,12 +1,15 @@ --- -title: Source control +title: Source control environment variables description: Environment variable to set the default SSH key type for source control setup. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Source control +# Source control environment variables | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/timezone-and-localization.md b/docs/hosting/configuration/environment-variables/timezone-and-localization.md index 716b2e9c8..4c0154214 100644 --- a/docs/hosting/configuration/environment-variables/timezone-and-localization.md +++ b/docs/hosting/configuration/environment-variables/timezone-and-localization.md @@ -1,12 +1,15 @@ --- -title: Timezone and localization +title: Timezone and localization environment variables description: Set the timezone and default language locale for self-hosted n8n instance. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Timezone and localization +# Timezone and localization environment variables | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/user-management-smtp-and-2fa.md b/docs/hosting/configuration/environment-variables/user-management-smtp-and-2fa.md index 6df6e17a9..01dccaafb 100644 --- a/docs/hosting/configuration/environment-variables/user-management-smtp-and-2fa.md +++ b/docs/hosting/configuration/environment-variables/user-management-smtp-and-2fa.md @@ -1,12 +1,15 @@ --- -title: User management SMTP, and two-factor authentication +title: User management SMTP, and two-factor authentication environment variables description: Environment variables to set up user management and emails. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# User management SMTP, and two-factor authentication +# User management SMTP, and two-factor authentication environment variables Refer to [User management](/hosting/configuration/user-management-self-hosted/) for more information on setting up user management and emails. @@ -29,4 +32,4 @@ Refer to [User management](/hosting/configuration/user-management-self-hosted/) | `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS` | Number | 168 | Set an expiration date for the JWTs in hours. | | `N8N_USER_MANAGEMENT_JWT_REFRESH_TIMEOUT_HOURS` | Number | 0 | How many hours before the JWT expires to automatically refresh it. 0 means 25% of `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. -1 means it will never refresh, which forces users to log in again after the period defined in `N8N_USER_MANAGEMENT_JWT_DURATION_HOURS`. | | `N8N_MFA_ENABLED` | Boolean | `true` | Whether to enable two-factor authentication (true) or disable (false). n8n ignores this if existing users have 2FA enabled. | - \ No newline at end of file + diff --git a/docs/hosting/configuration/environment-variables/workflows.md b/docs/hosting/configuration/environment-variables/workflows.md index 4b946a307..c952b5c9d 100644 --- a/docs/hosting/configuration/environment-variables/workflows.md +++ b/docs/hosting/configuration/environment-variables/workflows.md @@ -1,12 +1,15 @@ --- -title: Workflows +title: Workflows environment variables description: Environment variables to configure workflows in n8n, including default naming, onboarding flow preferences, tag management, and caller policy settings. contentType: reference +tags: + - environment variables hide: - toc + - tags --- -# Workflows +# Workflows environment variables | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/mkdocs.yml b/mkdocs.yml index 9386c39ab..720140c90 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1127,7 +1127,26 @@ nav: - Updating: hosting/installation/updating.md - Configuration: - Configuration methods: hosting/configuration/configuration-methods.md - - Environment variables reference: hosting/configuration/environment-variables.md + - Environment variables: + - Environment variables overview : hosting/configuration/environment-variables/index.md + - Credentials: hosting/configuration/environment-variables/credentials.md + - Database: hosting/configuration/environment-variables/database.md + - Deployment: hosting/configuration/environment-variables/deployment.md + - Binary data: hosting/configuration/environment-variables/binary-data.md + - User management and 2FA: hosting/configuration/environment-variables/user-management-smtp-and-2fa.md + - Endpoints: hosting/configuration/environment-variables/endpoints.md + - External hooks: hosting/configuration/environment-variables/external-hooks.md + - Executions: hosting/configuration/environment-variables/executions.md + - Logs: hosting/configuration/environment-variables/logs.md + - External data storage: hosting/configuration/environment-variables/external-data-storage.md + - Nodes: hosting/configuration/environment-variables/nodes.md + - Queue mode: hosting/configuration/environment-variables/queue-mode.md + - Security: hosting/configuration/environment-variables/security.md + - Source control: hosting/configuration/environment-variables/source-control.md + - External secrets: hosting/configuration/environment-variables/external-secrets.md + - Timezone and localization: hosting/configuration/environment-variables/timezone-and-localization.md + - Workflows: hosting/configuration/environment-variables/workflows.md + - License: hosting/configuration/environment-variables/licenses.md - Supported databases and settings: hosting/configuration/supported-databases-settings.md - User management: hosting/configuration/user-management-self-hosted.md - Configuration examples: