diff --git a/.env.example b/.env.example index 6a26d31932..60fd4e3152 100644 --- a/.env.example +++ b/.env.example @@ -1,10 +1,14 @@ # Create .env from this example file and replace values for the environment. # The application expects a separate .env.test for test environment configuration +# Get detailed information about each variable here: https://docs.tooljet.com/docs/deployment/env-vars TOOLJET_HOST=http://localhost:8082 LOCKBOX_MASTER_KEY=0000000000000000000000000000000000000000000000000000000000000000 SECRET_KEY_BASE=replace_with_secret_key_base +## Configure a hostname for the server +SERVER_HOST= + # DATABASE CONFIG ORM_LOGGING= PG_DB= @@ -12,8 +16,8 @@ PG_USER= PG_HOST= PG_PASS= -# Checks every 24 hours to see if a new version of ToolJet is available -CHECK_FOR_UPDATES=check_if_updates_are_available +# Checks every 24 hours to see if a new version of ToolJet is available (Enabled by default. Set 0 to disable) +CHECK_FOR_UPDATES=0 GOOGLE_CLIENT_ID= GOOGLE_CLIENT_SECRET= diff --git a/docs/docs/data-sources/google.sheets.md b/docs/docs/data-sources/google.sheets.md index 43576bc84f..8ad0f2aaf2 100644 --- a/docs/docs/data-sources/google.sheets.md +++ b/docs/docs/data-sources/google.sheets.md @@ -22,13 +22,13 @@ You can create a Google Sheets datasource with one of either of the two permissi Using Google sheets data source you can perfom several operations from your applications like: - 1. **[Read data from a spreadsheet](/docs/data-sources/google.sheets#read-data-from-a-spreadsheet)** - 2. **[Append data from a spreadsheet](/docs/data-sources/google.sheets#append-data-from-a-spreadsheet)** - 3. **[Update data from a spreadsheet](/docs/data-sources/google.sheets#update-data-from-a-spreadsheet)** - 4. **[Delete row from a spreadsheet](/docs/data-sources/google.sheets#delete-data-from-a-spreadsheet)** + 1. **[Read data from a sheet](/docs/data-sources/google.sheets#read-data-from-a-sheet)** + 2. **[Append data to a sheet](/docs/data-sources/google.sheets#append-data-to-a-sheet)** + 3. **[Update single row of a sheet](/docs/data-sources/google.sheets#update-single-row-of-a-sheet)** + 4. **[Delete row from a sheet](/docs/data-sources/google.sheets#delete-row-from-a-sheet)** 5. **[Get spreadsheet info](/docs/data-sources/google.sheets#get-spreadsheet-info)** -### Read data from a spreadsheet +### Read data from a sheet This operation returns the table data from the spreadsheet in the form of json object. @@ -45,7 +45,7 @@ This operation returns the table data from the spreadsheet in the form of json o -### Append data from a spreadsheet +### Append data to a sheet You can add more rows to the table using the append operation. @@ -61,7 +61,7 @@ You can add more rows to the table using the append operation. -### Update data from a spreadsheet +### Update single row of a sheet You can update the existing data in sheet using this operation. @@ -79,7 +79,7 @@ You can update the existing data in sheet using this operation. -### Delete data from a spreadsheet +### Delete row from a sheet Use this operation delete a specific row from the sheet. diff --git a/docs/docs/deployment/env-vars.md b/docs/docs/deployment/env-vars.md index 4fddf636c3..7ad9532f90 100644 --- a/docs/docs/deployment/env-vars.md +++ b/docs/docs/deployment/env-vars.md @@ -14,6 +14,21 @@ Both the ToolJet server and client requires some environment variables to start | ------------ | --------------------------------------------------------------- | | TOOLJET_HOST | the public URL of ToolJet client ( eg: https://app.tooljet.com ) | +#### Lockbox configuration ( required ) + +ToolJet server uses lockbox to encrypt datasource credentials. You should set the environment variable `LOCKBOX_MASTER_KEY` with a 32 byte hexadecimal string. + +#### Application Secret ( required ) + +ToolJet server uses a secure 64 byte hexadecimal string to encrypt session cookies. You should set the environment variable `SECRET_KEY_BASE`. + +:::tip +If you have `openssl` installed, you can run the following commands to generate the value for `LOCKBOX_MASTER_KEY` and `SECRET_KEY_BASE`. + +For `LOCKBOX_MASTER_KEY` use `openssl rand -hex 32` +For `SECRET_KEY_BASE` use `openssl rand -hex 64` +::: + #### Database configuration ( required ) ToolJet server uses PostgreSQL as the database. @@ -25,20 +40,25 @@ ToolJet server uses PostgreSQL as the database. | PG_USER | username | | PG_PASS | password | -#### Lockbox configuration ( required ) +#### Check for updates ( optional ) -ToolJet server uses lockbox to encrypt datasource credentials. You should set the environment variable `LOCKBOX_MASTER_KEY` with a 32 byte hexadecimal string. +Self-hosted version of ToolJet pings our server to fetch the latest product updates every 24 hours. You can disable this by setting the value of `CHECK_FOR_UPDATES` environment variable to `0`. This feature is enabled by default. -#### Application Secret ( required ) +#### Comment feature enable ( optional ) -ToolJet server uses a secure 64 byte hexadecimal string to encrypt session cookies. You should set the environment variable `SECRET_KEY_BASE`. +Use this environment variable to enable/disable the feature that allows you to add comments on the canvas. -:::tip -If you have `openssl` installed, you can run the following commands to generate the value for `LOCKBOX_MASTER_KEY` and `SECRET_KEY_BASE`. +| variable | value | +| -------- | ---------------------- | +| COMMENT_FEATURE_ENABLE | `true` or `false` | -For `LOCKBOX_MASTER_KEY` use `openssl rand -hex 32` -For `SECRET_KEY_BASE` use `openssl rand -hex 64` -::: +#### Server Host ( optional ) + +You can specify a different server for backend if it is hosted on another server. + +| variable | value | +| -------- | ---------------------- | +| SERVER_HOST | Configure a hostname for the server as a proxy pass. If no value is set, it defaults to `server`. | #### Disabling signups ( optional ) @@ -105,16 +125,27 @@ Specify application monitoring vendor. Currently supported values - `sentry`. | variable | description | | ---------- | ----------------------------------------- | -| APM VENDOR | Application performance monitoring vendor | +| APM_VENDOR | Application performance monitoring vendor | #### SENTRY DNS ( optional ) -DSN tells a Sentry SDK where to send events so the events are associated with the correct project +| variable | description | +| ---------- | ----------------------------------------- | +| SENTRY_DNS | DSN tells a Sentry SDK where to send events so the events are associated with the correct project | #### SENTRY DEBUG ( optional ) -Prints logs for sentry. Supported values: `true` | `false` -Default value is `false` +Prints logs for sentry. + +| variable | description | +| ---------- | ----------------------------------------- | +| SENTRY_DEBUG | `true` or `false`. Default value is `false` | + +#### SSO ( optional ) + +:::info +We currently support GitHub and Google SSO. Check out docs for **[GitHub SSO](/docs/sso/github)** and **[Google SSO](/docs/sso/google)** for more information on respective environment variables. +::: #### Server URL ( optional)