diff --git a/README.md b/README.md index b4dc25ff27..091309a040 100644 --- a/README.md +++ b/README.md @@ -267,7 +267,7 @@ By default, SQLite is used for storing meta data. However, you can specify your ## Environment variables -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Development Setup diff --git a/markdown/readme/languages/chinese.md b/markdown/readme/languages/chinese.md index 3880ac417e..b68232973c 100644 --- a/markdown/readme/languages/chinese.md +++ b/markdown/readme/languages/chinese.md @@ -201,7 +201,7 @@ docker-compose up -d ## 环境变量 -参见[环境变量](https://docs.nocodb.com/getting-started/installation#environment-variables) +参见[环境变量](https://docs.nocodb.com/getting-started/environment-variables) # 开发 diff --git a/markdown/readme/languages/dutch.md b/markdown/readme/languages/dutch.md index ed45c20743..445043774d 100644 --- a/markdown/readme/languages/dutch.md +++ b/markdown/readme/languages/dutch.md @@ -181,7 +181,7 @@ docker-compose up -d ## Environment variables -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Development setup diff --git a/markdown/readme/languages/french.md b/markdown/readme/languages/french.md index cce007c8c8..52036eaf49 100644 --- a/markdown/readme/languages/french.md +++ b/markdown/readme/languages/french.md @@ -182,7 +182,7 @@ docker-compose up -d ## Variables d'environnement -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Paramétrage du développement diff --git a/markdown/readme/languages/german.md b/markdown/readme/languages/german.md index 2784eb794e..7707156fc9 100644 --- a/markdown/readme/languages/german.md +++ b/markdown/readme/languages/german.md @@ -190,7 +190,7 @@ docker-compose up -d ## Umgebungsvariablen -Siehe [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Siehe [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Entwicklungsaufbau diff --git a/markdown/readme/languages/indonesian.md b/markdown/readme/languages/indonesian.md index db92fd3bc9..a3fff11549 100644 --- a/markdown/readme/languages/indonesian.md +++ b/markdown/readme/languages/indonesian.md @@ -182,7 +182,7 @@ docker-compose up -d ## Environment variables -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Pengaturan Pengembangan diff --git a/markdown/readme/languages/italian.md b/markdown/readme/languages/italian.md index d9a01cab86..bf53b18865 100644 --- a/markdown/readme/languages/italian.md +++ b/markdown/readme/languages/italian.md @@ -185,7 +185,7 @@ docker-compose up -d ## Variabili d'ambiente -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Setup di sviluppo diff --git a/markdown/readme/languages/japanese.md b/markdown/readme/languages/japanese.md index 9f5dc2dd4c..3253f94d6d 100644 --- a/markdown/readme/languages/japanese.md +++ b/markdown/readme/languages/japanese.md @@ -184,7 +184,7 @@ docker-compose up -d ## 環境変数 -[環境変数](https://docs.nocodb.com/getting-started/installation#environment-variables)をご参照ください +[環境変数](https://docs.nocodb.com/getting-started/environment-variables)をご参照ください # 開発セットアップ diff --git a/markdown/readme/languages/korean.md b/markdown/readme/languages/korean.md index 91bb1b9402..0abf7ed054 100644 --- a/markdown/readme/languages/korean.md +++ b/markdown/readme/languages/korean.md @@ -185,7 +185,7 @@ docker-compose up -d ## 환경변수 여기서 확인해주세요. -[환경변수 ](https://docs.nocodb.com/getting-started/installation#environment-variables) +[환경변수 ](https://docs.nocodb.com/getting-started/environment-variables) # 개발 환경에 설치 diff --git a/markdown/readme/languages/portuguese.md b/markdown/readme/languages/portuguese.md index e643bcc0d6..77b2b69043 100644 --- a/markdown/readme/languages/portuguese.md +++ b/markdown/readme/languages/portuguese.md @@ -183,7 +183,7 @@ docker-compose up -d ## Environment variables -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Development setup diff --git a/markdown/readme/languages/russian.md b/markdown/readme/languages/russian.md index 51aa48597b..cd7ada6be7 100644 --- a/markdown/readme/languages/russian.md +++ b/markdown/readme/languages/russian.md @@ -185,7 +185,7 @@ docker-compose up -d ## Переменные среды -Please refer to [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Please refer to [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Настройка разработки diff --git a/markdown/readme/languages/spanish.md b/markdown/readme/languages/spanish.md index d70f3ba6b1..b5ac72a6f4 100644 --- a/markdown/readme/languages/spanish.md +++ b/markdown/readme/languages/spanish.md @@ -182,7 +182,7 @@ docker-compose up -d ## Variables de entorno -Por favor diríjase a [Environment variables](https://docs.nocodb.com/getting-started/installation#environment-variables) +Por favor diríjase a [Environment variables](https://docs.nocodb.com/getting-started/environment-variables) # Configuración de desarollo diff --git a/packages/noco-docs/content/en/getting-started/environment-variables.md b/packages/noco-docs/content/en/getting-started/environment-variables.md new file mode 100644 index 0000000000..19cf938fe2 --- /dev/null +++ b/packages/noco-docs/content/en/getting-started/environment-variables.md @@ -0,0 +1,66 @@ +--- +title: 'Environment Variables' +description: 'Environment Variables for NocoDB!' +position: 15 +category: 'Getting started' +--- + +## Environment Variables + +For production usecases, it is **recommended** to configure +- `NC_DB`, +- `NC_AUTH_JWT_SECRET`, +- `NC_PUBLIC_URL`, +- `NC_REDIS_URL` + +| Variable | Comments | If absent | | +|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|---| +| NC_DB | See our database URLs | A local SQLite will be created in root folder if `NC_DB` is not provided | | +| NC_DB_JSON | Can be used instead of `NC_DB` and value should be valid knex connection JSON | | | +| NC_DB_JSON_FILE | Can be used instead of `NC_DB` and value should be a valid path to knex connection JSON | | | +| DATABASE_URL | JDBC URL Format. Can be used instead of NC_DB. | | | +| DATABASE_URL_FILE | Can be used instead of DATABASE_URL: path to file containing JDBC URL Format. | | | +| NC_AUTH_JWT_SECRET | JWT secret used for auth and storing other secrets | A random secret will be generated | | +| PORT | For setting app running port | `8080` | | +| DB_QUERY_LIMIT_DEFAULT | Default pagination limit | 25 | | +| DB_QUERY_LIMIT_MAX | Maximum allowed pagination limit | 1000 | | +| DB_QUERY_LIMIT_MIN | Minimum allowed pagination limit | 1 | | +| NC_TOOL_DIR | 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 | Used for sending Email invitations | Best guess from http request params | | +| NC_JWT_EXPIRES_IN | JWT token expiry time | `10h` | | +| NC_CONNECT_TO_EXTERNAL_DB_DISABLED | Disable Project creation with external database | | | +| NC_INVITE_ONLY_SIGNUP | Removed since version 0.99.0 and now it's recommended to use [super admin settings menu](/setup-and-usages/account-settings#enable--disable-signup). Allow users to signup only via invite url, value should be any non-empty string. | | | +| NUXT_PUBLIC_NC_BACKEND_URL | Custom Backend URL | ``http://localhost:8080`` will be used | | +| NC_REQUEST_BODY_SIZE | Request body size [limit](https://expressjs.com/en/resources/middleware/body-parser.html#limit) | `1048576` | | +| NC_EXPORT_MAX_TIMEOUT | After NC_EXPORT_MAX_TIMEOUT csv gets downloaded in batches | Default value 5000(in millisecond) will be used | | +| NC_DISABLE_TELE | Disable telemetry | | | +| NC_DASHBOARD_URL | Custom dashboard url path | `/dashboard` | | +| NC_GOOGLE_CLIENT_ID | Google client id to enable google authentication | | | +| NC_GOOGLE_CLIENT_SECRET | Google client secret to enable google authentication | | | +| NC_MIGRATIONS_DISABLED | Disable NocoDB migration | | | +| NC_MIN | If set to any non-empty string the default splash screen(initial welcome animation) and matrix screensaver will disable | | | +| NC_SENTRY_DSN | For Sentry monitoring | | | +| NC_REDIS_URL | Custom Redis URL. Example: `redis://:authpassword@127.0.0.1:6380/4` | Meta data will be stored in memory | | +| NC_DISABLE_ERR_REPORT | Disable error reporting | | | +| NC_DISABLE_CACHE | To be used only while debugging. On setting this to `true` - meta data be fetched from db instead of redis/cache. | `false` | | +| NC_BASEURL_INTERNAL | Used as base url for internal(server) API calls | Default value in docker will be `http://localhost:$PORT` and in all other case it's populated from request object | | +| AWS_ACCESS_KEY_ID | 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 | For Litestream - S3 secret access key | If Litestream is configured and `NC_DB` is not present. SQLite gets backed up to S3 | | +| AWS_BUCKET | For Litestream - S3 bucket | If Litestream is configured and `NC_DB` is not present. SQLite gets backed up to S3 | | +| AWS_BUCKET_PATH | 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_SMTP_FROM | For SMTP plugin - Email sender address | | | +| NC_SMTP_HOST | For SMTP plugin - SMTP host value | | | +| NC_SMTP_PORT | For SMTP plugin - SMTP port value | | | +| NC_SMTP_USERNAME | For SMTP plugin (Optional) - SMTP username value for authentication | | | +| NC_SMTP_PASSWORD | For SMTP plugin (Optional) - SMTP password value for authentication | | | +| NC_SMTP_SECURE | For SMTP plugin (Optional) - To enable secure set value as `true` any other value treated as false | | | +| NC_SMTP_IGNORE_TLS | For SMTP plugin (Optional) - To ignore tls set value as `true` any other value treated as false. For more info visit https://nodemailer.com/smtp/ | | | +| NC_S3_BUCKET_NAME | For S3 storage plugin - AWS S3 bucket name | | | +| NC_S3_REGION | For S3 storage plugin - AWS S3 region | | | +| NC_S3_ACCESS_KEY | For S3 storage plugin - AWS access key credential for accessing resource | | | +| NC_S3_ACCESS_SECRET | For S3 storage plugin - AWS access secret credential for accessing resource | | | +| NC_ADMIN_EMAIL | For updating/creating super admin with provided email and password | | | +| NC_ATTACHMENT_FIELD_SIZE | For setting the attachment field size(in Bytes) | Defaults to 20MB | | +| NC_ADMIN_PASSWORD | For updating/creating super admin with provided email and password. Your password should have at least 8 letters with one uppercase, one number and one special letter(Allowed special chars $&+,:;=?@#\|'.^*()%!_-" ) | | | +| NODE_OPTIONS | For passing Node.js [options](https://nodejs.org/api/cli.html#node_optionsoptions) to instance | | | +| NC_MINIMAL_DBS | Create a new SQLite file for each project. All the db files are stored in `nc_minimal_dbs` folder in current working directory. (This option restricts project creation on external sources) | | | diff --git a/packages/noco-docs/content/en/getting-started/installation.md b/packages/noco-docs/content/en/getting-started/installation.md index 7bb06cd111..466b4e5125 100644 --- a/packages/noco-docs/content/en/getting-started/installation.md +++ b/packages/noco-docs/content/en/getting-started/installation.md @@ -443,61 +443,6 @@ npm start See [here](https://gist.github.com/Zamana/e9281d736f9e9ce5882c6f4b140a590e) provided by [C. R. Zamana](https://github.com/Zamana). -## Environment Variables - -Here is the list of the environment variables that you can use. Even though they are optional, it is **recommended** to configure `NC_DB`, `NC_AUTH_JWT_SECRET`, and `NC_PUBLIC_URL` for production use cases. - -| Variable | Comments | If absent | | -|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------|---| -| NC_DB | See our database URLs | A local SQLite will be created in root folder if `NC_DB` is not provided | | -| NC_DB_JSON | Can be used instead of `NC_DB` and value should be valid knex connection JSON | | | -| NC_DB_JSON_FILE | Can be used instead of `NC_DB` and value should be a valid path to knex connection JSON | | | -| DATABASE_URL | JDBC URL Format. Can be used instead of NC_DB. | | | -| DATABASE_URL_FILE | Can be used instead of DATABASE_URL: path to file containing JDBC URL Format. | | | -| NC_AUTH_JWT_SECRET | JWT secret used for auth and storing other secrets | A random secret will be generated | | -| PORT | For setting app running port | `8080` | | -| DB_QUERY_LIMIT_DEFAULT | Default pagination limit | 25 | | -| DB_QUERY_LIMIT_MAX | Maximum allowed pagination limit | 1000 | | -| DB_QUERY_LIMIT_MIN | Minimum allowed pagination limit | 1 | | -| NC_TOOL_DIR | 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 | Used for sending Email invitations | Best guess from http request params | | -| NC_JWT_EXPIRES_IN | JWT token expiry time | `10h` | | -| NC_CONNECT_TO_EXTERNAL_DB_DISABLED | Disable Project creation with external database | | | -| NC_INVITE_ONLY_SIGNUP | Removed since version 0.99.0 and now it's recommended to use [super admin settings menu](/setup-and-usages/account-settings#enable--disable-signup). Allow users to signup only via invite url, value should be any non-empty string. | | | -| NUXT_PUBLIC_NC_BACKEND_URL | Custom Backend URL | ``http://localhost:8080`` will be used | | -| NC_REQUEST_BODY_SIZE | Request body size [limit](https://expressjs.com/en/resources/middleware/body-parser.html#limit) | `1048576` | | -| NC_EXPORT_MAX_TIMEOUT | After NC_EXPORT_MAX_TIMEOUT csv gets downloaded in batches | Default value 5000(in millisecond) will be used | | -| NC_DISABLE_TELE | Disable telemetry | | | -| NC_DASHBOARD_URL | Custom dashboard url path | `/dashboard` | | -| NC_GOOGLE_CLIENT_ID | Google client id to enable google authentication | | | -| NC_GOOGLE_CLIENT_SECRET | Google client secret to enable google authentication | | | -| NC_MIGRATIONS_DISABLED | Disable NocoDB migration | | | -| NC_MIN | If set to any non-empty string the default splash screen(initial welcome animation) and matrix screensaver will disable | | | -| NC_SENTRY_DSN | For Sentry monitoring | | | -| NC_REDIS_URL | Custom Redis URL. Example: `redis://:authpassword@127.0.0.1:6380/4` | Meta data will be stored in memory | | -| NC_DISABLE_ERR_REPORT | Disable error reporting | | | -| NC_DISABLE_CACHE | To be used only while debugging. On setting this to `true` - meta data be fetched from db instead of redis/cache. | `false` | | -| NC_BASEURL_INTERNAL | Used as base url for internal(server) API calls | Default value in docker will be `http://localhost:$PORT` and in all other case it's populated from request object | | -| AWS_ACCESS_KEY_ID | 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 | For Litestream - S3 secret access key | If Litestream is configured and `NC_DB` is not present. SQLite gets backed up to S3 | | -| AWS_BUCKET | For Litestream - S3 bucket | If Litestream is configured and `NC_DB` is not present. SQLite gets backed up to S3 | | -| AWS_BUCKET_PATH | 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_SMTP_FROM | For SMTP plugin - Email sender address | | | -| NC_SMTP_HOST | For SMTP plugin - SMTP host value | | | -| NC_SMTP_PORT | For SMTP plugin - SMTP port value | | | -| NC_SMTP_USERNAME | For SMTP plugin (Optional) - SMTP username value for authentication | | | -| NC_SMTP_PASSWORD | For SMTP plugin (Optional) - SMTP password value for authentication | | | -| NC_SMTP_SECURE | For SMTP plugin (Optional) - To enable secure set value as `true` any other value treated as false | | | -| NC_SMTP_IGNORE_TLS | For SMTP plugin (Optional) - To ignore tls set value as `true` any other value treated as false. For more info visit https://nodemailer.com/smtp/ | | | -| NC_S3_BUCKET_NAME | For S3 storage plugin - AWS S3 bucket name | | | -| NC_S3_REGION | For S3 storage plugin - AWS S3 region | | | -| NC_S3_ACCESS_KEY | For S3 storage plugin - AWS access key credential for accessing resource | | | -| NC_S3_ACCESS_SECRET | For S3 storage plugin - AWS access secret credential for accessing resource | | | -| NC_ADMIN_EMAIL | For updating/creating super admin with provided email and password | | | -| NC_ATTACHMENT_FIELD_SIZE | For setting the attachment field size(in Bytes) | Defaults to 20MB | | -| NC_ADMIN_PASSWORD | For updating/creating super admin with provided email and password. Your password should have at least 8 letters with one uppercase, one number and one special letter(Allowed special chars $&+,:;=?@#\|'.^*()%!_-" ) | | | -| NODE_OPTIONS | For passing Node.js [options](https://nodejs.org/api/cli.html#node_optionsoptions) to instance | | | -| NC_MINIMAL_DBS | Create a new SQLite file for each project. All the db files are stored in `nc_minimal_dbs` folder in current working directory. (This option restricts project creation on external sources) | | | ## Sample Demos