Skip to main content

Instance Configuration

Configuration of your Appsmith instance allows you to tailor it to your specific needs. This process includes setting up elements like environment variables, authentication, emails, SSL, and custom domain. Proper configuration ensures that your instance is running efficiently.

Configure Docker installations

To configure a docker installation, go to your installation folder and edit the stacks/configuration/docker.env file with the environment variables for the service. For example, you wish to add Google Maps API key. Add/update the environment variable APPSMITH_GOOGLE_MAPS_API_KEY and add the Google API key to it as shown below:

APPSMITH_GOOGLE_MAPS_API_KEY=YOUR_API_KEY

After making changes, be sure to restart the docker containers for the changes to take effect. Run the below command to restart the Appsmith container.

  • Docker run
     docker restart appsmith
  • Docker Compose
     docker-compose restart appsmith

Configure Helm installations

To configure environment variables using helm, follow these steps:

You may choose to configure environment variables: through commands or by using a values.yaml file.

  • When using command, specify each parameter using --set key=value[,key=value] argument to helm upgrade.

      helm upgrade --set applicationConfig.<ENV_KEY>=<ENV_VALUE> [ RELEASE ] [ CHART ]  

    For example, the below command sets the APPSMITH_SIGNUP_DISABLED variable to true and configures it to disable signup button on Appsmith login screen.

  • Alternatively, use a values.yaml file. You can specify the parameter values in the applicationConfig section.

      APPSMITH_OAUTH2_GOOGLE_CLIENT_ID: ""
    APPSMITH_OAUTH2_GOOGLE_CLIENT_SECRET: ""
    APPSMITH_OAUTH2_GITHUB_CLIENT_ID: ""
    APPSMITH_OAUTH2_GITHUB_CLIENT_SECRET: ""
    APPSMITH_FORM_LOGIN_DISABLED: ""
    APPSMITH_SIGNUP_DISABLED: "true"

    Once you have made changes to the values file, run the below command.

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

Configure ECS installations

To configure an ECS installation, follow these steps:

  1. Navigate to the ECS console and select Task Definitions on the sidebar.
  2. Click on the Task Definition used by your ECS instance, and hit Create new revision.
  3. On the Task Definition config page, click the Appsmith container definition to edit it. In the Environment Section, enter the environment configuration as key-value pairs as shown below.

It's recommended to use AWS Secrets for sensitive information, please follow the steps to create a secret. Use the ARN of the secret as the Environment value and set the option to ValueFrom.

  1. Hit the Update button, and hit Create to make a new task definition.
  2. Navigate back to the ECS console and select your cluster. Click on your service to open the service details.
  3. Click on Update, and select the latest revision of the Task Definition.
  4. Hit Skip to review and then Update Service. A screen as below shows the status.

It may take a minute for the new ECS Task to start running.

Further reading