Skip to main content

Update Appsmith

This page provides steps to update Appsmith to the latest version.

info

The steps below apply to both the Community and Business editions.

Prerequisites​

Before you start the update process, make sure you complete the below steps:

  • Ensure you have at least 2 GB of free storage space for backup and update tasks.
  • You can create a backup of the Appsmith instance before a manual update. For more information, see Backup Appsmith Instance (Recommended)
Attention

If you are on a version earlier than v1.9.2, first upgrade:

Follow one of the guides below to update Appsmith on your installation platform:

Docker Compose​

The steps below work with any platform that supports Docker. For example, Docker, AWS AMI, or DigitalOcean.

You can update Appsmith in one of the below ways:

info

To find the Appsmith installation directory, run the following command:

docker inspect -f '{{ (index .Mounts 0).Source }}' <APPSMITH_CONTAINER_ID>

Manual update​

Go to the root directory of your installation and run:

docker-compose pull && docker-compose rm -fsv appsmith && docker-compose up -d

Schedule automatic update​

Follow the below steps to schedule the auto updates:

info

Before an automatic update, Appsmith creates a backup. You may use this to roll back to a previous version in case of any issues.

  1. Go to the root directory of the Appsmith installation and run:

    docker-compose down

  2. Open the docker-compose.yml file and uncomment the below code block:

    Attention

    The automatic update is scheduled to run at midnight. If you prefer a different update time, change the expression accordingly.

    #auto_update:
    #  image: containrrr/watchtower
    #  volumes:
    #    - /var/run/docker.sock:/var/run/docker.sock
    #  # Update check interval in seconds.
    #  command: --schedule "0 0 * ? * *" --label-enable --cleanup
    #  restart: unless-stopped
    #  depends_on:
    #    - appsmith
    #  environment:
    #    - WATCHTOWER_LIFECYCLE_HOOKS=true

  3. Save the file and run:

    docker-compose up -d

This setup runs an Appsmith and a Watchtower container. The Watchtower checks and updates Appsmith when a new version becomes available.

You may also schedule automatic updates for your instance. For more information, see Schedule automatic updates for Docker installation.

Kubernetes​

Follow the steps to update your Appsmith installation:

You can update Appsmith in one of the below ways:

Automatic update​

The default Appsmith helm installation disables auto update (recommended). You have the option to enable auto update by either setting it in the values file or using a command.

  • Running the command below.

      helm install appsmith/appsmith appsmith \
        --set autoupdate.enabled=true

  • Or edit values.yaml and specify the following parameters

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

Manual update​

To manually update the Appsmith container image to the latest release, run the command: 

kubectl rollout restart statefulset appsmith

AWS ECS EC2​

Follow the below steps using the Classic Amazon Web Console to manually update Appsmith:

  1. Log in to your AWS account.
  2. Go to the Amazon ECS console.
  3. Select the cluster that contains the container instance that you want to update.
  4. Click the Tasks tab.
  5. Select and click the task that you want to update.
  6. Click the Stop button to stop the task. A new task is deployed automatically. Wait for the new task to be deployed.
  7. Verify that the updated version of your application is running as expected.

Upgrade to a checkpoint version​

When performing a manual upgrade, you must:

  • First, upgrade to the checkpoint between your current and the latest versions.
  • Appsmith checkpoint versions:
    • v1.9.2

Follow the steps below to upgrade to a checkpoint version:

  1. Access your Appsmith instance. Make the below change to the docker-compose.yml file:
services:
  appsmith:
    image: index.docker.io/appsmith/appsmith-ce:v1.9.2
    container_name: appsmith
  1. Save and run the below command on your shell to restart Appsmith.
docker-compose up -d
  1. Your server starts with the older version. It applies all the necessary schema changes to your Appsmith instance. Once completed, switch back to the original image in the docker-compose.yml file and resume normal operations.
services:
appsmith:
  image: index.docker.io/appsmith/appsmith-ce
  container_name: appsmith

  1. Run the restart command once again: 

    docker-compose up -d
note

If you haven't been using your Appsmith instance for a while, it could be possible that there might be multiple versions that show up in the error message. In such a case, perform the same steps for each version in order, starting from the oldest.

Switch off auto updates​

Follow the below steps for your Appsmith installation to switch off auto updates:

  1. Go to the root directory of the Appsmith installation and run:

    docker-compose down

  2. Open the docker-compose.yml file and comment out the below code block:

    auto_update:
      image: containrrr/watchtower
      volumes:
        - /var/run/docker.sock:/var/run/docker.sock
      # Update check interval in seconds.
      command: --schedule "0 0 * ? * *" --label-enable --cleanup
      restart: unless-stopped
      depends_on:
        - appsmith
      environment:
        - WATCHTOWER_LIFECYCLE_HOOKS=true

  3. Save the file and run:

docker-compose up -d --force-recreate
  1. Verify that auto update is turned off with:
docker-compose ps

Troubleshooting​

If you see deployment errors, you can roll back to a previous version to fix the issue. For more information, see the Restore Appsmith instance section.

If you continue to face issues, contact the support team.