Merge pull request #2031 from n8n-io/DOC-829-documentation-errors-env-variables

Fix documentation errors in environment variables

_snippets/self-hosting/file-based-configuration.md

@@ -0,0 +1,3 @@
+/// note | File-based configuration
+You can add `_FILE` to individual variables to provide their configuration in a separate file. Refer to [Keeping sensitive data in separate files](/hosting/configuration/configuration-methods/#keeping-sensitive-data-in-separate-files) for more details.
+///

docs/hosting/configuration/configuration-methods.md

@@ -98,19 +98,23 @@ n8n:
 
 ### Keeping sensitive data in separate files
 
-You can append `_FILE` to some individual environment variables to provide their configuration in a separate file, enabling you to avoid passing sensitive details using environment variables. n8n loads the data from the file with the given name, making it possible to load data from Docker-Secrets and Kubernetes-Secrets.
+You can append `_FILE` to individual environment variables to provide their configuration in a separate file, enabling you to avoid passing sensitive details using environment variables. n8n loads the data from the file with the given name, making it possible to load data from [Docker-Secrets](https://docs.docker.com/engine/swarm/secrets/){:target=_blank .external-link} and [Kubernetes-Secrets](https://kubernetes.io/docs/concepts/configuration/secret/){:target=_blank .external-link}. 
 
-The following environment variables support file input:
+Refer to [Environment variables](/hosting/configuration/environment-variables/) for details on each variable.
 
-- `CREDENTIALS_OVERWRITE_DATA_FILE`
-- `DB_TYPE_FILE`
-- `DB_POSTGRESDB_DATABASE_FILE`
-- `DB_POSTGRESDB_HOST_FILE`
-- `DB_POSTGRESDB_PASSWORD_FILE`
-- `DB_POSTGRESDB_PORT_FILE`
-- `DB_POSTGRESDB_SSL_CA_FILE`
-- `DB_POSTGRESDB_SSL_CERT_FILE`
-- `DB_POSTGRESDB_SSL_KEY_FILE`
-- `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED_FILE`
-- `DB_POSTGRESDB_USER_FILE`
-- `DB_POSTGRESDB_SCHEMA_FILE`
+While most environment variables can use the `_FILE` suffix, it's more beneficial for sensitive data such as credentials and database configuration. Here are some examples: 
+
+```yaml
+CREDENTIALS_OVERWRITE_DATA_FILE=/path/to/credentials_data
+DB_TYPE_FILE=/path/to/db_type
+DB_POSTGRESDB_DATABASE_FILE=/path/to/database_name
+DB_POSTGRESDB_HOST_FILE=/path/to/database_host
+DB_POSTGRESDB_PORT_FILE=/path/to/database_port
+DB_POSTGRESDB_USER_FILE=/path/to/database_user
+DB_POSTGRESDB_PASSWORD_FILE=/path/to/database_password
+DB_POSTGRESDB_SCHEMA_FILE=/path/to/database_schema
+DB_POSTGRESDB_SSL_CA_FILE=/path/to/ssl_ca
+DB_POSTGRESDB_SSL_CERT_FILE=/path/to/ssl_cert
+DB_POSTGRESDB_SSL_KEY_FILE=/path/to/ssl_key
+DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED_FILE=/path/to/ssl_reject_unauth
+```

docs/hosting/configuration/environment-variables/binary-data.md

@@ -11,10 +11,12 @@ hide:
 
 # Binary data environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 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_BINARY_DATA_STORAGE_PATH` | String | `N8N_USER_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. |

docs/hosting/configuration/environment-variables/credentials.md

@@ -11,6 +11,8 @@ hide:
 
 # Credentials environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 Enable credential overwrites using the following environment variables. Refer to [Credential overwrites](/embed/configuration/#credential-overwrites/) for details.
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/database.md

@@ -11,6 +11,8 @@ hide:
 
 # Database environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 By default, n8n uses SQLite. n8n also supports PostgreSQL. n8n [removed support for MySQL and MariaDB](/1-0-migration-checklist/#mysql-and-mariadb) in v1.0. 
 
 This page outlines environment variables to configure your chosen database for your self-hosted n8n instance. 

docs/hosting/configuration/environment-variables/deployment.md

@@ -11,6 +11,8 @@ hide:
 
 # Deployment environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 This page lists the deployment configuration options for your self-hosted n8n instance, including setting up access URLs, enabling templates, customizing encryption, and configuring server details. 
 
 | Variable | Type  | Default  | Description |
@@ -37,9 +39,10 @@ This page lists the deployment configuration options for your self-hosted n8n in
 | `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. |
+| `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. Refer to [Configure the Base URL](/hosting/configuration/configuration-examples/base-url/).
+ |
 | `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_DISABLED` | Boolean | `false` | Whether to disable the public API (true) or not (false). |
 | `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. |

docs/hosting/configuration/environment-variables/endpoints.md

@@ -11,6 +11,8 @@ hide:
 
 # Endpoints environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 This page lists environment variables for customizing endpoints in n8n.
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/executions.md

@@ -11,6 +11,8 @@ hide:
 
 # Executions environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 This page lists environment variables to configure workflow execution settings.
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/external-data-storage.md

@@ -11,6 +11,8 @@ hide:
 
 # External data storage environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data.
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/external-hooks.md

@@ -11,6 +11,8 @@ hide:
 
 # External hooks environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 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) for information on file formatting. 
 
 | Variable | Type  | Description |

docs/hosting/configuration/environment-variables/external-secrets.md

@@ -11,6 +11,8 @@ hide:
 
 # External secrets environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 You can use an external secrets store to manage credentials for n8n. Refer to [External secrets](/external-secrets/) for details.
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/index.md

@@ -14,7 +14,7 @@ hide:
 This section lists of environment variables that you can use to change n8n's configuration settings when self-hosting n8n.
 
 /// 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.
+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. 
 ///
 
 [[% import "_macros/section-toc.html" as sectionToc %]]

docs/hosting/configuration/environment-variables/licenses.md

@@ -11,6 +11,8 @@ hide:
 
 # License environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 To enable enterprise features, you need to add your enterprise license key. You can do this through the UI, or using environment variables. Refer to [Enterprise license key](/enterprise-key/) for details.
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/logs.md

@@ -11,6 +11,8 @@ hide:
 
 # Logs environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 This page lists environment variables to set up logging for debugging. Refer to [Logging in n8n](/hosting/logging-monitoring/logging/) for details. 
 
 ## n8n logs
@@ -18,13 +20,13 @@ This page lists environment variables to set up logging for debugging. Refer to
 
 | 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_LEVEL` | Enum string: `info`, `warn`, `error`, `verbose`, `debug` | `info` | Log output level. Refer to [Log levels](/hosting/logging-monitoring/logging/#log-levels) for details. |
+| `N8N_LOG_OUTPUT` | Enum string: `console`, `file` | `console` | Where to output logs. Provide multiple values as a comma-separated 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`. |
+| `N8N_LOG_FILE_LOCATION` | String | `<n8n-directory-path>/logs/n8n.log` | 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_OPTIONS` | Enum string: `query`, `error`, `schema`, `warn`, `info`, `log`  | `error` | Database log output level. To enable all logging, specify `all`. Refer to [TypeORM logging options](https://orkhan.gitbook.io/typeorm/docs/logging#logging-options){:target=_blank .external-link} |
 | `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

docs/hosting/configuration/environment-variables/nodes.md

@@ -11,6 +11,8 @@ hide:
 
 # Nodes environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 This page lists 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. 
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/queue-mode.md

@@ -11,6 +11,8 @@ hide:
 
 # Queue mode environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 You can run n8n in different modes depending on your needs. Queue mode provides the best scalability. Refer to [Queue mode](/hosting/scaling/queue-mode/) for more information.
 
 | Variable | Type  | Default  | Description |
@@ -21,7 +23,7 @@ You can run n8n in different modes depending on your needs. Queue mode provides
 | `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_TIMEOUT_THRESHOLD` | Number | `10000` | The Redis timeout threshold (in ms). |
 | `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. |

docs/hosting/configuration/environment-variables/security.md

@@ -11,6 +11,8 @@ hide:
 
 # Security environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 | Variable | Type  | Default  | Description |
 | :------- | :---- | :------- | :---------- |
 | `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). |

docs/hosting/configuration/environment-variables/source-control.md

@@ -11,6 +11,8 @@ hide:
 
 # Source control environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 n8n uses Git-based source control to support environments. Refer to [Source control and environments](/source-control-environments/setup/) for more information on how to link a Git repository to an n8n instance and configure your source control.
 
 | Variable | Type  | Default  | Description |

docs/hosting/configuration/environment-variables/timezone-localization.md

@@ -11,6 +11,8 @@ hide:
 
 # Timezone and localization environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 | Variable | Type  | Default  | Description |
 | :------- | :---- | :------- | :---------- |
 | `GENERIC_TIMEZONE` | * | `America/New_York` |The n8n instance timezone. Important for schedule nodes (such as Cron). |

docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md

@@ -11,6 +11,8 @@ hide:
 
 # User management SMTP, and two-factor authentication environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 Refer to [User management](/hosting/configuration/user-management-self-hosted/) for more information on setting up user management and emails.
 <!-- vale off -->
 | Variable | Type | Default | Description |

docs/hosting/configuration/environment-variables/workflows.md

@@ -11,9 +11,11 @@ hide:
 
 # Workflows environment variables
 
+--8<-- "_snippets/self-hosting/file-based-configuration.md"
+
 | 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_ONBOARDING_FLOW_DISABLED` | Boolean | `false` | Whether to disable 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/). |

docs/hosting/logging-monitoring/logging.md

@@ -18,8 +18,8 @@ To set up logging in n8n, you need to set the following environment variables (y
 | n8n.log.level | N8N_LOG_LEVEL | The log output level. The available options are (from lowest to highest level) are error, warn, info, verbose, and debug. The default value is `info`. You can learn more about these options [here](#log-levels). |
 | n8n.log.output | N8N_LOG_OUTPUT | Where to output logs. The available options are `console` and `file`. Multiple values can be used separated by a comma (`,`). `console` is used by default. |
 | n8n.log.file.location | N8N_LOG_FILE_LOCATION | The log file location, used only if log output is set to file. By default, `<n8nFolderPath>/logs/n8n.log` is used. |
-| n8n.log.file.maxsize | N8N_LOG_FILE_MAXSIZE | The maximum size (in MB) for each log file. By default, n8n uses 16 MB. |
-| n8n.log.file.maxcount | N8N_LOG_FILE_MAXCOUNT | The maximum number of log files to keep. The default value is 100. This value should be set when using workers. |
+| n8n.log.file.maxsize | N8N_LOG_FILE_SIZE_MAX | The maximum size (in MB) for each log file. By default, n8n uses 16 MB. |
+| n8n.log.file.maxcount | N8N_LOG_FILE_COUNT_MAX | The maximum number of log files to keep. The default value is 100. This value should be set when using workers. |
 
 
 ```bash

docs/hosting/logging-monitoring/security-audit.md

@@ -52,7 +52,7 @@ This report lists nodes that interact with the file system.
 
 This report shows:
 
-* Official risky nodes. These are n8n built in nodes. You can use them to fetch and run any code on the host system, which exposes the instance to exploits. You can view the list in [n8n code | Audit constants](https://github.com/n8n-io/n8n/blob/master/packages/cli/src/audit/constants.ts){:target=_blank .external-link}, under `OFFICIAL_RISKY_NODE_TYPES`.
+* Official risky nodes. These are n8n built in nodes. You can use them to fetch and run any code on the host system, which exposes the instance to exploits. You can view the list in [n8n code | Audit constants](https://github.com/n8n-io/n8n/blob/master/packages/cli/src/security-audit/constants.ts#L51){:target=_blank .external-link}, under `OFFICIAL_RISKY_NODE_TYPES`.
 * Community nodes.
 * Custom nodes.
 

docs/hosting/scaling/queue-mode.md

@@ -90,9 +90,10 @@ You can also set the following optional configurations:
 | `queue.bull.redis.username:USERNAME` | `QUEUE_BULL_REDIS_USERNAME` | By default, Redis doesn't require a username. If you're using a specific user, configure it variable. |
 | `queue.bull.redis.password:PASSWORD` | `QUEUE_BULL_REDIS_PASSWORD` | By default, Redis doesn't require a password. If you're using a password, configure it variable. |
 | `queue.bull.redis.db:0` | `QUEUE_BULL_REDIS_DB` | The default value is `0`. If you change this value, update the configuration. |
-| `queue.bull.redis.timeoutThreshold:10000ms` | `QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD` | Tells n8n how long it should wait if Redis is unavailable before exiting. The default value is `10000ms`. |
-| `queue.bull.queueRecoveryInterval:60` | `QUEUE_RECOVERY_INTERVAL` | Adds an active watchdog to n8n that checks Redis for finished executions. n8n uses this to recover when the main process loses connection temporarily to Redis and isn't notified about finished jobs. The default value is `60` seconds. |
-| `queue.bull.gracefulShutdownTimeout:30` | `QUEUE_WORKER_TIMEOUT` | A graceful shutdown timeout for workers to finish executing jobs before terminating the process. The default value is `30` seconds. |
+| `queue.bull.redis.timeoutThreshold:10000ms` | `QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD` | Tells n8n how long it should wait if Redis is unavailable before exiting. The default value is `10000` (ms). |
+| `queue.bull.queueRecoveryInterval:60` | `QUEUE_RECOVERY_INTERVAL` | Adds an active watchdog to n8n that checks Redis for finished executions. This is used to recover when n8n's main process loses connection temporarily to Redis and isn't notified about finished jobs. The default value is `60` seconds. |
+| `queue.bull.gracefulShutdownTimeout:30` | `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | A graceful shutdown timeout for workers to finish executing jobs before terminating the process. The default value is `30` seconds. |
+
 
 Now you can start your n8n instance and it will connect to your Redis instance.