mirrors/n8n-docs
2
0
Fork 0
mirror of https://github.com/n8n-io/n8n-docs.git synced 2025-11-20 17:48:34 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

additional env vars

Browse Source
This commit is contained in:
Deborah Barnard 2022-03-15 09:41:09 +00:00
parent 9d6897ae9b
commit faf318e873
2 changed files with 25 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/reference/environment-variables.md
View File

@ -83,12 +83,21 @@ Enabling overwrites for credentials allows you to set default values for credent
| `N8N_DEFAULT_BINARY_DATA_MODE` | `string` | The default binary data mode. Default value is `default` and keeps binary data in memory. Set to `filesystem` in order to use the filesystem. |
| `N8N_PERSISTED_BINARY_DATA_TTL` | `number` | Time to live (in minutes) for persisted data. Default is `1440`. |
| `VUE_APP_URL_BASE_API` | `string` | Used when building the `n8n-editor-ui` package manually to indicate how the frontend can reach the backend API. |
## User management and SMTP
| Variable | Type | Description |
| :------- | :--- | :---------- |
| `N8N_USER_MANAGEMENT_DISABLED` | Boolean | Defaults to user management enabled (false). Set to `true` to disable the [user management](user-management.md) feature. Note that n8n ignores this environment variable if you have already set up an owner account. |
| `N8N_EMAIL_MODE` | string | smtp |
| `N8N_SMTP_HOST` | string | _your_server_name_ |
| `N8N_SMTP_USER` | string | _your_smtp_username_ |
| `N8N_SMTP_PASS` | string | _your_smtp_password_ |
| `N8N_SMTP_SENDER` | string | _your_smtp_sender_name_ |
| `N8N_EMAIL_MODE` | string | SMTP | Required |
| `N8N_SMTP_HOST` | string | _your_SMTP_server_name_ | Required |
| `N8N_SMTP_PORT` | number | _your_SMTP_server_port_ | Optional |
| `N8N_SMTP_USER` | string | _your_SMTP_username_ | Required |
| `N8N_SMTP_PASS` | string | _your_SMTP_password_ | Required |
| `N8N_SMTP_SENDER` | string | _your_SMTP_sender_name_ | Required |
| `N8N_SMTP_SSL` | boolean | Whether to use SSL for SMTP (true) or not (false). Defaults to `true`. | Optional |
| `N8N_UM_EMAIL_TEMPLATES_INVITE` | string | Full path to your HTML email template. This overrides the default template for invite emails. | Optional |
| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | string | Full path to your HTML email template. This overrides the default template for password reset emails. | Optional |
## Endpoints

18
docs/reference/user-management.md
View File

@ -54,13 +54,17 @@ You need an SMTP server for user management to send invites and password resets.
To set up SMTP with n8n, configure the SMTP environment variables for your n8n instance. For information on how to set environment variables, refer to [Configuration](../getting-started/installation/advanced/configuration.md)
| Variable | Type | Value |
| -------- | ---- | ----- |
| `N8N_EMAIL_MODE` | string | smtp |
| `N8N_SMTP_HOST` | string | _your_server_name_ |
| `N8N_SMTP_USER` | string | _your_smtp_username_ |
| `N8N_SMTP_PASS` | string | _your_smtp_password_ |
| `N8N_SMTP_SENDER` | string | _your_smtp_sender_name_ |
| Variable | Type | Description | Required? |
| -------- | ---- | ----------- | --------- |
| `N8N_EMAIL_MODE` | string | SMTP | Required |
| `N8N_SMTP_HOST` | string | _your_SMTP_server_name_ | Required |
| `N8N_SMTP_PORT` | number | _your_SMTP_server_port_ | Optional |
| `N8N_SMTP_USER` | string | _your_SMTP_username_ | Required |
| `N8N_SMTP_PASS` | string | _your_SMTP_password_ | Required |
| `N8N_SMTP_SENDER` | string | _your_SMTP_sender_name_ | Required |
| `N8N_SMTP_SSL` | boolean | Whether to use SSL for SMTP (true) or not (false). Defaults to `true`. | Optional |
| `N8N_UM_EMAIL_TEMPLATES_INVITE` | string | Full path to your HTML email template. This overrides the default template for invite emails. | Optional |
| `N8N_UM_EMAIL_TEMPLATES_PWRESET` | string | Full path to your HTML email template. This overrides the default template for password reset emails. | Optional |
If your n8n instance is already running, you need to restart it to enable the new SMTP settings.