Browse Source

docs: update environment variables

Signed-off-by: Pranav C <pranavxc@gmail.com>
pull/843/head
Pranav C 3 years ago
parent
commit
e233db8284
  1. 19
      packages/noco-docs/content/en/getting-started/installation.md

19
packages/noco-docs/content/en/getting-started/installation.md

@ -139,6 +139,8 @@ And connection params for this database can be specified in `NC_DB` environment
| Variable | Mandatory | Comments | If absent |
|-------------------------|-----------|----------------------------------------------------------------------------------|--------------------------------------------|
| NC_DB | Yes | See our database URLs | A local SQLite will be created in root folder |
| NC_DB_JSON | Yes | Can be used instead of `NC_DB` and value should be valid knex connection JSON | |
| 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_PUBLIC_URL | Yes | Used for sending Email invitations | Best guess from http request params |
@ -152,7 +154,24 @@ And connection params for this database can be specified in `NC_DB` environment
| 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_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` |
[comment]: <> (| NC_GITHUB_CLIENT_ID | No | Github client id to enable github authentication | |)
[comment]: <> (| NC_GITHUB_CLIENT_SECRET | No | Github client secret to enable github authentication | |)
[comment]: <> (| NC_GOOGLE_CLIENT_ID | No | Google client id to enable google authentication | |)
[comment]: <> (| 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` |
### Docker Compose

Loading…
Cancel
Save