Skip to main content

Upgrade Appsmith Versions

This page explains how to update your self-hosted Appsmith instance to the latest version.

Prerequisites​

Before you update, make sure that:

  1. You have at least 2 GB of free storage for the backup and update.
  2. Your embedded or external MongoDB server runs version 5.0 or later. To upgrade MongoDB, check the supported platforms and follow the MongoDB replica set upgrade guide.
  3. You have a backup of your Appsmith instance. To create one, follow the Backup instance guide.

Required upgrade checkpoints​

Before upgrading a self-hosted instance to v2.6 or later, install v2.5.2 and complete the Workflow Engine Transition checkpoint. Sign in as an instance administrator and open Admin Settings → Instance → Admin central to review and acknowledge the checkpoint. Do not proceed to v2.6 or later until it is complete. See Upgrade checkpoints and v2.5.2 workflow engine transition for details.

Update Appsmith​

Select your platform and follow the steps to update Appsmith to the latest version:

These instructions apply to Docker-based platforms, such as Docker standalone and AWS AMI.

Important

Some versions are checkpoints that you must install before you upgrade further:

  • If your current version is earlier than v1.9.2, follow the steps in Upgrade to v1.9.2 before you update to the latest release.
  • If your current version is later than v1.9.2 but earlier than v1.96, follow Upgrade to v1.96–v1.99 before you upgrade to v2.0 or later.
  • Before upgrading to v2.6 or later, install v2.5.2 and complete the checkpoint in Admin central.
Upgrading from a version earlier than v2.4

If you use SAML SSO and your docker.env sets APPSMITH_KEYCLOAK_DB_URL but not APPSMITH_KEYCLOAK_DB_DRIVER, add APPSMITH_KEYCLOAK_DB_DRIVER=h2 before you upgrade. Without it, SAML SSO login can fail with a 502 error after the upgrade. See SAML SSO login returns 502 after upgrading to v2.4 or later.

  1. Find your Appsmith installation directory:

    docker inspect -f '{{ (index .Mounts 0).Source }}' <APPSMITH_CONTAINER_ID>
  2. Choose the Appsmith version you want to run.

    Find its release tag on GitHub.

  3. Open docker-compose.yml in that directory and set the image for the Appsmith service to a pinned tag, for example:

    image: index.docker.io/appsmith/appsmith-ee:<version>

    If you use the Community Edition, replace appsmith-ee with appsmith-ce and keep the same :<version> suffix.

  4. Pull the image and restart the container. The new container runs the version set in docker-compose.yml.

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

Troubleshooting​

If the update fails, roll back to the previous version by following the Restore instance guide. If the problem persists, contact support using the chat widget in the bottom-right corner of this page.

See also​