Configure Environment Variables

Appsmith offers environment variables to customize your setup for different services and integrations. These configurations are applicable only to self-hosted Appsmith instances. The page provides step-by-step instructions for configuring environment variables in Appsmith across different deployment methods.

Docker

Follow these steps to configure Appsmith using environment variables for Docker-based installations, including setups on DigitalOcean, AWS AMI, and similar platforms:

1. Navigate to your installation folder.

2. Open the stacks/configuration/docker.env file.

3. Add or update the required environment variables. For example, to set the Google Maps API key:

   APPSMITH_GOOGLE_MAPS_API_KEY=YOUR_API_KEY

4. Restart the Docker containers for the changes to take effect:

   docker-compose restart appsmith

Helm

For Kubernetes installations using Helm, modify the values.yaml file to configure environment variables.

Steps for Commercial Edition:

1. Navigate to your installation's root directory.
2. Generate a values.yaml file:

   helm show values appsmith-ee/appsmith > values.yaml
3. Update parameters under the applicationConfig section. For instance:

   applicationConfig:
     APPSMITH_MAIL_FROM: "test@test.com"
4. Apply the updated values:

   helm upgrade appsmith appsmith-ee/appsmith -f values.yaml -n appsmith

---

Steps for Community Edition:

1. Navigate to your installation's root directory.
2. Generate a values.yaml file:

   helm show values appsmith/appsmith > values.yaml
3. Modify parameters under the applicationConfig section. For example, to set the sender email address:

   applicationConfig:
     APPSMITH_MAIL_FROM: "test@test.com"
4. Apply the updated values:

   helm upgrade appsmith appsmith/appsmith -f values.yaml -n appsmith

AWS ECS

To configure an Appsmith ECS installation:

1. Open the AWS ECS console.

2. Select Task Definitions and choose the relevant task definition.

3. Click Create new revision.

4. In the Task Definition config page, edit the Appsmith container.

5. Under Environment, add or update the key-value pairs for the environment variables. For sensitive data, consider using AWS Secrets Manager. When referring a value from the AWS secrets manager, use ValueFrom in the environment variable.

   

6. Click Update, then Create to generate a new task definition.

7. In the ECS console, navigate to your cluster and select the service.

8. Update the service to use the latest task definition revision.

9. Review and confirm the update.

   

The new ECS task should be running within a minute.

See also

• Environment Variables.