From 38db894a3cfe0834cb0cdaa9738d8e10d9602e46 Mon Sep 17 00:00:00 2001 From: Pranav C Date: Wed, 8 Dec 2021 16:08:47 +0530 Subject: [PATCH] docs: update environment variables Signed-off-by: Pranav C --- .../en/getting-started/installation.md | 27 +++++++++---------- 1 file changed, 13 insertions(+), 14 deletions(-) diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index 5a2f65835b..a620f6f696 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -143,31 +143,30 @@ And connection params for this database can be specified in `NC_DB` environment | NC_DB_JSON_FILE | Yes | Can be used instead of `NC_DB` and value should be a valid path to knex connection JSON | | | DATABASE_URL | No | JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| | | DATABASE_URL_FILE | No | path to file containing JDBC URL Format. Can be used instead of NC_DB. Used in 1-Click Heroku deployment| | +| NC_DASHBOARD_URL | No | Custom dashboard url path | `/dashboard` | +| NC_TOOL_DIR | No | App directory to keep metadata and app related files | Defaults to current working directory. In docker maps to `/usr/app/data/` for mounting volume. | | NC_PUBLIC_URL | Yes | Used for sending Email invitations | Best guess from http request params | | NC_AUTH_JWT_SECRET | Yes | JWT secret used for auth and storing other secrets | A Random secret will be generated | -| NC_SENTRY_DSN | No | For Sentry monitoring | | +| NC_JWT_EXPIRES_IN | No | JWT token expiry time | `10h` | | NC_CONNECT_TO_EXTERNAL_DB_DISABLED | No | Disable Project creation with external database | | -| NC_DISABLE_TELE | No | Disable telemetry | | +| NC_INVITE_ONLY_SIGNUP | No | Allow users to signup only via invite url, value should be any non-empty string. | | | NC_BACKEND_URL | No | Custom Backend URL | ``http://localhost:8080`` will be used | -| AWS_ACCESS_KEY_ID | No | For Litestream - S3 access key id | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | -| AWS_SECRET_ACCESS_KEY | No | For Litestream - S3 secret access key | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | -| AWS_BUCKET | No | For Litestream - S3 bucket | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | -| AWS_BUCKET_PATH | No | For Litestream - S3 bucket path (like folder within S3 bucket) | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | +| NC_REQUEST_BODY_SIZE | No | Request body size [limit](https://expressjs.com/en/resources/middleware/body-parser.html#limit) | `1048576` | | NC_EXPORT_MAX_TIMEOUT | No | After NC_EXPORT_MAX_TIMEOUT csv gets downloaded in batches | Default value 5000(in millisecond) will be used | | DB_QUERY_LIMIT_MAX | No | Maximum allowed pagination limit | 100 | -| NC_DASHBOARD_URL | No | Custom dashboard url path | `/dashboard` | -| NC_GITHUB_CLIENT_ID | No | Github client id to enable github authentication | | -| NC_GITHUB_CLIENT_SECRET | No | Github client secret to enable github authentication | | +| DB_QUERY_LIMIT_MIN | No | Minimum allowed pagination limit | 1 | +| NC_DISABLE_TELE | No | Disable telemetry | | | NC_GOOGLE_CLIENT_ID | No | Google client id to enable google authentication | | | NC_GOOGLE_CLIENT_SECRET | No | Google client secret to enable google authentication | | -| NC_DASHBOARD_URL | No | Custom dashboard url path | `/dashboard` | -| NC_INVITE_ONLY_SIGNUP | No | Allow users to signup only via invite url, value should be any non-empty string. | | -| NC_JWT_EXPIRES_IN | No | JWT token expiry time | `10h` | | NC_MIGRATIONS_DISABLED | No | Disable NocoDB migration | | | NC_ONE_CLICK | No | Used for Heroku one-click deployment | | -| NC_REQUEST_BODY_SIZE | No | Request body size [limit](https://expressjs.com/en/resources/middleware/body-parser.html#limit) | `1048576` | -| NC_TOOL_DIR | No | App directory to keep metadata and app related files | Defaults to current working directory. In docker maps to `/usr/app/data/` for mounting volume. | | PORT | No | For setting app running port | `8080` | +| NC_SENTRY_DSN | No | For Sentry monitoring | | +| NC_DISABLE_ERR_REPORT | No | Disable error reporting | | +| AWS_ACCESS_KEY_ID | No | For Litestream - S3 access key id | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | +| AWS_SECRET_ACCESS_KEY | No | For Litestream - S3 secret access key | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | +| AWS_BUCKET | No | For Litestream - S3 bucket | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | +| AWS_BUCKET_PATH | No | For Litestream - S3 bucket path (like folder within S3 bucket) | If Litestream is configured and NC_DB is not present. SQLite gets backed up to S3 | ### Docker Compose