From 61e8c1b8ca28f4af833ad37d88ca24929fdd25e5 Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Thu, 14 Dec 2023 21:09:08 +0530
Subject: [PATCH 01/11] feat: environment variables reference
---
.github/styles/Vocab/technical/accept.txt | 2 +
.../setup/environment-variables.md | 228 ++++++++++++++++++
website/sidebars.js | 1 +
3 files changed, 231 insertions(+)
create mode 100644 website/docs/getting-started/setup/environment-variables.md
diff --git a/.github/styles/Vocab/technical/accept.txt b/.github/styles/Vocab/technical/accept.txt
index 493c4300ad..d00902b209 100644
--- a/.github/styles/Vocab/technical/accept.txt
+++ b/.github/styles/Vocab/technical/accept.txt
@@ -15,3 +15,5 @@ Okta
Ping Identity
application
Application
+OAuth 2
+Domain
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
new file mode 100644
index 0000000000..2101e43829
--- /dev/null
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -0,0 +1,228 @@
+---
+description: Guide on configuring environment variables for Appsmith developers and DevOps engineers.
+toc_min_heading_level: 2
+toc_max_heading_level: 2
+---
+
+# Environment Variables
+
+Environment variables play a crucial role in configuring different aspects of your Appsmith instance, such as authentication, defining logging levels, customizing email settings, and more. This page provides a detailed description of each environment variable along with its purpose and usage.
+
+## OAuth 2.0
+
+The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google or GitHub credentials.
+
+#### `APPSMITH__OAUTH2_GOOGLE_CLIENT_ID`
+
+
+ This variable stores the Client ID provided by Google during OAuth 2.0 configuration. It is unique to your application, identifying you during the authentication process with Google's servers. Set this variable to the Google OAuth 2.0 Client ID available in your Google Cloud Platform console under the credentials section for your project.
+
+
+#### `APPSMITH__OAUTH2_GOOGLE_CLIENT_SECRET`
+
+
+ This variable holds the Client Secret provided by Google for OAuth 2.0. The secret is confidential and used in server-to-server communications. Assign this variable with the Google OAuth 2.0 Client Secret obtained from the Google Cloud Platform console where you configured your OAuth credentials.
+
+
+#### `APPSMITH__OAUTH2_GITHUB_CLIENT_ID`
+
+
+ This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Obtain your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and set it as the variable's value.
+
+
+
+#### `APPSMITH__OAUTH2_GITHUB_CLIENT_SECRET`
+
+
+ This variable, in conjunction with the Client ID, holds the secret key provided by GitHub OAuth 2.0 to authenticate your application's requests securely. Set this variable with the Client Secret provided by GitHub upon creating your OAuth application. Ensure that you store it securely and do not expose it publicly.
+
+
+## Client logging
+
+Appsmith provides a way to enhance the log levels of your applications, aiding in monitoring client-side operations and troubleshooting issues. The following environment variable helps define the verbosity level of the logs that Appsmith will generate for client-side activities.
+
+#### `APPSMITH__CLIENT_LOG_LEVEL`
+
+
+This variable determines the level of detail that your client-side logs will capture. Ordered by their severity logging levels can also be adjusted based on the needs of your environment. The available levels are:
+
+* `debug`: Provides informational logs useful for debugging. Set the level to `0` to turn on the `debug` log level.
+* `error`: Logs error events that might signify a problem and warrant investigation. Set the level to `1` to turn on the `error` log level.
+
+
+
+## Email
+
+Configure your email server in Appsmith to handle application emailing needs. The following environment variables enable you to set up and manage these email-related capabilities for your Appsmith instance.
+
+#### `APPSMITH__EMAIL_ENABLED`
+
+
+
+Controls whether Appsmith can send emails. Use `true` to enable email capabilities or `false` to disable it.
+
+
+
+#### `APPSMITH__EMAIL_SERVER_HOST`
+
+
+
+Specifies the host address of the email server that Appsmith will use to send emails. This is part of the SMTP server configuration necessary for email delivery. Set this variable to the fully qualified domain name or IP address of your email server.
+
+
+
+#### `APPSMITH__EMAIL_SERVER_PORT`
+
+
+
+Indicates the port number on which the email server is listening. Different services use different ports; for example, port 25 for non-encrypted transport, 587 for submission with StartTLS, and 465 for SMTPS (deprecated). Select the appropriate port that corresponds to your email server's setup and protocols.
+
+
+
+#### `APPSMITH__EMAIL_SERVER_USERNAME`
+
+
+
+Used to authenticate with the email server and allows logging into your SMTP server. Provide the username configured at your email server for sending emails.
+
+
+
+#### `APPSMITH__EMAIL_SERVER_PASSWORD`
+
+
+
+The password corresponding to the username for the SMTP server. You must protect the secret as it grants access to your email sending capabilities. Enter the password associated with your `APPSMITH_EMAIL_SERVER_USERNAME` to authenticate with the email server.
+
+
+#### `APPSMITH__EMAIL_FROM_ADDRESS`
+
+
+
+This is the email address displayed in the **From** field of the emails sent through Appsmith, essentially representing who the email is from. Set this to a valid email address that recipients of your emails can recognize and associate with.
+
+
+#### `APPSMITH__EMAIL_REPLY_TO_ADDRESS`
+
+
+
+The **ReplyTo** address is the email displayed in the response field of Appsmith emails, indicating where replies will be sent. Set this to a valid email address that recipients can recognize and associate with the response destination.
+
+
+
+
+
+#### `APPSMITH__SMTP_AUTH_ENABLED`
+
+
+Defines to use SMTP authentication when sending emails. Set it to `true` to authenticate your emails by the server, reducing the likelihood of them being marked as spam.
+
+
+#### `APPSMITH__TLS_ENABLED`
+
+
+
+Determines whether the email server connection uses Transport Layer Security (TLS) for enhanced security, protecting email contents and credentials. Set to `true` to enable TLS.
+
+
+
+
+## Telemetry
+
+Monitoring the performance of your Appsmith instance is crucial for making informed decisions about feature improvements and resource allocation.
+
+#### `APPSMITH__TELEMETRY_ENABLED`
+
+
+
+Controls whether Appsmith sends telemetry data to its servers. You may choose to turn off the setting if it conflicts with your privacy policies or preferences. Set to `true` to allow Appsmith to collect anonymous telemetry data or `false` to opt-out.
+
+
+
+## Security
+Ensure the safety of your applications and data by configuring security settings, including reCAPTCHA, to safeguard your instance against automated threats. Use the environment variables below to manage these settings:
+
+#### `APPSMITH__RECAPTCHA_ENABLED`
+
+
+
+Enables Google reCAPTCHA verification on your Appsmith instance by embedding a reCAPTCHA in the login page, offering protection against spam and abuse by automated bots. Configure this to true after setting up reCAPTCHA with your domain to activate this feature.
+
+
+
+#### `APPSMITH__RECAPTCHA_SITE_KEY`
+
+
+Public key provided by Google reCAPTCHA for integrating the service into your web application. Set this variable with the site key you received after registering your Appsmith instance as a site under Google reCAPTCHA.
+
+
+
+#### `APPSMITH__RECAPTCHA_SECRET_KEY`
+
+
+Secret key provided by Google reCAPTCHA that Google uses to verify the user input during a communication between your server and the reCAPTCHA server. The secret is confidential and used in server-side code. Set this variable with the secret key provided by reCAPTCHA.
+
+
+
+## Database and session management
+
+Appsmith can connect to external providers for MongoDB and Redis. The associated environment variables ensure that Appsmith establishes a connection to external hosting rather than using the embedded MongoDB or Redis servers.
+
+#### `APPSMITH__MONGODB_URI`
+
+
+ Appsmith uses this variable to connect to an external MongoDB instance. Set it to the full MongoDB URI supplied by the hosting service. This enables Appsmith to store data in your MongoDB database, ensuring control and ownership of the application data.
+
+
+#### `APPSMITH__REDIS_URL`
+
+
+ Appsmith uses this variable to establish a link to an external Redis server, which Appsmith uses for session handling and caching operations. This connection string typically includes the Redis host, port number, and optionally, authentication credentials.
+
+
+#### `APPSMITH__ENCRYPTION_PASSWORD`
+
+
+ The encryption password is critical for safeguarding your datasource credentials through encryption. Select a strong password that exhibits a good level of entropy to prevent easy decryption.
+
+
+#### `APPSMITH__ENCRYPTION_SALT`
+
+
+ The encryption salt contributes to the security strategy by adding a layer of complexity during the encryption process. This long, unique string enhances encryption strength, making it more resistant to attacks such as brute force attempts.
+
+
+## Custom Domain
+
+If you prefer to host your Appsmith instance on a personalized domain, you can do so by setting up a custom domain. Appsmith also provisions an SSL certificate through Let’s Encrypt, securing your application with HTTPS.
+
+#### `APPSMITH__CUSTOM_DOMAIN`
+
+
+ Set this variable with your custom domain to access Appsmith.
+
+
+## Signup and login
+
+With Appsmith, you have the ability to manage user access and authentication methods in your instance. This helps streamline logins and control who can create accounts on the platform.
+
+#### `APPSMITH__FORM_LOGIN_DISABLED`
+
+
+
+Set to `true` to turn off the default username and password login. Useful for administrators who want to enforce Single Sign-On (SSO) or limit authentication methods for added security and control.
+
+
+#### `APPSMITH__SIGNUP_DISABLED`
+
+
+
+Set to `true` to stop new user account creation. Useful when you want to restrict access to your Appsmith instance, allowing only users who have been specifically invited to join.
+
+
+## Server timeout
+
+Adjust the internal server timeout to optimize performance based on your Appsmith instance's load and expected response times.
+
+#### `APPSMITH__SERVER_TIMEOUT`
+
+Specifies the internal Appsmith server timeout in seconds. Defaults to a `60` seconds timeout. Increase or decrease based on your server's load and expected response times.
diff --git a/website/sidebars.js b/website/sidebars.js
index c368611991..19ab440ca9 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -214,6 +214,7 @@ const sidebars = {
],
},
`getting-started/setup/best-practices`,
+ 'getting-started/setup/environment-variables',
'getting-started/setup/deployment-architecture',
],
}
From 6a8255fb308feae4ca0e68a5a16334885801653c Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Thu, 14 Dec 2023 21:12:26 +0530
Subject: [PATCH 02/11] minor updates
---
.../setup/environment-variables.md | 17 ++++++++++-------
1 file changed, 10 insertions(+), 7 deletions(-)
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 2101e43829..2fb17653da 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -27,7 +27,7 @@ The following environment variables assist in configuring OAuth 2.0 authenticati
#### `APPSMITH__OAUTH2_GITHUB_CLIENT_ID`
- This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Obtain your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and set it as the variable's value.
+ This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Obtain your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and setting it as the variable's value.
@@ -91,7 +91,7 @@ Used to authenticate with the email server and allows logging into your SMTP ser
-The password corresponding to the username for the SMTP server. You must protect the secret as it grants access to your email sending capabilities. Enter the password associated with your `APPSMITH_EMAIL_SERVER_USERNAME` to authenticate with the email server.
+The password corresponds to the username for the SMTP server. You must protect the secret as it grants access to your email-sending capabilities. Enter the password associated with your `APPSMITH_EMAIL_SERVER_USERNAME` to authenticate with the email server.
#### `APPSMITH__EMAIL_FROM_ADDRESS`
@@ -114,7 +114,7 @@ The **ReplyTo** address is the email displayed in the response field of Appsmith
#### `APPSMITH__SMTP_AUTH_ENABLED`
-Defines to use SMTP authentication when sending emails. Set it to `true` to authenticate your emails by the server, reducing the likelihood of them being marked as spam.
+Defines to use of SMTP authentication when sending emails. Set it to `true` to authenticate your emails by the server, reducing the likelihood of them being marked as spam.
#### `APPSMITH__TLS_ENABLED`
@@ -159,7 +159,7 @@ Public key provided by Google reCAPTCHA for integrating the service into your we
#### `APPSMITH__RECAPTCHA_SECRET_KEY`
-Secret key provided by Google reCAPTCHA that Google uses to verify the user input during a communication between your server and the reCAPTCHA server. The secret is confidential and used in server-side code. Set this variable with the secret key provided by reCAPTCHA.
+The secret key provided by Google reCAPTCHA that Google uses to verify the user input during communication between your server and the reCAPTCHA server. The secret is confidential and used in server-side code. Set this variable with the secret key provided by reCAPTCHA.
@@ -188,7 +188,7 @@ Appsmith can connect to external providers for MongoDB and Redis. The associated
#### `APPSMITH__ENCRYPTION_SALT`
- The encryption salt contributes to the security strategy by adding a layer of complexity during the encryption process. This long, unique string enhances encryption strength, making it more resistant to attacks such as brute force attempts.
+ The encryption salt contributes to the security strategy by adding a layer of complexity during the encryption process. This long, unique string enhances encryption strength, making it more resistant to attacks such as brute-force attempts.
## Custom Domain
@@ -203,7 +203,7 @@ If you prefer to host your Appsmith instance on a personalized domain, you can d
## Signup and login
-With Appsmith, you have the ability to manage user access and authentication methods in your instance. This helps streamline logins and control who can create accounts on the platform.
+With Appsmith, you can manage user access and authentication methods in your instance. This helps streamline logins and control who can create accounts on the platform.
#### `APPSMITH__FORM_LOGIN_DISABLED`
@@ -225,4 +225,7 @@ Adjust the internal server timeout to optimize performance based on your Appsmit
#### `APPSMITH__SERVER_TIMEOUT`
-Specifies the internal Appsmith server timeout in seconds. Defaults to a `60` seconds timeout. Increase or decrease based on your server's load and expected response times.
+
+
+Specifies the internal Appsmith server timeout in seconds. Defaults to a `60` second timeout. Increase or decrease based on your server's load and expected response times.
+
From dc10a5fdd27b106d84ee51573b3ae0da2f1f297d Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Thu, 14 Dec 2023 21:16:51 +0530
Subject: [PATCH 03/11] minor change
---
website/sidebars.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/website/sidebars.js b/website/sidebars.js
index 19ab440ca9..71cf6b6fd6 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -213,8 +213,8 @@ const sidebars = {
},
],
},
- `getting-started/setup/best-practices`,
'getting-started/setup/environment-variables',
+ `getting-started/setup/best-practices`,
'getting-started/setup/deployment-architecture',
],
}
From 78cd664d41678350a294b5c475c952541a92884c Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Thu, 14 Dec 2023 21:25:49 +0530
Subject: [PATCH 04/11] minor updates
---
website/docs/getting-started/setup/environment-variables.md | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 2fb17653da..3d2018871c 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -10,12 +10,12 @@ Environment variables play a crucial role in configuring different aspects of yo
## OAuth 2.0
-The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google or GitHub credentials.
+The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with your existing Google or GitHub credentials.
#### `APPSMITH__OAUTH2_GOOGLE_CLIENT_ID`
- This variable stores the Client ID provided by Google during OAuth 2.0 configuration. It is unique to your application, identifying you during the authentication process with Google's servers. Set this variable to the Google OAuth 2.0 Client ID available in your Google Cloud Platform console under the credentials section for your project.
+ This variable stores the Client ID provided by Google during OAuth 2.0 configuration. It's unique to your application, identifying you during the authentication process with Google's servers. Set this variable to the Google OAuth 2.0 Client ID available in your Google Cloud Platform console under the credentials section for your project.
#### `APPSMITH__OAUTH2_GOOGLE_CLIENT_SECRET`
@@ -27,7 +27,7 @@ The following environment variables assist in configuring OAuth 2.0 authenticati
#### `APPSMITH__OAUTH2_GITHUB_CLIENT_ID`
- This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Obtain your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and setting it as the variable's value.
+ This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Get your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and setting it as the variable's value.
From 1a46531ebb39785d44f970f9ece85db521e66c15 Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Thu, 14 Dec 2023 21:26:22 +0530
Subject: [PATCH 05/11] minor update
---
website/docs/getting-started/setup/environment-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 3d2018871c..4a162ea624 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -10,7 +10,7 @@ Environment variables play a crucial role in configuring different aspects of yo
## OAuth 2.0
-The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with your existing Google or GitHub credentials.
+The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google or GitHub credentials.
#### `APPSMITH__OAUTH2_GOOGLE_CLIENT_ID`
From 520997b5cb9344939520c93a48a9663ccd5b71e7 Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Fri, 15 Dec 2023 09:57:22 +0530
Subject: [PATCH 06/11] updates based on comments
---
.../setup/environment-variables.md | 52 +++++++++----------
1 file changed, 26 insertions(+), 26 deletions(-)
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 4a162ea624..7536744c78 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -12,26 +12,26 @@ Environment variables play a crucial role in configuring different aspects of yo
The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google or GitHub credentials.
-#### `APPSMITH__OAUTH2_GOOGLE_CLIENT_ID`
+### `APPSMITH_OAUTH2_GOOGLE_CLIENT_ID`
This variable stores the Client ID provided by Google during OAuth 2.0 configuration. It's unique to your application, identifying you during the authentication process with Google's servers. Set this variable to the Google OAuth 2.0 Client ID available in your Google Cloud Platform console under the credentials section for your project.
-#### `APPSMITH__OAUTH2_GOOGLE_CLIENT_SECRET`
+### `APPSMITH_OAUTH2_GOOGLE_CLIENT_SECRET`
This variable holds the Client Secret provided by Google for OAuth 2.0. The secret is confidential and used in server-to-server communications. Assign this variable with the Google OAuth 2.0 Client Secret obtained from the Google Cloud Platform console where you configured your OAuth credentials.
-#### `APPSMITH__OAUTH2_GITHUB_CLIENT_ID`
+### `APPSMITH_OAUTH2_GITHUB_CLIENT_ID`
This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Get your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and setting it as the variable's value.
-#### `APPSMITH__OAUTH2_GITHUB_CLIENT_SECRET`
+### `APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET`
This variable, in conjunction with the Client ID, holds the secret key provided by GitHub OAuth 2.0 to authenticate your application's requests securely. Set this variable with the Client Secret provided by GitHub upon creating your OAuth application. Ensure that you store it securely and do not expose it publicly.
@@ -41,7 +41,7 @@ The following environment variables assist in configuring OAuth 2.0 authenticati
Appsmith provides a way to enhance the log levels of your applications, aiding in monitoring client-side operations and troubleshooting issues. The following environment variable helps define the verbosity level of the logs that Appsmith will generate for client-side activities.
-#### `APPSMITH__CLIENT_LOG_LEVEL`
+### `APPSMITH_CLIENT_LOG_LEVEL`
This variable determines the level of detail that your client-side logs will capture. Ordered by their severity logging levels can also be adjusted based on the needs of your environment. The available levels are:
@@ -55,7 +55,7 @@ This variable determines the level of detail that your client-side logs will cap
Configure your email server in Appsmith to handle application emailing needs. The following environment variables enable you to set up and manage these email-related capabilities for your Appsmith instance.
-#### `APPSMITH__EMAIL_ENABLED`
+### `APPSMITH_EMAIL_ENABLED`
@@ -63,7 +63,7 @@ Controls whether Appsmith can send emails. Use `true` to enable email capabiliti
-#### `APPSMITH__EMAIL_SERVER_HOST`
+### `APPSMITH_EMAIL_SERVER_HOST`
@@ -71,7 +71,7 @@ Specifies the host address of the email server that Appsmith will use to send em
-#### `APPSMITH__EMAIL_SERVER_PORT`
+### `APPSMITH_EMAIL_SERVER_PORT`
@@ -79,7 +79,7 @@ Indicates the port number on which the email server is listening. Different serv
-#### `APPSMITH__EMAIL_SERVER_USERNAME`
+### `APPSMITH_EMAIL_SERVER_USERNAME`
@@ -87,21 +87,21 @@ Used to authenticate with the email server and allows logging into your SMTP ser
-#### `APPSMITH__EMAIL_SERVER_PASSWORD`
+### `APPSMITH_EMAIL_SERVER_PASSWORD`
The password corresponds to the username for the SMTP server. You must protect the secret as it grants access to your email-sending capabilities. Enter the password associated with your `APPSMITH_EMAIL_SERVER_USERNAME` to authenticate with the email server.
-#### `APPSMITH__EMAIL_FROM_ADDRESS`
+### `APPSMITH_EMAIL_FROM_ADDRESS`
This is the email address displayed in the **From** field of the emails sent through Appsmith, essentially representing who the email is from. Set this to a valid email address that recipients of your emails can recognize and associate with.
-#### `APPSMITH__EMAIL_REPLY_TO_ADDRESS`
+### `APPSMITH_EMAIL_REPLY_TO_ADDRESS`
@@ -111,13 +111,13 @@ The **ReplyTo** address is the email displayed in the response field of Appsmith
-#### `APPSMITH__SMTP_AUTH_ENABLED`
+### `APPSMITH_SMTP_AUTH_ENABLED`
Defines to use of SMTP authentication when sending emails. Set it to `true` to authenticate your emails by the server, reducing the likelihood of them being marked as spam.
-#### `APPSMITH__TLS_ENABLED`
+### `APPSMITH_TLS_ENABLED`
@@ -130,7 +130,7 @@ Determines whether the email server connection uses Transport Layer Security (TL
Monitoring the performance of your Appsmith instance is crucial for making informed decisions about feature improvements and resource allocation.
-#### `APPSMITH__TELEMETRY_ENABLED`
+### `APPSMITH_TELEMETRY_ENABLED`
@@ -141,7 +141,7 @@ Controls whether Appsmith sends telemetry data to its servers. You may choose to
## Security
Ensure the safety of your applications and data by configuring security settings, including reCAPTCHA, to safeguard your instance against automated threats. Use the environment variables below to manage these settings:
-#### `APPSMITH__RECAPTCHA_ENABLED`
+### `APPSMITH_RECAPTCHA_ENABLED`
@@ -149,14 +149,14 @@ Enables Google reCAPTCHA verification on your Appsmith instance by embedding a r
-#### `APPSMITH__RECAPTCHA_SITE_KEY`
+### `APPSMITH_RECAPTCHA_SITE_KEY`
Public key provided by Google reCAPTCHA for integrating the service into your web application. Set this variable with the site key you received after registering your Appsmith instance as a site under Google reCAPTCHA.
-#### `APPSMITH__RECAPTCHA_SECRET_KEY`
+### `APPSMITH_RECAPTCHA_SECRET_KEY`
The secret key provided by Google reCAPTCHA that Google uses to verify the user input during communication between your server and the reCAPTCHA server. The secret is confidential and used in server-side code. Set this variable with the secret key provided by reCAPTCHA.
@@ -167,25 +167,25 @@ The secret key provided by Google reCAPTCHA that Google uses to verify the user
Appsmith can connect to external providers for MongoDB and Redis. The associated environment variables ensure that Appsmith establishes a connection to external hosting rather than using the embedded MongoDB or Redis servers.
-#### `APPSMITH__MONGODB_URI`
+### `APPSMITH_MONGODB_URI`
Appsmith uses this variable to connect to an external MongoDB instance. Set it to the full MongoDB URI supplied by the hosting service. This enables Appsmith to store data in your MongoDB database, ensuring control and ownership of the application data.
-#### `APPSMITH__REDIS_URL`
+### `APPSMITH_REDIS_URL`
Appsmith uses this variable to establish a link to an external Redis server, which Appsmith uses for session handling and caching operations. This connection string typically includes the Redis host, port number, and optionally, authentication credentials.
-#### `APPSMITH__ENCRYPTION_PASSWORD`
+### `APPSMITH_ENCRYPTION_PASSWORD`
The encryption password is critical for safeguarding your datasource credentials through encryption. Select a strong password that exhibits a good level of entropy to prevent easy decryption.
-#### `APPSMITH__ENCRYPTION_SALT`
+### `APPSMITH_ENCRYPTION_SALT`
The encryption salt contributes to the security strategy by adding a layer of complexity during the encryption process. This long, unique string enhances encryption strength, making it more resistant to attacks such as brute-force attempts.
@@ -195,7 +195,7 @@ Appsmith can connect to external providers for MongoDB and Redis. The associated
If you prefer to host your Appsmith instance on a personalized domain, you can do so by setting up a custom domain. Appsmith also provisions an SSL certificate through Let’s Encrypt, securing your application with HTTPS.
-#### `APPSMITH__CUSTOM_DOMAIN`
+### `APPSMITH_CUSTOM_DOMAIN`
Set this variable with your custom domain to access Appsmith.
@@ -205,14 +205,14 @@ If you prefer to host your Appsmith instance on a personalized domain, you can d
With Appsmith, you can manage user access and authentication methods in your instance. This helps streamline logins and control who can create accounts on the platform.
-#### `APPSMITH__FORM_LOGIN_DISABLED`
+### `APPSMITH_FORM_LOGIN_DISABLED`
Set to `true` to turn off the default username and password login. Useful for administrators who want to enforce Single Sign-On (SSO) or limit authentication methods for added security and control.
-#### `APPSMITH__SIGNUP_DISABLED`
+### `APPSMITH_SIGNUP_DISABLED`
@@ -223,7 +223,7 @@ Set to `true` to stop new user account creation. Useful when you want to restric
Adjust the internal server timeout to optimize performance based on your Appsmith instance's load and expected response times.
-#### `APPSMITH__SERVER_TIMEOUT`
+### `APPSMITH_SERVER_TIMEOUT`
From b52a57ff8fbf55f29af2dff95643440b578a8efc Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Fri, 15 Dec 2023 10:00:43 +0530
Subject: [PATCH 07/11] updates to heading level
---
.../setup/environment-variables.md | 52 +++++++++----------
1 file changed, 26 insertions(+), 26 deletions(-)
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 7536744c78..0f6ae92089 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -12,26 +12,26 @@ Environment variables play a crucial role in configuring different aspects of yo
The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google or GitHub credentials.
-### `APPSMITH_OAUTH2_GOOGLE_CLIENT_ID`
+#### `APPSMITH_OAUTH2_GOOGLE_CLIENT_ID`
This variable stores the Client ID provided by Google during OAuth 2.0 configuration. It's unique to your application, identifying you during the authentication process with Google's servers. Set this variable to the Google OAuth 2.0 Client ID available in your Google Cloud Platform console under the credentials section for your project.
-### `APPSMITH_OAUTH2_GOOGLE_CLIENT_SECRET`
+#### `APPSMITH_OAUTH2_GOOGLE_CLIENT_SECRET`
This variable holds the Client Secret provided by Google for OAuth 2.0. The secret is confidential and used in server-to-server communications. Assign this variable with the Google OAuth 2.0 Client Secret obtained from the Google Cloud Platform console where you configured your OAuth credentials.
-### `APPSMITH_OAUTH2_GITHUB_CLIENT_ID`
+#### `APPSMITH_OAUTH2_GITHUB_CLIENT_ID`
This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Get your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and setting it as the variable's value.
-### `APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET`
+#### `APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET`
This variable, in conjunction with the Client ID, holds the secret key provided by GitHub OAuth 2.0 to authenticate your application's requests securely. Set this variable with the Client Secret provided by GitHub upon creating your OAuth application. Ensure that you store it securely and do not expose it publicly.
@@ -41,7 +41,7 @@ The following environment variables assist in configuring OAuth 2.0 authenticati
Appsmith provides a way to enhance the log levels of your applications, aiding in monitoring client-side operations and troubleshooting issues. The following environment variable helps define the verbosity level of the logs that Appsmith will generate for client-side activities.
-### `APPSMITH_CLIENT_LOG_LEVEL`
+#### `APPSMITH_CLIENT_LOG_LEVEL`
This variable determines the level of detail that your client-side logs will capture. Ordered by their severity logging levels can also be adjusted based on the needs of your environment. The available levels are:
@@ -55,7 +55,7 @@ This variable determines the level of detail that your client-side logs will cap
Configure your email server in Appsmith to handle application emailing needs. The following environment variables enable you to set up and manage these email-related capabilities for your Appsmith instance.
-### `APPSMITH_EMAIL_ENABLED`
+#### `APPSMITH_EMAIL_ENABLED`
@@ -63,7 +63,7 @@ Controls whether Appsmith can send emails. Use `true` to enable email capabiliti
-### `APPSMITH_EMAIL_SERVER_HOST`
+#### `APPSMITH_EMAIL_SERVER_HOST`
@@ -71,7 +71,7 @@ Specifies the host address of the email server that Appsmith will use to send em
-### `APPSMITH_EMAIL_SERVER_PORT`
+#### `APPSMITH_EMAIL_SERVER_PORT`
@@ -79,7 +79,7 @@ Indicates the port number on which the email server is listening. Different serv
-### `APPSMITH_EMAIL_SERVER_USERNAME`
+#### `APPSMITH_EMAIL_SERVER_USERNAME`
@@ -87,21 +87,21 @@ Used to authenticate with the email server and allows logging into your SMTP ser
-### `APPSMITH_EMAIL_SERVER_PASSWORD`
+#### `APPSMITH_EMAIL_SERVER_PASSWORD`
The password corresponds to the username for the SMTP server. You must protect the secret as it grants access to your email-sending capabilities. Enter the password associated with your `APPSMITH_EMAIL_SERVER_USERNAME` to authenticate with the email server.
-### `APPSMITH_EMAIL_FROM_ADDRESS`
+#### `APPSMITH_EMAIL_FROM_ADDRESS`
This is the email address displayed in the **From** field of the emails sent through Appsmith, essentially representing who the email is from. Set this to a valid email address that recipients of your emails can recognize and associate with.
-### `APPSMITH_EMAIL_REPLY_TO_ADDRESS`
+#### `APPSMITH_EMAIL_REPLY_TO_ADDRESS`
@@ -111,13 +111,13 @@ The **ReplyTo** address is the email displayed in the response field of Appsmith
-### `APPSMITH_SMTP_AUTH_ENABLED`
+#### `APPSMITH_SMTP_AUTH_ENABLED`
Defines to use of SMTP authentication when sending emails. Set it to `true` to authenticate your emails by the server, reducing the likelihood of them being marked as spam.
-### `APPSMITH_TLS_ENABLED`
+#### `APPSMITH_TLS_ENABLED`
@@ -130,7 +130,7 @@ Determines whether the email server connection uses Transport Layer Security (TL
Monitoring the performance of your Appsmith instance is crucial for making informed decisions about feature improvements and resource allocation.
-### `APPSMITH_TELEMETRY_ENABLED`
+#### `APPSMITH_TELEMETRY_ENABLED`
@@ -141,7 +141,7 @@ Controls whether Appsmith sends telemetry data to its servers. You may choose to
## Security
Ensure the safety of your applications and data by configuring security settings, including reCAPTCHA, to safeguard your instance against automated threats. Use the environment variables below to manage these settings:
-### `APPSMITH_RECAPTCHA_ENABLED`
+#### `APPSMITH_RECAPTCHA_ENABLED`
@@ -149,14 +149,14 @@ Enables Google reCAPTCHA verification on your Appsmith instance by embedding a r
-### `APPSMITH_RECAPTCHA_SITE_KEY`
+#### `APPSMITH_RECAPTCHA_SITE_KEY`
Public key provided by Google reCAPTCHA for integrating the service into your web application. Set this variable with the site key you received after registering your Appsmith instance as a site under Google reCAPTCHA.
-### `APPSMITH_RECAPTCHA_SECRET_KEY`
+#### `APPSMITH_RECAPTCHA_SECRET_KEY`
The secret key provided by Google reCAPTCHA that Google uses to verify the user input during communication between your server and the reCAPTCHA server. The secret is confidential and used in server-side code. Set this variable with the secret key provided by reCAPTCHA.
@@ -167,25 +167,25 @@ The secret key provided by Google reCAPTCHA that Google uses to verify the user
Appsmith can connect to external providers for MongoDB and Redis. The associated environment variables ensure that Appsmith establishes a connection to external hosting rather than using the embedded MongoDB or Redis servers.
-### `APPSMITH_MONGODB_URI`
+#### `APPSMITH_MONGODB_URI`
Appsmith uses this variable to connect to an external MongoDB instance. Set it to the full MongoDB URI supplied by the hosting service. This enables Appsmith to store data in your MongoDB database, ensuring control and ownership of the application data.
-### `APPSMITH_REDIS_URL`
+#### `APPSMITH_REDIS_URL`
Appsmith uses this variable to establish a link to an external Redis server, which Appsmith uses for session handling and caching operations. This connection string typically includes the Redis host, port number, and optionally, authentication credentials.
-### `APPSMITH_ENCRYPTION_PASSWORD`
+#### `APPSMITH_ENCRYPTION_PASSWORD`
The encryption password is critical for safeguarding your datasource credentials through encryption. Select a strong password that exhibits a good level of entropy to prevent easy decryption.
-### `APPSMITH_ENCRYPTION_SALT`
+#### `APPSMITH_ENCRYPTION_SALT`
The encryption salt contributes to the security strategy by adding a layer of complexity during the encryption process. This long, unique string enhances encryption strength, making it more resistant to attacks such as brute-force attempts.
@@ -195,7 +195,7 @@ Appsmith can connect to external providers for MongoDB and Redis. The associated
If you prefer to host your Appsmith instance on a personalized domain, you can do so by setting up a custom domain. Appsmith also provisions an SSL certificate through Let’s Encrypt, securing your application with HTTPS.
-### `APPSMITH_CUSTOM_DOMAIN`
+#### `APPSMITH_CUSTOM_DOMAIN`
Set this variable with your custom domain to access Appsmith.
@@ -205,14 +205,14 @@ If you prefer to host your Appsmith instance on a personalized domain, you can d
With Appsmith, you can manage user access and authentication methods in your instance. This helps streamline logins and control who can create accounts on the platform.
-### `APPSMITH_FORM_LOGIN_DISABLED`
+#### `APPSMITH_FORM_LOGIN_DISABLED`
Set to `true` to turn off the default username and password login. Useful for administrators who want to enforce Single Sign-On (SSO) or limit authentication methods for added security and control.
-### `APPSMITH_SIGNUP_DISABLED`
+#### `APPSMITH_SIGNUP_DISABLED`
@@ -223,7 +223,7 @@ Set to `true` to stop new user account creation. Useful when you want to restric
Adjust the internal server timeout to optimize performance based on your Appsmith instance's load and expected response times.
-### `APPSMITH_SERVER_TIMEOUT`
+#### `APPSMITH_SERVER_TIMEOUT`
From 39777b8724918f33d15de007c8471c1dabffabdc Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Fri, 15 Dec 2023 10:03:43 +0530
Subject: [PATCH 08/11] to compare the heads
---
website/docs/getting-started/setup/environment-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 0f6ae92089..80662c1382 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -12,7 +12,7 @@ Environment variables play a crucial role in configuring different aspects of yo
The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google or GitHub credentials.
-#### `APPSMITH_OAUTH2_GOOGLE_CLIENT_ID`
+### `APPSMITH_OAUTH2_GOOGLE_CLIENT_ID`
This variable stores the Client ID provided by Google during OAuth 2.0 configuration. It's unique to your application, identifying you during the authentication process with Google's servers. Set this variable to the Google OAuth 2.0 Client ID available in your Google Cloud Platform console under the credentials section for your project.
From cf9e90bfe83149c4ada2f64cfac7286ecc63a52c Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Fri, 15 Dec 2023 13:32:11 +0530
Subject: [PATCH 09/11] Updates to. add other envs
---
.github/styles/Vocab/technical/accept.txt | 5 +
.../setup/environment-variables.md | 94 ++++++++++++++++---
2 files changed, 84 insertions(+), 15 deletions(-)
diff --git a/.github/styles/Vocab/technical/accept.txt b/.github/styles/Vocab/technical/accept.txt
index 4d7b78d454..6778b1724c 100644
--- a/.github/styles/Vocab/technical/accept.txt
+++ b/.github/styles/Vocab/technical/accept.txt
@@ -21,6 +21,7 @@ Ping Identity
application
Application
OAuth 2
+OAuth
Domain
Keycloak
PostgreSQL
@@ -32,3 +33,7 @@ ECS
RDS
SAML
Bind
+OIDC
+Login
+Signup
+reCAPTCHA
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 80662c1382..943f922890 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -8,11 +8,11 @@ toc_max_heading_level: 2
Environment variables play a crucial role in configuring different aspects of your Appsmith instance, such as authentication, defining logging levels, customizing email settings, and more. This page provides a detailed description of each environment variable along with its purpose and usage.
-## OAuth 2.0
+## Google OAuth
-The following environment variables assist in configuring OAuth 2.0 authentication, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google or GitHub credentials.
+The following environment variables help in configuring OAuth 2.0 authentication with Google, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing Google credentials.
-### `APPSMITH_OAUTH2_GOOGLE_CLIENT_ID`
+#### `APPSMITH_OAUTH2_GOOGLE_CLIENT_ID`
This variable stores the Client ID provided by Google during OAuth 2.0 configuration. It's unique to your application, identifying you during the authentication process with Google's servers. Set this variable to the Google OAuth 2.0 Client ID available in your Google Cloud Platform console under the credentials section for your project.
@@ -24,19 +24,58 @@ The following environment variables assist in configuring OAuth 2.0 authenticati
This variable holds the Client Secret provided by Google for OAuth 2.0. The secret is confidential and used in server-to-server communications. Assign this variable with the Google OAuth 2.0 Client Secret obtained from the Google Cloud Platform console where you configured your OAuth credentials.
+## Google OAuth
+
+The following environment variables help in configuring OAuth 2.0 authentication with GitHub, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing GitHub credentials.
+
#### `APPSMITH_OAUTH2_GITHUB_CLIENT_ID`
This variable represents the GitHub OAuth 2.0 Client ID used for authenticating users via GitHub. It's a public identifier for your application. Get your GitHub OAuth 2.0 Client ID by registering your Appsmith instance as a GitHub OAuth application and setting it as the variable's value.
-
#### `APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET`
This variable, in conjunction with the Client ID, holds the secret key provided by GitHub OAuth 2.0 to authenticate your application's requests securely. Set this variable with the Client Secret provided by GitHub upon creating your OAuth application. Ensure that you store it securely and do not expose it publicly.
+## OIDC OAuth
+
+The following environment variables help in configuring OAuth 2.0 authentication with your OIDC provider, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing OIDC credentials.
+
+#### `APPSMITH_OAUTH2_OIDC_CLIENT_ID`
+
+
+ This variable represents your OIDC OAuth 2.0 Client ID used for authenticating users via the OIDC provider. It's a public identifier for your application. Get your OIDC OAuth 2.0 Client ID by registering your Appsmith instance with your provider and setting it as the variable's value.
+
+
+#### `APPSMITH_OAUTH2_OIDC_CLIENT_SECRET`
+
+
+ This variable, in conjunction with the OIDC Client ID, holds the secret key provided by your OIDC provider to authenticate your application's requests securely. Set this variable with the Client Secret provided by your provider upon creating your OIDC application. Ensure that you store it securely and do not expose it publicly.
+
+
+
+## Form Login and Signup
+
+With Appsmith, you can manage user access and authentication methods in your instance. This helps streamline logins and control who can create accounts on the platform.
+
+#### `APPSMITH_FORM_LOGIN_DISABLED`
+
+
+
+Set to `true` to turn off the default username and password login. Useful for administrators who want to enforce Single Sign-On (SSO) or limit authentication methods for added security and control.
+
+
+#### `APPSMITH_SIGNUP_DISABLED`
+
+
+
+Set to `true` to stop new user account creation. Useful when you want to restrict access to your Appsmith instance, allowing only users who have been specifically invited to join.
+
+
+
## Client logging
Appsmith provides a way to enhance the log levels of your applications, aiding in monitoring client-side operations and troubleshooting issues. The following environment variable helps define the verbosity level of the logs that Appsmith will generate for client-side activities.
@@ -51,7 +90,7 @@ This variable determines the level of detail that your client-side logs will cap
-## Email
+## Email server
Configure your email server in Appsmith to handle application emailing needs. The following environment variables enable you to set up and manage these email-related capabilities for your Appsmith instance.
@@ -109,8 +148,6 @@ The **ReplyTo** address is the email displayed in the response field of Appsmith
-
-
#### `APPSMITH_SMTP_AUTH_ENABLED`
@@ -134,11 +171,11 @@ Monitoring the performance of your Appsmith instance is crucial for making infor
-Controls whether Appsmith sends telemetry data to its servers. You may choose to turn off the setting if it conflicts with your privacy policies or preferences. Set to `true` to allow Appsmith to collect anonymous telemetry data or `false` to opt-out.
+Controls whether Appsmith sends telemetry data to its servers. You may choose to turn off the setting if it conflicts with your privacy policies or preferences. Set to `true` to allow Appsmith to collect anonymous telemetry data or `false` to opt out.
-## Security
+## Google reCAPTCHA
Ensure the safety of your applications and data by configuring security settings, including reCAPTCHA, to safeguard your instance against automated threats. Use the environment variables below to manage these settings:
#### `APPSMITH_RECAPTCHA_ENABLED`
@@ -173,6 +210,20 @@ Appsmith can connect to external providers for MongoDB and Redis. The associated
Appsmith uses this variable to connect to an external MongoDB instance. Set it to the full MongoDB URI supplied by the hosting service. This enables Appsmith to store data in your MongoDB database, ensuring control and ownership of the application data.
+#### `APPSMITH_MONGODB_USER`
+
+
+ Defines the username credential used by Appsmith to establish a connection with an external MongoDB instance. This setting ensures secure access to the designated database.
+
+
+#### `APPSMITH_MONGODB_PASSWORD`
+
+
+
+Sets the password associated with the MongoDB user specified in `APPSMITH_MONGODB_USER`. This password is crucial for secure authentication, allowing Appsmith to connect and interact with the external MongoDB instance securely.
+
+
+
#### `APPSMITH_REDIS_URL`
@@ -201,22 +252,35 @@ If you prefer to host your Appsmith instance on a personalized domain, you can d
Set this variable with your custom domain to access Appsmith.
-## Signup and login
+## Supervisord
-With Appsmith, you can manage user access and authentication methods in your instance. This helps streamline logins and control who can create accounts on the platform.
+Access the Supervisord web interface seamlessly through Appsmith by setting login credentials using environment variables. Securely control your background processes, ensuring reliable application management.
-#### `APPSMITH_FORM_LOGIN_DISABLED`
+#### `APPSMITH_SUPERVISOR_USER`
+Specifies the username for authentication within Supervisord. Appsmith uses this credential to interact with Supervisord, facilitating the management and monitoring of background processes and tasks.
-Set to `true` to turn off the default username and password login. Useful for administrators who want to enforce Single Sign-On (SSO) or limit authentication methods for added security and control.
-#### `APPSMITH_SIGNUP_DISABLED`
+#### `APPSMITH_SUPERVISOR_PASSWORD`
-Set to `true` to stop new user account creation. Useful when you want to restrict access to your Appsmith instance, allowing only users who have been specifically invited to join.
+Sets the password associated with the Supervisord user specified in `APPSMITH_SUPERVISOR_USER`. This password is essential for secure authentication, enabling Appsmith to manage and control background processes seamlessly through Supervisord.
+
+
+
+## Schedule automatic backups
+
+In Appsmith, you have the flexibility to automate backups for your self-hosted instance. You can use the cron expression to schedule regular backups.
+
+#### `APPSMITH_BACKUP_CRON_EXPRESSION`
+
+
+
+Specify a `5-value` cron expression to define the schedule for automatic backups. This allows you to tailor the backup frequency according to your preferences.
+
## Server timeout
From 6143d32a776002d75763fe4924e9611cee56d42e Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Fri, 15 Dec 2023 13:36:48 +0530
Subject: [PATCH 10/11] Moved page under the configure instance section
---
website/sidebars.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/website/sidebars.js b/website/sidebars.js
index 25cfdd105d..3b8a2a9c1e 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -173,6 +173,7 @@ const sidebars = {
},
'getting-started/setup/instance-configuration/http-proxy',
'getting-started/setup/instance-configuration/frame-ancestors',
+ 'getting-started/setup/environment-variables',
],
},
{
@@ -225,7 +226,6 @@ const sidebars = {
},
],
},
- 'getting-started/setup/environment-variables',
`getting-started/setup/best-practices`,
'getting-started/setup/deployment-architecture',
],
From 9c4c8aa0c7578b5b24610a5a5c6c73b8727ca5cd Mon Sep 17 00:00:00 2001
From: Nikhila Jain <99252011+jnikhila@users.noreply.github.com>
Date: Fri, 15 Dec 2023 14:04:56 +0530
Subject: [PATCH 11/11] minor update
---
website/docs/getting-started/setup/environment-variables.md | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/website/docs/getting-started/setup/environment-variables.md b/website/docs/getting-started/setup/environment-variables.md
index 943f922890..733e9ab460 100644
--- a/website/docs/getting-started/setup/environment-variables.md
+++ b/website/docs/getting-started/setup/environment-variables.md
@@ -24,7 +24,7 @@ The following environment variables help in configuring OAuth 2.0 authentication
This variable holds the Client Secret provided by Google for OAuth 2.0. The secret is confidential and used in server-to-server communications. Assign this variable with the Google OAuth 2.0 Client Secret obtained from the Google Cloud Platform console where you configured your OAuth credentials.
-## Google OAuth
+## GitHub OAuth
The following environment variables help in configuring OAuth 2.0 authentication with GitHub, enabling seamless login experiences and allowing Appsmith applications to authenticate users with their existing GitHub credentials.