From 6b65184b22b727c1ba2e7380cee8e21c00433022 Mon Sep 17 00:00:00 2001 From: Tomi Turtiainen <10324676+tomi@users.noreply.github.com> Date: Mon, 18 Dec 2023 11:40:22 +0200 Subject: [PATCH 1/3] feat: add N8N_GRACEFUL_SHUTDOWN_TIMEOUT & deprecate QUEUE_WORKER_TIMEOUT --- docs/hosting/environment-variables/environment-variables.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/hosting/environment-variables/environment-variables.md b/docs/hosting/environment-variables/environment-variables.md index a5f9e395cde..2aab5216e0f 100644 --- a/docs/hosting/environment-variables/environment-variables.md +++ b/docs/hosting/environment-variables/environment-variables.md @@ -81,7 +81,7 @@ Enabling overwrites for credentials allows you to set default values for credent | `N8N_PUBLIC_API_SWAGGERUI_DISABLED` | Boolean | `false` | Whether the Swagger UI (API playground) is disabled (true) or not (false). | | `N8N_PUBLIC_API_DISABLED` | Boolean | `false` | Whether to disable the public API (false) or not (true). | | `N8N_PUBLIC_API_ENDPOINT` | String | `api` | Path for the public API endpoints. | - +| `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | Number | `30` | How long should n8n process wait (in seconds) for components to shut down before exiting the process. | ## Binary data @@ -229,7 +229,7 @@ Refer to [External storage](/hosting/external-storage/) for more information on | `QUEUE_BULL_REDIS_CLUSTER_NODES` | String | - | Expects a comma-separated list of Redis Cluster nodes in the format `host:port`, for the Redis client to initially connect to. If running in queue mode (`EXECUTIONS_MODE = queue`), setting this variable will create a Redis Cluster client instead of a Redis client, and n8n will ignore `QUEUE_BULL_REDIS_HOST` and `QUEUE_BULL_REDIS_PORT`. | | `QUEUE_BULL_REDIS_TLS` | Boolean | `false` | Enable TLS on Redis connections. | | `QUEUE_RECOVERY_INTERVAL` | Number | `60` | Interval (in seconds) for active polling to the queue to recover from Redis crashes. `0` disables recovery. May increase Redis traffic significantly. | -| `QUEUE_WORKER_TIMEOUT` | Number | `30` | How long should n8n wait (seconds) for running executions before exiting worker process on shutdown. | +| `QUEUE_WORKER_TIMEOUT` (**deprecated**) | Number | `30` | **Deprecated** Use N8N_GRACEFUL_SHUTDOWN_TIMEOUT instead.

How long should n8n wait (seconds) for running executions before exiting worker process on shutdown. | | `QUEUE_HEALTH_CHECK_ACTIVE` | Boolean | `false` | Whether to enable health checks (true) or disable (false). | | `QUEUE_HEALTH_CHECK_PORT` | Number | - | The port to serve health checks on. | | `QUEUE_WORKER_LOCK_DURATION` | Number | `30000` | How long (in ms) is the lease period for a worker to work on a message. | From 66930b7289746c618ac5a3ad927d73e11f3ba8c0 Mon Sep 17 00:00:00 2001 From: Deborah Date: Mon, 18 Dec 2023 10:24:24 +0000 Subject: [PATCH 2/3] Update docs/hosting/environment-variables/environment-variables.md --- docs/hosting/environment-variables/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/environment-variables/environment-variables.md b/docs/hosting/environment-variables/environment-variables.md index 2aab5216e0f..8ad25310c9f 100644 --- a/docs/hosting/environment-variables/environment-variables.md +++ b/docs/hosting/environment-variables/environment-variables.md @@ -81,7 +81,7 @@ Enabling overwrites for credentials allows you to set default values for credent | `N8N_PUBLIC_API_SWAGGERUI_DISABLED` | Boolean | `false` | Whether the Swagger UI (API playground) is disabled (true) or not (false). | | `N8N_PUBLIC_API_DISABLED` | Boolean | `false` | Whether to disable the public API (false) or not (true). | | `N8N_PUBLIC_API_ENDPOINT` | String | `api` | Path for the public API endpoints. | -| `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | Number | `30` | How long should n8n process wait (in seconds) for components to shut down before exiting the process. | +| `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` | Number | `30` | How long should the n8n process wait (in seconds) for components to shut down before exiting the process. | ## Binary data From f79a01b36a8684bebad983b8fea4847ef96694b7 Mon Sep 17 00:00:00 2001 From: Tomi Turtiainen <10324676+tomi@users.noreply.github.com> Date: Mon, 18 Dec 2023 12:46:12 +0200 Subject: [PATCH 3/3] use code block for env var --- docs/hosting/environment-variables/environment-variables.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/hosting/environment-variables/environment-variables.md b/docs/hosting/environment-variables/environment-variables.md index 8ad25310c9f..a78b11e5f56 100644 --- a/docs/hosting/environment-variables/environment-variables.md +++ b/docs/hosting/environment-variables/environment-variables.md @@ -229,7 +229,7 @@ Refer to [External storage](/hosting/external-storage/) for more information on | `QUEUE_BULL_REDIS_CLUSTER_NODES` | String | - | Expects a comma-separated list of Redis Cluster nodes in the format `host:port`, for the Redis client to initially connect to. If running in queue mode (`EXECUTIONS_MODE = queue`), setting this variable will create a Redis Cluster client instead of a Redis client, and n8n will ignore `QUEUE_BULL_REDIS_HOST` and `QUEUE_BULL_REDIS_PORT`. | | `QUEUE_BULL_REDIS_TLS` | Boolean | `false` | Enable TLS on Redis connections. | | `QUEUE_RECOVERY_INTERVAL` | Number | `60` | Interval (in seconds) for active polling to the queue to recover from Redis crashes. `0` disables recovery. May increase Redis traffic significantly. | -| `QUEUE_WORKER_TIMEOUT` (**deprecated**) | Number | `30` | **Deprecated** Use N8N_GRACEFUL_SHUTDOWN_TIMEOUT instead.

How long should n8n wait (seconds) for running executions before exiting worker process on shutdown. | +| `QUEUE_WORKER_TIMEOUT` (**deprecated**) | Number | `30` | **Deprecated** Use `N8N_GRACEFUL_SHUTDOWN_TIMEOUT` instead.

How long should n8n wait (seconds) for running executions before exiting worker process on shutdown. | | `QUEUE_HEALTH_CHECK_ACTIVE` | Boolean | `false` | Whether to enable health checks (true) or disable (false). | | `QUEUE_HEALTH_CHECK_PORT` | Number | - | The port to serve health checks on. | | `QUEUE_WORKER_LOCK_DURATION` | Number | `30000` | How long (in ms) is the lease period for a worker to work on a message. |