From 4da8028119cfc310e8e494cd010ec7a2b21050cc Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Thu, 11 Apr 2024 11:45:56 +0200 Subject: [PATCH 01/18] change N8N_LOG_FILE_LOCATION default from file to /logs/n8n.log --- docs/hosting/configuration/environment-variables/logs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index a215a6096..3203a7bcb 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -22,7 +22,7 @@ This page lists environment variables to set up logging for debugging. Refer to | `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`. | +| `N8N_LOG_FILE_LOCATION` | String | `/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_MAX_EXECUTION_TIME` | Number | `1000` | Maximum execution time (in milliseconds) before n8n logs a warning. Set to `0` to disable long running query warning. | From 351ada4ac1a0be06bc8d7ccdfdf549be8159c260 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 10:35:47 +0200 Subject: [PATCH 02/18] add logging reference links --- docs/hosting/configuration/environment-variables/logs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index 3203a7bcb..ccc0e1073 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -18,13 +18,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 | `/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 From e8b5e269f6ece5a4e8328624752706e8a10a3b02 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 12:31:31 +0200 Subject: [PATCH 03/18] fix description N8N_BINARY_DATA_STORAGE_PATH --- docs/hosting/configuration/environment-variables/binary-data.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/configuration/environment-variables/binary-data.md b/docs/hosting/configuration/environment-variables/binary-data.md index 25f6c779f..46ac5acf5 100644 --- a/docs/hosting/configuration/environment-variables/binary-data.md +++ b/docs/hosting/configuration/environment-variables/binary-data.md @@ -16,5 +16,5 @@ By default, n8n uses memory to store binary data. Enterprise users can choose to | 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. | From 3b2bc474eea62873e18f90e35746f79ce052db8b Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 12:32:08 +0200 Subject: [PATCH 04/18] fix description N8N_PUBLIC_API_DISABLED --- docs/hosting/configuration/environment-variables/deployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index 0b650865b..e71dd87b9 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -40,6 +40,6 @@ This page lists the deployment configuration options for your self-hosted n8n in | `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_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. | From 8a099151c34c130894602355685db82ac39ae669 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 12:32:36 +0200 Subject: [PATCH 05/18] fix description N8N_WORKFLOW_TAGS_DISABLED --- docs/hosting/configuration/environment-variables/workflows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/configuration/environment-variables/workflows.md b/docs/hosting/configuration/environment-variables/workflows.md index c952b5c9d..99e59c691 100644 --- a/docs/hosting/configuration/environment-variables/workflows.md +++ b/docs/hosting/configuration/environment-variables/workflows.md @@ -14,6 +14,6 @@ hide: | 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/). | From 19d8c39475e5a417961da2db2741c370f6c2150f Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 12:34:38 +0200 Subject: [PATCH 06/18] fix github link to a list of OFFICIAL_RISKY_NODE_TYPES --- docs/hosting/logging-monitoring/security-audit.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/logging-monitoring/security-audit.md b/docs/hosting/logging-monitoring/security-audit.md index b7ccefff6..e89f2ffe3 100644 --- a/docs/hosting/logging-monitoring/security-audit.md +++ b/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. From d81b20fe35324af01bd7ab98299db2460bcb81b2 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 12:40:13 +0200 Subject: [PATCH 07/18] fix typo N8N_LOG_FILE_MAXCOUNT and N8N_LOG_FILE_MAXSIZE --- docs/hosting/logging-monitoring/logging.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hosting/logging-monitoring/logging.md b/docs/hosting/logging-monitoring/logging.md index 07452e899..19f83c0ce 100644 --- a/docs/hosting/logging-monitoring/logging.md +++ b/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, `/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 From 27e9a4530ae01d8445c16b942cd3eddb71281e59 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 12:42:57 +0200 Subject: [PATCH 08/18] fix QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD default unit from seconds to milliseconds --- docs/hosting/configuration/environment-variables/queue-mode.md | 2 +- docs/hosting/scaling/queue-mode.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hosting/configuration/environment-variables/queue-mode.md b/docs/hosting/configuration/environment-variables/queue-mode.md index aee04a17e..9e0085d4b 100644 --- a/docs/hosting/configuration/environment-variables/queue-mode.md +++ b/docs/hosting/configuration/environment-variables/queue-mode.md @@ -21,7 +21,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. | diff --git a/docs/hosting/scaling/queue-mode.md b/docs/hosting/scaling/queue-mode.md index 1a10d8eb4..42c8983c8 100644 --- a/docs/hosting/scaling/queue-mode.md +++ b/docs/hosting/scaling/queue-mode.md @@ -82,7 +82,7 @@ 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.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` | `QUEUE_WORKER_TIMEOUT` | A graceful shutdown timeout for workers to finish executing jobs before terminating the process. The default value is `30` seconds. | From 559c42d47a156690314dd2fb2c14d474b70816d1 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 14:10:10 +0200 Subject: [PATCH 09/18] replace deprecated QUEUE_WORKER_TIMEOUT with N8N_GRACEFUL_SHUTDOWN_TIMEOUT --- docs/hosting/scaling/queue-mode.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/scaling/queue-mode.md b/docs/hosting/scaling/queue-mode.md index 42c8983c8..17720a923 100644 --- a/docs/hosting/scaling/queue-mode.md +++ b/docs/hosting/scaling/queue-mode.md @@ -84,7 +84,7 @@ You can also set the following optional configurations: | `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 `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` | `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.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. From 0b72a8d8fb555bc802adcdc8d2193c39b9d88032 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 14:27:09 +0200 Subject: [PATCH 10/18] link reference to VUE_APP_URL_BASE_API in description --- docs/hosting/configuration/environment-variables/deployment.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index e71dd87b9..e1ae12a99 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -37,7 +37,8 @@ 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 (true) or not (false). | From 1c39aff49b889cc2b498d635e9e9e8737a7106b7 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 14:32:48 +0200 Subject: [PATCH 11/18] add tip to each env variable page about _FILE extension and link configuration method page --- .../configuration/environment-variables/binary-data.md | 4 ++++ .../configuration/environment-variables/credentials.md | 4 ++++ docs/hosting/configuration/environment-variables/database.md | 4 ++++ .../hosting/configuration/environment-variables/deployment.md | 4 ++++ docs/hosting/configuration/environment-variables/endpoints.md | 4 ++++ .../hosting/configuration/environment-variables/executions.md | 4 ++++ .../environment-variables/external-data-storage.md | 4 ++++ .../configuration/environment-variables/external-hooks.md | 4 ++++ .../configuration/environment-variables/external-secrets.md | 4 ++++ docs/hosting/configuration/environment-variables/licenses.md | 4 ++++ docs/hosting/configuration/environment-variables/logs.md | 4 ++++ docs/hosting/configuration/environment-variables/nodes.md | 4 ++++ .../hosting/configuration/environment-variables/queue-mode.md | 4 ++++ docs/hosting/configuration/environment-variables/security.md | 4 ++++ .../configuration/environment-variables/source-control.md | 4 ++++ .../environment-variables/timezone-localization.md | 4 ++++ .../environment-variables/user-management-smtp-2fa.md | 4 ++++ docs/hosting/configuration/environment-variables/workflows.md | 4 ++++ 18 files changed, 72 insertions(+) diff --git a/docs/hosting/configuration/environment-variables/binary-data.md b/docs/hosting/configuration/environment-variables/binary-data.md index 46ac5acf5..ab4e0bc94 100644 --- a/docs/hosting/configuration/environment-variables/binary-data.md +++ b/docs/hosting/configuration/environment-variables/binary-data.md @@ -11,6 +11,10 @@ hide: # Binary data 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. +/// + 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 | diff --git a/docs/hosting/configuration/environment-variables/credentials.md b/docs/hosting/configuration/environment-variables/credentials.md index 8faca337e..6d3370907 100644 --- a/docs/hosting/configuration/environment-variables/credentials.md +++ b/docs/hosting/configuration/environment-variables/credentials.md @@ -11,6 +11,10 @@ hide: # Credentials 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. +/// + Enable credential overwrites using the following environment variables. Refer to [Credential overwrites](/embed/configuration/#credential-overwrites/) for details. | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/database.md b/docs/hosting/configuration/environment-variables/database.md index 93f2c6472..2d9691533 100644 --- a/docs/hosting/configuration/environment-variables/database.md +++ b/docs/hosting/configuration/environment-variables/database.md @@ -11,6 +11,10 @@ hide: # Database 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. +/// + 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. diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index e1ae12a99..3db65a2f7 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -11,6 +11,10 @@ hide: # Deployment 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. +/// + 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 | diff --git a/docs/hosting/configuration/environment-variables/endpoints.md b/docs/hosting/configuration/environment-variables/endpoints.md index 8f90b808f..cf4c6c390 100644 --- a/docs/hosting/configuration/environment-variables/endpoints.md +++ b/docs/hosting/configuration/environment-variables/endpoints.md @@ -11,6 +11,10 @@ hide: # Endpoints 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. +/// + This page lists environment variables for customizing endpoints in n8n. | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/executions.md b/docs/hosting/configuration/environment-variables/executions.md index 7d6d21d2b..73637cc09 100644 --- a/docs/hosting/configuration/environment-variables/executions.md +++ b/docs/hosting/configuration/environment-variables/executions.md @@ -11,6 +11,10 @@ hide: # Executions 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. +/// + This page lists environment variables to configure workflow execution settings. | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/external-data-storage.md b/docs/hosting/configuration/environment-variables/external-data-storage.md index cb303dc91..32ce5d229 100644 --- a/docs/hosting/configuration/environment-variables/external-data-storage.md +++ b/docs/hosting/configuration/environment-variables/external-data-storage.md @@ -11,6 +11,10 @@ hide: # External data storage 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. +/// + Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data. | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/external-hooks.md b/docs/hosting/configuration/environment-variables/external-hooks.md index 1b107db08..dfadd0672 100644 --- a/docs/hosting/configuration/environment-variables/external-hooks.md +++ b/docs/hosting/configuration/environment-variables/external-hooks.md @@ -11,6 +11,10 @@ hide: # External hooks 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. +/// + 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 | diff --git a/docs/hosting/configuration/environment-variables/external-secrets.md b/docs/hosting/configuration/environment-variables/external-secrets.md index b309012b1..9ea95aad1 100644 --- a/docs/hosting/configuration/environment-variables/external-secrets.md +++ b/docs/hosting/configuration/environment-variables/external-secrets.md @@ -11,6 +11,10 @@ hide: # External secrets 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. +/// + You can use an external secrets store to manage credentials for n8n. Refer to [External secrets](/external-secrets/) for details. | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/licenses.md b/docs/hosting/configuration/environment-variables/licenses.md index a7e68ccb5..8501c9883 100644 --- a/docs/hosting/configuration/environment-variables/licenses.md +++ b/docs/hosting/configuration/environment-variables/licenses.md @@ -11,6 +11,10 @@ hide: # License 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. +/// + 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 | diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index ccc0e1073..8259350a3 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -11,6 +11,10 @@ hide: # Logs 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. +/// + This page lists environment variables to set up logging for debugging. Refer to [Logging in n8n](/hosting/logging-monitoring/logging/) for details. ## n8n logs diff --git a/docs/hosting/configuration/environment-variables/nodes.md b/docs/hosting/configuration/environment-variables/nodes.md index 5a2fa5ef2..b33cd4069 100644 --- a/docs/hosting/configuration/environment-variables/nodes.md +++ b/docs/hosting/configuration/environment-variables/nodes.md @@ -11,6 +11,10 @@ hide: # Nodes 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. +/// + 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 | diff --git a/docs/hosting/configuration/environment-variables/queue-mode.md b/docs/hosting/configuration/environment-variables/queue-mode.md index 9e0085d4b..53ec788c7 100644 --- a/docs/hosting/configuration/environment-variables/queue-mode.md +++ b/docs/hosting/configuration/environment-variables/queue-mode.md @@ -11,6 +11,10 @@ hide: # Queue mode 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. +/// + 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 | diff --git a/docs/hosting/configuration/environment-variables/security.md b/docs/hosting/configuration/environment-variables/security.md index e5c3b55fc..df7e4126d 100644 --- a/docs/hosting/configuration/environment-variables/security.md +++ b/docs/hosting/configuration/environment-variables/security.md @@ -11,6 +11,10 @@ hide: # Security 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. +/// + | 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). | diff --git a/docs/hosting/configuration/environment-variables/source-control.md b/docs/hosting/configuration/environment-variables/source-control.md index f3c13ccee..54a49c225 100644 --- a/docs/hosting/configuration/environment-variables/source-control.md +++ b/docs/hosting/configuration/environment-variables/source-control.md @@ -11,6 +11,10 @@ hide: # Source control 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. +/// + 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 | diff --git a/docs/hosting/configuration/environment-variables/timezone-localization.md b/docs/hosting/configuration/environment-variables/timezone-localization.md index 4c0154214..bc987dde5 100644 --- a/docs/hosting/configuration/environment-variables/timezone-localization.md +++ b/docs/hosting/configuration/environment-variables/timezone-localization.md @@ -11,6 +11,10 @@ hide: # Timezone and localization 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. +/// + | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | | `GENERIC_TIMEZONE` | * | `America/New_York` |The n8n instance timezone. Important for schedule nodes (such as Cron). | diff --git a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md index 01dccaafb..f22d5d95d 100644 --- a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md +++ b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md @@ -11,6 +11,10 @@ hide: # User management SMTP, and two-factor authentication 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. +/// + Refer to [User management](/hosting/configuration/user-management-self-hosted/) for more information on setting up user management and emails. | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/workflows.md b/docs/hosting/configuration/environment-variables/workflows.md index 99e59c691..0ea9ca013 100644 --- a/docs/hosting/configuration/environment-variables/workflows.md +++ b/docs/hosting/configuration/environment-variables/workflows.md @@ -11,6 +11,10 @@ hide: # Workflows 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. +/// + | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | | `WORKFLOWS_DEFAULT_NAME` | String | `My workflow` | The default name used for new workflows. | From cb8839dddcdcd17b98770be05d961ff73205f8cc Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Fri, 12 Apr 2024 17:04:41 +0200 Subject: [PATCH 12/18] add more explanation around _FILE suffix --- .../configuration/configuration-methods.md | 32 +++++++++++-------- .../environment-variables/binary-data.md | 2 +- .../environment-variables/credentials.md | 2 +- .../environment-variables/database.md | 2 +- .../environment-variables/deployment.md | 2 +- .../environment-variables/endpoints.md | 2 +- .../environment-variables/executions.md | 2 +- .../external-data-storage.md | 2 +- .../environment-variables/external-hooks.md | 2 +- .../environment-variables/external-secrets.md | 2 +- .../environment-variables/index.md | 2 +- .../environment-variables/licenses.md | 2 +- .../environment-variables/logs.md | 2 +- .../environment-variables/nodes.md | 3 +- .../environment-variables/queue-mode.md | 2 +- .../environment-variables/security.md | 2 +- .../environment-variables/source-control.md | 2 +- .../timezone-localization.md | 2 +- .../user-management-smtp-2fa.md | 2 +- .../environment-variables/workflows.md | 2 +- 20 files changed, 37 insertions(+), 34 deletions(-) diff --git a/docs/hosting/configuration/configuration-methods.md b/docs/hosting/configuration/configuration-methods.md index 982ca9e03..51727b9b4 100644 --- a/docs/hosting/configuration/configuration-methods.md +++ b/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` \ No newline at end of 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 +``` diff --git a/docs/hosting/configuration/environment-variables/binary-data.md b/docs/hosting/configuration/environment-variables/binary-data.md index ab4e0bc94..fac2cf5e6 100644 --- a/docs/hosting/configuration/environment-variables/binary-data.md +++ b/docs/hosting/configuration/environment-variables/binary-data.md @@ -12,7 +12,7 @@ hide: # Binary data 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. +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. /// 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. diff --git a/docs/hosting/configuration/environment-variables/credentials.md b/docs/hosting/configuration/environment-variables/credentials.md index 6d3370907..a08093e07 100644 --- a/docs/hosting/configuration/environment-variables/credentials.md +++ b/docs/hosting/configuration/environment-variables/credentials.md @@ -12,7 +12,7 @@ hide: # Credentials 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. +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. /// Enable credential overwrites using the following environment variables. Refer to [Credential overwrites](/embed/configuration/#credential-overwrites/) for details. diff --git a/docs/hosting/configuration/environment-variables/database.md b/docs/hosting/configuration/environment-variables/database.md index 2d9691533..aad98dd5b 100644 --- a/docs/hosting/configuration/environment-variables/database.md +++ b/docs/hosting/configuration/environment-variables/database.md @@ -12,7 +12,7 @@ hide: # Database 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. +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. /// 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. diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index 3db65a2f7..6d16bdb5d 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -12,7 +12,7 @@ hide: # Deployment 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. +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. /// 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. diff --git a/docs/hosting/configuration/environment-variables/endpoints.md b/docs/hosting/configuration/environment-variables/endpoints.md index cf4c6c390..f1934afe4 100644 --- a/docs/hosting/configuration/environment-variables/endpoints.md +++ b/docs/hosting/configuration/environment-variables/endpoints.md @@ -12,7 +12,7 @@ hide: # Endpoints 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. +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. /// This page lists environment variables for customizing endpoints in n8n. diff --git a/docs/hosting/configuration/environment-variables/executions.md b/docs/hosting/configuration/environment-variables/executions.md index 73637cc09..6ff95f98b 100644 --- a/docs/hosting/configuration/environment-variables/executions.md +++ b/docs/hosting/configuration/environment-variables/executions.md @@ -12,7 +12,7 @@ hide: # Executions 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. +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. /// This page lists environment variables to configure workflow execution settings. diff --git a/docs/hosting/configuration/environment-variables/external-data-storage.md b/docs/hosting/configuration/environment-variables/external-data-storage.md index 32ce5d229..9d99b1590 100644 --- a/docs/hosting/configuration/environment-variables/external-data-storage.md +++ b/docs/hosting/configuration/environment-variables/external-data-storage.md @@ -12,7 +12,7 @@ hide: # External data storage 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. +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. /// Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data. diff --git a/docs/hosting/configuration/environment-variables/external-hooks.md b/docs/hosting/configuration/environment-variables/external-hooks.md index dfadd0672..ff9669346 100644 --- a/docs/hosting/configuration/environment-variables/external-hooks.md +++ b/docs/hosting/configuration/environment-variables/external-hooks.md @@ -12,7 +12,7 @@ hide: # External hooks 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. +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. /// 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. diff --git a/docs/hosting/configuration/environment-variables/external-secrets.md b/docs/hosting/configuration/environment-variables/external-secrets.md index 9ea95aad1..b8fde48e0 100644 --- a/docs/hosting/configuration/environment-variables/external-secrets.md +++ b/docs/hosting/configuration/environment-variables/external-secrets.md @@ -12,7 +12,7 @@ hide: # External secrets 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. +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. /// You can use an external secrets store to manage credentials for n8n. Refer to [External secrets](/external-secrets/) for details. diff --git a/docs/hosting/configuration/environment-variables/index.md b/docs/hosting/configuration/environment-variables/index.md index a711bee38..245f2a428 100644 --- a/docs/hosting/configuration/environment-variables/index.md +++ b/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 %]] diff --git a/docs/hosting/configuration/environment-variables/licenses.md b/docs/hosting/configuration/environment-variables/licenses.md index 8501c9883..af423c4bc 100644 --- a/docs/hosting/configuration/environment-variables/licenses.md +++ b/docs/hosting/configuration/environment-variables/licenses.md @@ -12,7 +12,7 @@ hide: # License 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. +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. /// 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. diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index 8259350a3..1d51a43e5 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -12,7 +12,7 @@ hide: # Logs 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. +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. /// This page lists environment variables to set up logging for debugging. Refer to [Logging in n8n](/hosting/logging-monitoring/logging/) for details. diff --git a/docs/hosting/configuration/environment-variables/nodes.md b/docs/hosting/configuration/environment-variables/nodes.md index b33cd4069..67d66e273 100644 --- a/docs/hosting/configuration/environment-variables/nodes.md +++ b/docs/hosting/configuration/environment-variables/nodes.md @@ -12,9 +12,8 @@ hide: # Nodes 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. +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. /// - 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 | diff --git a/docs/hosting/configuration/environment-variables/queue-mode.md b/docs/hosting/configuration/environment-variables/queue-mode.md index 53ec788c7..7991b70fa 100644 --- a/docs/hosting/configuration/environment-variables/queue-mode.md +++ b/docs/hosting/configuration/environment-variables/queue-mode.md @@ -12,7 +12,7 @@ hide: # Queue mode 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. +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. /// 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. diff --git a/docs/hosting/configuration/environment-variables/security.md b/docs/hosting/configuration/environment-variables/security.md index df7e4126d..2876277db 100644 --- a/docs/hosting/configuration/environment-variables/security.md +++ b/docs/hosting/configuration/environment-variables/security.md @@ -12,7 +12,7 @@ hide: # Security 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. +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. /// | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/source-control.md b/docs/hosting/configuration/environment-variables/source-control.md index 54a49c225..7ca8f7659 100644 --- a/docs/hosting/configuration/environment-variables/source-control.md +++ b/docs/hosting/configuration/environment-variables/source-control.md @@ -12,7 +12,7 @@ hide: # Source control 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. +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. /// 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. diff --git a/docs/hosting/configuration/environment-variables/timezone-localization.md b/docs/hosting/configuration/environment-variables/timezone-localization.md index bc987dde5..426f909b0 100644 --- a/docs/hosting/configuration/environment-variables/timezone-localization.md +++ b/docs/hosting/configuration/environment-variables/timezone-localization.md @@ -12,7 +12,7 @@ hide: # Timezone and localization 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. +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. /// | Variable | Type | Default | Description | diff --git a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md index f22d5d95d..ff2807861 100644 --- a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md +++ b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md @@ -12,7 +12,7 @@ hide: # User management SMTP, and two-factor authentication 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. +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. /// Refer to [User management](/hosting/configuration/user-management-self-hosted/) for more information on setting up user management and emails. diff --git a/docs/hosting/configuration/environment-variables/workflows.md b/docs/hosting/configuration/environment-variables/workflows.md index 0ea9ca013..a514f89b2 100644 --- a/docs/hosting/configuration/environment-variables/workflows.md +++ b/docs/hosting/configuration/environment-variables/workflows.md @@ -12,7 +12,7 @@ hide: # Workflows 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. +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. /// | Variable | Type | Default | Description | From 9866f7429dcd1bf3568dad87ea090c6cb7be6c11 Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Mon, 15 Apr 2024 15:35:43 +0200 Subject: [PATCH 13/18] Update docs/hosting/configuration/environment-variables/logs.md Co-authored-by: Deborah --- docs/hosting/configuration/environment-variables/logs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index 1d51a43e5..83334f61a 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -28,7 +28,7 @@ This page lists environment variables to set up logging for debugging. Refer to | `N8N_LOG_FILE_SIZE_MAX` | Number | `16` | Max size of each log file in MB. | | `N8N_LOG_FILE_LOCATION` | String | `/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`. Refer to [typeorm logging options](https://orkhan.gitbook.io/typeorm/docs/logging#logging-options){:target=_blank .external-link} | +| `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 From c697fa3b28544db31efd86a1707fa81e23b3424b Mon Sep 17 00:00:00 2001 From: aya <15815271+ayatnkw@users.noreply.github.com> Date: Mon, 15 Apr 2024 15:36:09 +0200 Subject: [PATCH 14/18] Update docs/hosting/configuration/environment-variables/logs.md Co-authored-by: Deborah --- docs/hosting/configuration/environment-variables/logs.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index 83334f61a..0142329b1 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -26,7 +26,7 @@ This page lists environment variables to set up logging for debugging. Refer to | `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 | `/logs/n8n.log` | Log file location. Requires N8N_LOG_OUTPUT set to `file`. | +| `N8N_LOG_FILE_LOCATION` | String | `/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`. 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. | From 6d48d4a9b3aec200f47d48ac70975f68bb40b9bf Mon Sep 17 00:00:00 2001 From: Aya Tanikawa <15815271+ayatnkw@users.noreply.github.com> Date: Wed, 17 Apr 2024 14:25:48 +0200 Subject: [PATCH 15/18] replace file-based config note with snippet --- .../source-control-environments/file-based-configuration.md | 1 + .../configuration/environment-variables/credentials.md | 4 +--- docs/hosting/configuration/environment-variables/database.md | 4 +--- .../hosting/configuration/environment-variables/deployment.md | 4 +--- docs/hosting/configuration/environment-variables/endpoints.md | 4 +--- .../hosting/configuration/environment-variables/executions.md | 4 +--- .../environment-variables/external-data-storage.md | 4 +--- .../configuration/environment-variables/external-hooks.md | 4 +--- .../configuration/environment-variables/external-secrets.md | 4 +--- docs/hosting/configuration/environment-variables/licenses.md | 4 +--- docs/hosting/configuration/environment-variables/logs.md | 4 +--- docs/hosting/configuration/environment-variables/nodes.md | 4 +--- .../hosting/configuration/environment-variables/queue-mode.md | 4 +--- docs/hosting/configuration/environment-variables/security.md | 4 +--- .../configuration/environment-variables/source-control.md | 4 +--- .../environment-variables/timezone-localization.md | 4 +--- .../environment-variables/user-management-smtp-2fa.md | 4 +--- docs/hosting/configuration/environment-variables/workflows.md | 4 +--- 18 files changed, 18 insertions(+), 51 deletions(-) create mode 100644 _snippets/source-control-environments/file-based-configuration.md diff --git a/_snippets/source-control-environments/file-based-configuration.md b/_snippets/source-control-environments/file-based-configuration.md new file mode 100644 index 000000000..302f26ac6 --- /dev/null +++ b/_snippets/source-control-environments/file-based-configuration.md @@ -0,0 +1 @@ +--8<-- "_snippets/source-control-environments/file-based-configuration.md" \ No newline at end of file diff --git a/docs/hosting/configuration/environment-variables/credentials.md b/docs/hosting/configuration/environment-variables/credentials.md index a08093e07..6391f653e 100644 --- a/docs/hosting/configuration/environment-variables/credentials.md +++ b/docs/hosting/configuration/environment-variables/credentials.md @@ -11,9 +11,7 @@ hide: # Credentials environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" Enable credential overwrites using the following environment variables. Refer to [Credential overwrites](/embed/configuration/#credential-overwrites/) for details. diff --git a/docs/hosting/configuration/environment-variables/database.md b/docs/hosting/configuration/environment-variables/database.md index aad98dd5b..e79653123 100644 --- a/docs/hosting/configuration/environment-variables/database.md +++ b/docs/hosting/configuration/environment-variables/database.md @@ -11,9 +11,7 @@ hide: # Database environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index 6d16bdb5d..9f0adb16b 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -11,9 +11,7 @@ hide: # Deployment environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. diff --git a/docs/hosting/configuration/environment-variables/endpoints.md b/docs/hosting/configuration/environment-variables/endpoints.md index f1934afe4..786f2412d 100644 --- a/docs/hosting/configuration/environment-variables/endpoints.md +++ b/docs/hosting/configuration/environment-variables/endpoints.md @@ -11,9 +11,7 @@ hide: # Endpoints environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" This page lists environment variables for customizing endpoints in n8n. diff --git a/docs/hosting/configuration/environment-variables/executions.md b/docs/hosting/configuration/environment-variables/executions.md index 6ff95f98b..88c43f7c6 100644 --- a/docs/hosting/configuration/environment-variables/executions.md +++ b/docs/hosting/configuration/environment-variables/executions.md @@ -11,9 +11,7 @@ hide: # Executions environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" This page lists environment variables to configure workflow execution settings. diff --git a/docs/hosting/configuration/environment-variables/external-data-storage.md b/docs/hosting/configuration/environment-variables/external-data-storage.md index 9d99b1590..97ae04071 100644 --- a/docs/hosting/configuration/environment-variables/external-data-storage.md +++ b/docs/hosting/configuration/environment-variables/external-data-storage.md @@ -11,9 +11,7 @@ hide: # External data storage environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" Refer to [External storage](/hosting/scaling/external-storage/) for more information on using external storage for binary data. diff --git a/docs/hosting/configuration/environment-variables/external-hooks.md b/docs/hosting/configuration/environment-variables/external-hooks.md index ff9669346..1c874487a 100644 --- a/docs/hosting/configuration/environment-variables/external-hooks.md +++ b/docs/hosting/configuration/environment-variables/external-hooks.md @@ -11,9 +11,7 @@ hide: # External hooks environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. diff --git a/docs/hosting/configuration/environment-variables/external-secrets.md b/docs/hosting/configuration/environment-variables/external-secrets.md index b8fde48e0..fb2b8b97c 100644 --- a/docs/hosting/configuration/environment-variables/external-secrets.md +++ b/docs/hosting/configuration/environment-variables/external-secrets.md @@ -11,9 +11,7 @@ hide: # External secrets environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" You can use an external secrets store to manage credentials for n8n. Refer to [External secrets](/external-secrets/) for details. diff --git a/docs/hosting/configuration/environment-variables/licenses.md b/docs/hosting/configuration/environment-variables/licenses.md index af423c4bc..ac1b6fa4a 100644 --- a/docs/hosting/configuration/environment-variables/licenses.md +++ b/docs/hosting/configuration/environment-variables/licenses.md @@ -11,9 +11,7 @@ hide: # License environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index 0142329b1..01c5bc676 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -11,9 +11,7 @@ hide: # Logs environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. diff --git a/docs/hosting/configuration/environment-variables/nodes.md b/docs/hosting/configuration/environment-variables/nodes.md index 67d66e273..3603b092f 100644 --- a/docs/hosting/configuration/environment-variables/nodes.md +++ b/docs/hosting/configuration/environment-variables/nodes.md @@ -11,9 +11,7 @@ hide: # Nodes environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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 | diff --git a/docs/hosting/configuration/environment-variables/queue-mode.md b/docs/hosting/configuration/environment-variables/queue-mode.md index 7991b70fa..38f1720f6 100644 --- a/docs/hosting/configuration/environment-variables/queue-mode.md +++ b/docs/hosting/configuration/environment-variables/queue-mode.md @@ -11,9 +11,7 @@ hide: # Queue mode environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. diff --git a/docs/hosting/configuration/environment-variables/security.md b/docs/hosting/configuration/environment-variables/security.md index 2876277db..973036404 100644 --- a/docs/hosting/configuration/environment-variables/security.md +++ b/docs/hosting/configuration/environment-variables/security.md @@ -11,9 +11,7 @@ hide: # Security environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/source-control.md b/docs/hosting/configuration/environment-variables/source-control.md index 7ca8f7659..fcc548eab 100644 --- a/docs/hosting/configuration/environment-variables/source-control.md +++ b/docs/hosting/configuration/environment-variables/source-control.md @@ -11,9 +11,7 @@ hide: # Source control environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. diff --git a/docs/hosting/configuration/environment-variables/timezone-localization.md b/docs/hosting/configuration/environment-variables/timezone-localization.md index 426f909b0..fd2ff109d 100644 --- a/docs/hosting/configuration/environment-variables/timezone-localization.md +++ b/docs/hosting/configuration/environment-variables/timezone-localization.md @@ -11,9 +11,7 @@ hide: # Timezone and localization environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md index ff2807861..ebd10400d 100644 --- a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md +++ b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md @@ -11,9 +11,7 @@ hide: # User management SMTP, and two-factor authentication environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" Refer to [User management](/hosting/configuration/user-management-self-hosted/) for more information on setting up user management and emails. diff --git a/docs/hosting/configuration/environment-variables/workflows.md b/docs/hosting/configuration/environment-variables/workflows.md index a514f89b2..9336a388e 100644 --- a/docs/hosting/configuration/environment-variables/workflows.md +++ b/docs/hosting/configuration/environment-variables/workflows.md @@ -11,9 +11,7 @@ hide: # Workflows environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/file-based-configuration.md" | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | From 52bc43482af9790f174ab276e3d4d61fa58c5246 Mon Sep 17 00:00:00 2001 From: Aya Tanikawa <15815271+ayatnkw@users.noreply.github.com> Date: Wed, 17 Apr 2024 14:40:57 +0200 Subject: [PATCH 16/18] fix snippet --- .../configuration/environment-variables/binary-data.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/hosting/configuration/environment-variables/binary-data.md b/docs/hosting/configuration/environment-variables/binary-data.md index fac2cf5e6..ebcc8683d 100644 --- a/docs/hosting/configuration/environment-variables/binary-data.md +++ b/docs/hosting/configuration/environment-variables/binary-data.md @@ -11,9 +11,7 @@ hide: # Binary data environment variables -/// 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. -/// +--8<-- "_snippets/source-control-environments/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. From 5e9b83b236a72fdec1f247e975884f4889c96479 Mon Sep 17 00:00:00 2001 From: Aya Tanikawa <15815271+ayatnkw@users.noreply.github.com> Date: Wed, 17 Apr 2024 14:45:07 +0200 Subject: [PATCH 17/18] save changes --- .../source-control-environments/file-based-configuration.md | 4 +++- docs/hosting/configuration/environment-variables/nodes.md | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/_snippets/source-control-environments/file-based-configuration.md b/_snippets/source-control-environments/file-based-configuration.md index 302f26ac6..4e58439b2 100644 --- a/_snippets/source-control-environments/file-based-configuration.md +++ b/_snippets/source-control-environments/file-based-configuration.md @@ -1 +1,3 @@ ---8<-- "_snippets/source-control-environments/file-based-configuration.md" \ No newline at end of file +/// 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. +/// \ No newline at end of file diff --git a/docs/hosting/configuration/environment-variables/nodes.md b/docs/hosting/configuration/environment-variables/nodes.md index 3603b092f..7258d072a 100644 --- a/docs/hosting/configuration/environment-variables/nodes.md +++ b/docs/hosting/configuration/environment-variables/nodes.md @@ -12,6 +12,7 @@ hide: # Nodes environment variables --8<-- "_snippets/source-control-environments/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 | From 3a417282f14e1eba21a8e417fe7a1d423e000941 Mon Sep 17 00:00:00 2001 From: Aya Tanikawa <15815271+ayatnkw@users.noreply.github.com> Date: Wed, 17 Apr 2024 22:05:18 +0200 Subject: [PATCH 18/18] move snippet to self-hosting --- .../file-based-configuration.md | 0 docs/hosting/configuration/environment-variables/binary-data.md | 2 +- docs/hosting/configuration/environment-variables/credentials.md | 2 +- docs/hosting/configuration/environment-variables/database.md | 2 +- docs/hosting/configuration/environment-variables/deployment.md | 2 +- docs/hosting/configuration/environment-variables/endpoints.md | 2 +- docs/hosting/configuration/environment-variables/executions.md | 2 +- .../environment-variables/external-data-storage.md | 2 +- .../configuration/environment-variables/external-hooks.md | 2 +- .../configuration/environment-variables/external-secrets.md | 2 +- docs/hosting/configuration/environment-variables/licenses.md | 2 +- docs/hosting/configuration/environment-variables/logs.md | 2 +- docs/hosting/configuration/environment-variables/nodes.md | 2 +- docs/hosting/configuration/environment-variables/queue-mode.md | 2 +- docs/hosting/configuration/environment-variables/security.md | 2 +- .../configuration/environment-variables/source-control.md | 2 +- .../environment-variables/timezone-localization.md | 2 +- .../environment-variables/user-management-smtp-2fa.md | 2 +- docs/hosting/configuration/environment-variables/workflows.md | 2 +- 19 files changed, 18 insertions(+), 18 deletions(-) rename _snippets/{source-control-environments => self-hosting}/file-based-configuration.md (100%) diff --git a/_snippets/source-control-environments/file-based-configuration.md b/_snippets/self-hosting/file-based-configuration.md similarity index 100% rename from _snippets/source-control-environments/file-based-configuration.md rename to _snippets/self-hosting/file-based-configuration.md diff --git a/docs/hosting/configuration/environment-variables/binary-data.md b/docs/hosting/configuration/environment-variables/binary-data.md index ebcc8683d..65ae7ab64 100644 --- a/docs/hosting/configuration/environment-variables/binary-data.md +++ b/docs/hosting/configuration/environment-variables/binary-data.md @@ -11,7 +11,7 @@ hide: # Binary data environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/credentials.md b/docs/hosting/configuration/environment-variables/credentials.md index 6391f653e..41006ccbe 100644 --- a/docs/hosting/configuration/environment-variables/credentials.md +++ b/docs/hosting/configuration/environment-variables/credentials.md @@ -11,7 +11,7 @@ hide: # Credentials environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/database.md b/docs/hosting/configuration/environment-variables/database.md index e79653123..ae6687440 100644 --- a/docs/hosting/configuration/environment-variables/database.md +++ b/docs/hosting/configuration/environment-variables/database.md @@ -11,7 +11,7 @@ hide: # Database environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/deployment.md b/docs/hosting/configuration/environment-variables/deployment.md index 9f0adb16b..36c0870f1 100644 --- a/docs/hosting/configuration/environment-variables/deployment.md +++ b/docs/hosting/configuration/environment-variables/deployment.md @@ -11,7 +11,7 @@ hide: # Deployment environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/endpoints.md b/docs/hosting/configuration/environment-variables/endpoints.md index 786f2412d..eb5da61a4 100644 --- a/docs/hosting/configuration/environment-variables/endpoints.md +++ b/docs/hosting/configuration/environment-variables/endpoints.md @@ -11,7 +11,7 @@ hide: # Endpoints environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--8<-- "_snippets/self-hosting/file-based-configuration.md" This page lists environment variables for customizing endpoints in n8n. diff --git a/docs/hosting/configuration/environment-variables/executions.md b/docs/hosting/configuration/environment-variables/executions.md index 88c43f7c6..0e48afbf2 100644 --- a/docs/hosting/configuration/environment-variables/executions.md +++ b/docs/hosting/configuration/environment-variables/executions.md @@ -11,7 +11,7 @@ hide: # Executions environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--8<-- "_snippets/self-hosting/file-based-configuration.md" This page lists environment variables to configure workflow execution settings. diff --git a/docs/hosting/configuration/environment-variables/external-data-storage.md b/docs/hosting/configuration/environment-variables/external-data-storage.md index 97ae04071..875d11da6 100644 --- a/docs/hosting/configuration/environment-variables/external-data-storage.md +++ b/docs/hosting/configuration/environment-variables/external-data-storage.md @@ -11,7 +11,7 @@ hide: # External data storage environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/external-hooks.md b/docs/hosting/configuration/environment-variables/external-hooks.md index 1c874487a..5c3e2662b 100644 --- a/docs/hosting/configuration/environment-variables/external-hooks.md +++ b/docs/hosting/configuration/environment-variables/external-hooks.md @@ -11,7 +11,7 @@ hide: # External hooks environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/external-secrets.md b/docs/hosting/configuration/environment-variables/external-secrets.md index fb2b8b97c..c18cda7b9 100644 --- a/docs/hosting/configuration/environment-variables/external-secrets.md +++ b/docs/hosting/configuration/environment-variables/external-secrets.md @@ -11,7 +11,7 @@ hide: # External secrets environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/licenses.md b/docs/hosting/configuration/environment-variables/licenses.md index ac1b6fa4a..262054280 100644 --- a/docs/hosting/configuration/environment-variables/licenses.md +++ b/docs/hosting/configuration/environment-variables/licenses.md @@ -11,7 +11,7 @@ hide: # License environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/logs.md b/docs/hosting/configuration/environment-variables/logs.md index 01c5bc676..fa4025bf1 100644 --- a/docs/hosting/configuration/environment-variables/logs.md +++ b/docs/hosting/configuration/environment-variables/logs.md @@ -11,7 +11,7 @@ hide: # Logs environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/nodes.md b/docs/hosting/configuration/environment-variables/nodes.md index 7258d072a..7b5d0a6a8 100644 --- a/docs/hosting/configuration/environment-variables/nodes.md +++ b/docs/hosting/configuration/environment-variables/nodes.md @@ -11,7 +11,7 @@ hide: # Nodes environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/queue-mode.md b/docs/hosting/configuration/environment-variables/queue-mode.md index 38f1720f6..1f938b853 100644 --- a/docs/hosting/configuration/environment-variables/queue-mode.md +++ b/docs/hosting/configuration/environment-variables/queue-mode.md @@ -11,7 +11,7 @@ hide: # Queue mode environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/security.md b/docs/hosting/configuration/environment-variables/security.md index 973036404..4d7f9e855 100644 --- a/docs/hosting/configuration/environment-variables/security.md +++ b/docs/hosting/configuration/environment-variables/security.md @@ -11,7 +11,7 @@ hide: # Security environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--8<-- "_snippets/self-hosting/file-based-configuration.md" | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/source-control.md b/docs/hosting/configuration/environment-variables/source-control.md index fcc548eab..cf425fbf2 100644 --- a/docs/hosting/configuration/environment-variables/source-control.md +++ b/docs/hosting/configuration/environment-variables/source-control.md @@ -11,7 +11,7 @@ hide: # Source control environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/timezone-localization.md b/docs/hosting/configuration/environment-variables/timezone-localization.md index fd2ff109d..734dbb8f4 100644 --- a/docs/hosting/configuration/environment-variables/timezone-localization.md +++ b/docs/hosting/configuration/environment-variables/timezone-localization.md @@ -11,7 +11,7 @@ hide: # Timezone and localization environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--8<-- "_snippets/self-hosting/file-based-configuration.md" | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- | diff --git a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md index ebd10400d..465d646ce 100644 --- a/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md +++ b/docs/hosting/configuration/environment-variables/user-management-smtp-2fa.md @@ -11,7 +11,7 @@ hide: # User management SMTP, and two-factor authentication environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--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. diff --git a/docs/hosting/configuration/environment-variables/workflows.md b/docs/hosting/configuration/environment-variables/workflows.md index 9336a388e..a3a9ad892 100644 --- a/docs/hosting/configuration/environment-variables/workflows.md +++ b/docs/hosting/configuration/environment-variables/workflows.md @@ -11,7 +11,7 @@ hide: # Workflows environment variables ---8<-- "_snippets/source-control-environments/file-based-configuration.md" +--8<-- "_snippets/self-hosting/file-based-configuration.md" | Variable | Type | Default | Description | | :------- | :---- | :------- | :---------- |