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:
- You have at least 2 GB of free storage for the backup and update.
- 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.
- You have a backup of your Appsmith instance. To create one, follow the Backup instance guide.
Update Appsmith
Select your platform and follow the steps to update Appsmith to the latest version:
- Docker
- Kubernetes
- AWS ECS on EC2
- Azure Container Instance
- DigitalOcean
These instructions apply to Docker-based platforms, such as Docker standalone and AWS AMI.
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.
-
Find your Appsmith installation directory:
docker inspect -f '{{ (index .Mounts 0).Source }}' <APPSMITH_CONTAINER_ID> -
Choose the Appsmith version you want to run.
Find its release tag on GitHub.
-
Open
docker-compose.ymlin that directory and set theimagefor 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-eewithappsmith-ceand keep the same:<version>suffix. -
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
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.
Note: These instructions assume you followed the Kubernetes installation guide exactly. If you changed any defaults, such as the Helm release name or namespace, adjust the commands to match.
-
Choose the latest Appsmith version.
Find the latest release tag on GitHub.
-
Locate your Helm
values.yamlfile.- If you still have the
values.yamlfile from your initial installation, go to its directory:cd /path/to/your/values-file - If you no longer have the file, retrieve it from your cluster:
helm get values appsmith-ee -n appsmith-ee | grep -v "USER-SUPPLIED" > values.yaml
- If you still have the
-
Update the image tag in
values.yaml.- If you have
yqinstalled:APPSMITH_VERSION=<version>
yq -i ".image.tag = \"$APPSMITH_VERSION\"" values.yaml - If you don’t have
yq, openvalues.yamlin a text editor and set the new version:image:
tag: <version>
- If you have
-
Apply the upgrade with Helm.
Run the following command:
helm upgrade appsmith-ee -n appsmith-ee -f values.yaml
- Sign in to your AWS account and open the Amazon ECS console.
- Select the cluster that contains the container instance you want to update.
- Stop the task. ECS automatically deploys a new task.
- Verify that the updated version is running.
- In the Azure portal, find the Azure Container Instance that runs Appsmith.
- Click Restart to restart the container.
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.
-
Connect to your Droplet over SSH and go to the Appsmith installation directory:
cd /root/appsmith -
Choose the Appsmith version you want to run.
Find its release tag on GitHub.
-
Open
docker-compose.ymland set theimagefor 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-eewithappsmith-ceand keep the same:<version>suffix. -
Pull the image and restart the installation. 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
- Upgrade checkpoints: Learn about releases that you must install and run before you can upgrade past them, and what to do if the server does not start after an upgrade.
- Schedule automatic updates for Appsmith installation: Learn how to schedule automatic updates to keep your installation up to date.