From b0f9f33532d04838633e4dfd6a4a7a13948b2a89 Mon Sep 17 00:00:00 2001 From: Thomas S Date: Wed, 28 Dec 2022 17:46:59 +0100 Subject: [PATCH] docs(env-var): add new var QUEUE_BULL_REDIS_USERNAME --- .../environment-variables.md | 23 ++++++++++--------- docs/hosting/scaling/queue-mode.md | 7 +++--- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/docs/hosting/environment-variables/environment-variables.md b/docs/hosting/environment-variables/environment-variables.md index 6407468ffa5..1070bce0b0d 100644 --- a/docs/hosting/environment-variables/environment-variables.md +++ b/docs/hosting/environment-variables/environment-variables.md @@ -89,19 +89,19 @@ Enabling overwrites for credentials allows you to set default values for credent Refer to [User management](/hosting/authentication/user-management-self-hosted/) for more information on setting up user management and emails. -| Variable | Type | Default | Description | -| :------- | :--- | :------ | :---------- | -| `N8N_USER_MANAGEMENT_DISABLED` | Boolean | `false` | Set to `true` to disable the [user management](/hosting/authentication/user-management-self-hosted/) feature. Note that n8n ignores this environment variable if you have already set up an owner account.| +| Variable | Type | Default | Description | +| :------- | :--- | :------ | :---------- | +| `N8N_USER_MANAGEMENT_DISABLED` | Boolean | `false` | Set to `true` to disable the [user management](/hosting/authentication/user-management-self-hosted/) feature. Note that n8n ignores this environment variable if you have already set up an owner account.| | `N8N_EMAIL_MODE` | String | `smtp` | Enable emails. | -| `N8N_SMTP_HOST` | String | - | _your_SMTP_server_name_ | -| `N8N_SMTP_PORT` | Number | - | _your_SMTP_server_port_ | +| `N8N_SMTP_HOST` | String | - | _your_SMTP_server_name_ | +| `N8N_SMTP_PORT` | Number | - | _your_SMTP_server_port_ | | `N8N_SMTP_USER` | String | - | _your_SMTP_username_ | -| `N8N_SMTP_PASS` | String | - | _your_SMTP_password_ | -| `N8N_SMTP_SENDER` | String | - | Sender email address. You can optionally include the sender name. Example with name: _N8N ``_ | -| `N8N_SMTP_SSL` | Boolean | `true` | Whether to use SSL for SMTP (true) or not (false). | -| `N8N_UM_EMAIL_TEMPLATES_INVITE` | String | - | Full path to your HTML email template. This overrides the default template for invite emails. | -| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | String | - | Full path to your HTML email template. This overrides the default template for password reset emails. | -| `N8N_USER_MANAGEMENT_JWT_SECRET` | String | - | Set a specific JWT secret. By default, n8n generates one on start. | +| `N8N_SMTP_PASS` | String | - | _your_SMTP_password_ | +| `N8N_SMTP_SENDER` | String | - | Sender email address. You can optionally include the sender name. Example with name: _N8N ``_ | +| `N8N_SMTP_SSL` | Boolean | `true` | Whether to use SSL for SMTP (true) or not (false). | +| `N8N_UM_EMAIL_TEMPLATES_INVITE` | String | - | Full path to your HTML email template. This overrides the default template for invite emails. | +| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | String | - | Full path to your HTML email template. This overrides the default template for password reset emails. | +| `N8N_USER_MANAGEMENT_JWT_SECRET` | String | - | Set a specific JWT secret. By default, n8n generates one on start. | ## Endpoints @@ -173,6 +173,7 @@ Refer to [User management](/hosting/authentication/user-management-self-hosted/) | `QUEUE_BULL_REDIS_DB` | Number | `0` | The Redis database used. | | `QUEUE_BULL_REDIS_HOST` | String | `localhost` | The Redis host. | | `QUEUE_BULL_REDIS_PORT` | Number | `6379` | The Redis port used. | +| `QUEUE_BULL_REDIS_USERNAME` | String | - | The Redis username (needs Redis >= 6). 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_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. | diff --git a/docs/hosting/scaling/queue-mode.md b/docs/hosting/scaling/queue-mode.md index 1cd549a9309..e17504f95a7 100644 --- a/docs/hosting/scaling/queue-mode.md +++ b/docs/hosting/scaling/queue-mode.md @@ -65,17 +65,18 @@ You can also set the following optional configurations: | Via configuration file | Via environment variables | Description | | ------ | ------ | ----- | +| `queue.bull.redis.username:USERNAME` | `QUEUE_BULL_REDIS_USERNAME` | By default, Redis doesn't require a username. If you're using a specific user, configure it variable. | | `queue.bull.redis.password:PASSWORD` | `QUEUE_BULL_REDIS_PASSWORD` | By default, Redis doesn't require a password. If you're using a password, configure it variable. | | `queue.bull.redis.db:0` | `QUEUE_BULL_REDIS_DB` | The default value is `0`. If you change this value, update the configuration. | | `queue.bull.redis.timeoutThreshold:10000ms` | `QUEUE_BULL_REDIS_TIMEOUT_THRESHOLD` | Tells n8n how long it should wait if Redis is unavailable before exiting. The default value is `10000ms`. | -| `queue.bull.queueRecoveryInterval:60` | `QUEUE_RECOVERY_INTERVAL` | Adds an active watchdog to n8n that checks Redis for finished executions. This is used to recover when n8n's main process loses connection temporarily to Redis and is not 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.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 is not 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. | Now you can start your n8n instance and it will connect to your Redis instance. ### Start workers -You will need to start worker processes to allow n8n to execute workflows. If you want to host workers on a separate machine, install n8n on the machine and make sure that it is connected to your Redis instance and the n8n database. +You will need to start worker processes to allow n8n to execute workflows. If you want to host workers on a separate machine, install n8n on the machine and make sure that it is connected to your Redis instance and the n8n database. Start worker processes by running the following command from the root directory: