Files
nocodb/packages/noco-docs/versioned_docs/version-0.109.7/020.getting-started/020.environment-variables.md
Pranav C 33ee9bfa62 feat: Improved UI (#6222)
* feat: Improved ui (#6156)

* refactor: revert

Signed-off-by: Pranav C <pranavxc@gmail.com>

feat: shared base

Signed-off-by: Pranav C <pranavxc@gmail.com>

fix: remove duplicate import statement

Signed-off-by: Pranav C <pranavxc@gmail.com>

fix: disable starred & license menu

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: fix airtable wait issue

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: enable mysql in ci

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: fix checkbox order for sqlite

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: disable quick tests

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: fix dbType env variable for CI

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: workspace API access error fix

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: enable SQLite CI CD

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: use DB_TYPE env variable

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: enable SQLite UT

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: isHub cleanup

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: add check for EE Timezone spec

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

chore: cleanup

Signed-off-by: Pranav C <pranavxc@gmail.com>

chore: cleanup

Signed-off-by: Pranav C <pranavxc@gmail.com>

test: EE check fix

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

chore: test correction

Signed-off-by: Pranav C <pranavxc@gmail.com>

chore: sync latest changes

Signed-off-by: Pranav C <pranavxc@gmail.com>

test: set EE=false

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

test: set NC Edition to community in workflow file

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

chore: update sdk build command

Signed-off-by: Pranav C <pranavxc@gmail.com>

refactor: i18n and other changes

Signed-off-by: Pranav C <pranavxc@gmail.com>

feat: new ui

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: sync tests

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: lint

Signed-off-by: Pranav C <pranavxc@gmail.com>

* fix: shared view/base related bugs

Signed-off-by: Pranav C <pranavxc@gmail.com>

* test: checkbox verification sort order fix

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: fix sqlite reset

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: enable selfhosted runners

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* docs: table ops (draft)

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* Docs: screenshots for table-operations.md

* refactor: introduce missing buttons

Signed-off-by: Pranav C <pranavxc@gmail.com>

* fix: get all fields

Signed-off-by: Pranav C <pranavxc@gmail.com>

* test: UT fix- new data API response

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: EE is false

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: webhook lookup as string in CE

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* fix: include created_at and updated_at

Signed-off-by: Pranav C <pranavxc@gmail.com>

* test: fix UT newDataAPI response for PG

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* fix: separate api for webhook related plugins

Signed-off-by: Pranav C <pranavxc@gmail.com>

* test: msyql filter corrections

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: mysql group by test corrections

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: fix datatype for rating field in groupby spec for pg

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: kanban datatype correction

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: column edit for mysql- rating field

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: misc fixes

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: enable 4 workers

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: enable 2 workers per shard only

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* docs: table CRUD

* Rename table-operations.md to table-crud.md

* Create column-crud.md

* docs: row CRUD

* Rename row.md to row-crud.md

* docs: project crud

* docs: toolbar (skeleton)

* refactor: single page UI and bug fixes

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: sync tests playwright

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: add missing dependency

Signed-off-by: Pranav C <pranavxc@gmail.com>

* feat: single page ui, test corrections

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: tests

Signed-off-by: Pranav C <pranavxc@gmail.com>

* test: project rename test correction

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: remove only

Signed-off-by: Pranav C <pranavxc@gmail.com>

* test: remove wrong import statement

Signed-off-by: Pranav C <pranavxc@gmail.com>

* fix: delete option not visible in project context menu

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: move ws access within isEE()

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: fix groupby

* test: groupby fix

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* docs: signup & landing page

* docs: project crud

* docs: project-crud misc

* docs: toolbar fields

* docs: toolbar / filters

* docs: toolbar / group by

* docs: toolbar / sort

* docs: toolbar / row height

* docs: filters additional options

* docs: file re-order

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* docs: add links to column types

* docs: code snippets

* docs: links

* docs: lookup

* docs: rollup

* docs: formula

* docs: primary key

* docs: display value

* docs: development setup

* docs: swagger

* fix(nc-gui): encodeURIComponent for row id

- closes: #6202

* docs: language

* docs: expanded record

* docs: import airtable

* docs: airtable

* docs: webhook

* docs: revert file rename

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* docs: account settings

* docs: audit

* docs: meta management

* docs: project settings

* docs: shared base

* docs: shared view

* docs: meta sync

* docs: team-auth

* docs: views

* docs: fix URL

* docs: URL corrections

* fix:  shared base, view related bugs

Signed-off-by: Pranav C <pranavxc@gmail.com>

* test: EE check for WSaccess

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* test: exclude EE tests

Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>

* fix: missing project delete

closes #6215

Signed-off-by: Pranav C <pranavxc@gmail.com>

* fix: merge existing project meta  if found

closes #6216

Signed-off-by: Pranav C <pranavxc@gmail.com>

* fix: merge existing project meta  if found

closes #6216

Signed-off-by: Pranav C <pranavxc@gmail.com>

---------

Signed-off-by: Pranav C <pranavxc@gmail.com>
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
Co-authored-by: Raju Udava <86527202+dstala@users.noreply.github.com>
Co-authored-by: DarkPhoenix2704 <anbarasun123@gmail.com>
Co-authored-by: Wing-Kam Wong <wingkwong.code@gmail.com>

* refactor: docs and other bug fixes

Signed-off-by: Pranav C <pranavxc@gmail.com>

* feat: populate default project on super admin signup

Signed-off-by: Pranav C <pranavxc@gmail.com>

* fix: include created project details in signup response if avail, missing Dockerfile

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: use custom function for resolving ts path aliases

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: add missing generate script

Signed-off-by: Pranav C <pranavxc@gmail.com>

* chore: webpack build correction - ts path resolve

Signed-off-by: Pranav C <pranavxc@gmail.com>

---------

Signed-off-by: Pranav C <pranavxc@gmail.com>
Signed-off-by: Raju Udava <86527202+dstala@users.noreply.github.com>
Co-authored-by: mertmit <mertmit99@gmail.com>
Co-authored-by: Raju Udava <86527202+dstala@users.noreply.github.com>
Co-authored-by: DarkPhoenix2704 <anbarasun123@gmail.com>
Co-authored-by: Wing-Kam Wong <wingkwong.code@gmail.com>
2023-08-24 02:58:19 +05:30

5.4 KiB

title, description, hide_table_of_contents
title description hide_table_of_contents
Environment Variables Environment Variables for NocoDB! true

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. 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 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
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 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)
NC_DISABLE_AUDIT Disable Audit Log false
NC_AUTOMATION_LOG_LEVEL Possible Values: OFF, ERROR, ALL. See Webhooks for details. OFF