From 12d7a81f317dbca702d4502414ebeb55dda241a6 Mon Sep 17 00:00:00 2001 From: Salim B Date: Thu, 6 Jun 2024 17:27:32 +0200 Subject: [PATCH] docs: describe `NC_DISABLE_EMAIL_AUTH` (#8662) * docs: describe `NC_DISABLE_EMAIL_AUTH` * docs: better arrange env vars --- .../050.self-hosted/020.environment-variables.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md b/packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md index 7e24657206..be86845491 100644 --- a/packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md +++ b/packages/noco-docs/docs/020.getting-started/050.self-hosted/020.environment-variables.md @@ -40,7 +40,6 @@ The following table lists all the environment variables that can be set to confi | `NUXT_PUBLIC_NC_BACKEND_URL` | Custom backend URL. | Defaults to `http://localhost:8080`. | | `NC_REQUEST_BODY_SIZE` | Request body size [limit](https://expressjs.com/en/resources/middleware/body-parser.html#limit) | Defaults to `1048576`. | | `NC_EXPORT_MAX_TIMEOUT` | After `NC_EXPORT_MAX_TIMEOUT` (in milliseconds), CSV gets downloaded in batches. | Defaults to `5000` (5 seconds). | -| `NC_DISABLE_TELE` | Disable telemetry. | | | `NC_DASHBOARD_URL` | Custom dashboard URL path | Defaults to `/dashboard`. | | `NC_GOOGLE_CLIENT_ID` | Google client ID to enable Google authentication. | | | `NC_GOOGLE_CLIENT_SECRET` | Google client secret to enable Google authentication. | | @@ -48,8 +47,11 @@ The following table lists all the environment variables that can be set to confi | `NC_MIN` | Disable default splash screen (initial welcome animation) and matrix screensaver. | | | `NC_SENTRY_DSN` | Data Source Name (DSN) for Sentry monitoring. | | | `NC_REDIS_URL` | Redis URL. Example: `redis://:authpassword@127.0.0.1:6380/4` | Meta data is stored in memory. | -| `NC_DISABLE_ERR_REPORT` | Disable error reporting. | | | `NC_DISABLE_CACHE` | Disable cache. To be used only while debugging. If `true`, meta data is fetched from database instead of redis/cache. | Defaults to `false`. | +| `NC_DISABLE_ERR_REPORT` | Disable error reporting. | | +| `NC_DISABLE_TELE` | Disable telemetry. | | +| `NC_DISABLE_EMAIL_AUTH` | Disable authentication via e-mail and password. | Authentication via e-mail and password is enabled. | +| `NC_DISABLE_AUDIT` | Disable audit log. | Defaults to `false`. | | `NC_SMTP_FROM` | E-mail sender address for SMTP plugin. | *SMTP plugin is disabled if this variable is not set.* | | `NC_SMTP_HOST` | E-mail server hostname for SMTP plugin. | *SMTP plugin is disabled if this variable is not set.* | | `NC_SMTP_PORT` | E-mail server network for SMTP plugin. | *SMTP plugin is disabled if this variable is not set.* | @@ -65,7 +67,6 @@ The following table lists all the environment variables that can be set to confi | `NC_MAX_ATTACHMENTS_ALLOWED` | Maximum number of attachments per cell. | Defaults to `10`. | | `NC_SECURE_ATTACHMENTS` | Allow accessing attachments only through pre-signed URLs. Set to `true` to enable, any other value is treated as `false`. (⚠ this will make existing links inaccessible ⚠) | Defaults to `false`. | | `NC_ATTACHMENT_EXPIRE_SECONDS` | Number of seconds after which pre-signed attachment URLs will begin to expire. The URLs will expire after `NC_ATTACHMENT_EXPIRE_SECONDS` plus 10 minutes at the very latest. | Defaults to `7200` (2 hours). | -| `NC_DISABLE_AUDIT` | Disable audit log. | Defaults to `false`. | | `NC_AUTOMATION_LOG_LEVEL` | Possible Values: `OFF`, `ERROR`, `ALL`. See [Webhooks](/automation/webhook/create-webhook#call-log) for details. | Defaults to `OFF`. | | `NC_ALLOW_LOCAL_HOOKS` | ⚠ Allow webhooks to call local links, which can raise security issues. ⚠ Set to `true` to enable, any other value is treated as `false` | Defaults to `false`. | | `NC_SANITIZE_COLUMN_NAME` | Sanitize the column name during column creation. Set to `true` to enable, any other value is treated as `false` | Defaults to `true`. |