Upgrade to Checkpoint Versions

Checkpoint versions are milestone releases that apply required database schema updates, optimizations, and compatibility fixes to your Appsmith instance. You must install each checkpoint version that applies to you, and let your instance start successfully, before you upgrade to a later release.

This page covers the checkpoint versions for upgrading to Appsmith v2.0. For checkpoints in later releases, which Appsmith enforces automatically, see Upgrade checkpoints.

Find the checkpoints that apply to you

Your current version	What to do
Earlier than v1.9.2	Follow Upgrade to v1.9.2, which takes you to v1.9.2 and then to v1.99. Then upgrade to the latest release.
v1.9.2 or later, but earlier than v1.96	Upgrade to v1.96–v1.99, and then to the latest release.
v1.96 or later	No action is required. Follow Upgrade Appsmith versions.

Prerequisites

Before you upgrade, 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 guide to upgrade a replica set to 5.0.
3. You have a backup of your Appsmith instance. To create one, follow the Backup instance guide.

Upgrade to v1.9.2

Follow these steps if your current version is earlier than v1.9.2. These steps upgrade your instance to v1.9.2 and then to v1.99. Do not upgrade directly from v1.9.2 to v2.0 or later.

Docker

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

1. Go to your Appsmith installation directory, open the docker-compose.yml file, and set the image tag to v1.9.2:

   services:
     appsmith:
       image: index.docker.io/appsmith/appsmith-ee:v1.9.2
       container_name: appsmith

2. Save the file and restart the instance:

   docker-compose up -d

3. Wait for the instance to start and apply the schema changes. This happens automatically.

4. After the schema updates are complete, update the image tag in docker-compose.yml to v1.99:

   services:
     appsmith:
       image: index.docker.io/appsmith/appsmith-ee:v1.99
       container_name: appsmith

5. Save the file and restart the instance again to complete the update:

   docker-compose up -d

Kubernetes

These instructions apply to Appsmith instances running on Kubernetes.

StatefulSets

1. List the StatefulSets in your Appsmith namespace:

   kubectl get sts -n <appsmith-namespace>

   Replace <appsmith-namespace> with your namespace.

2. Set the StatefulSet image to checkpoint version v1.9.2:

   kubectl set image sts/<appsmith> -n <appsmith-namespace> appsmith=appsmith/appsmith-ee:v1.9.2

3. Restart the StatefulSet to pull and run version v1.9.2:

   kubectl rollout restart sts/<appsmith> -n <appsmith-namespace>

4. Verify the update by checking that your Appsmith apps work as expected.

5. After the instance is stable, update the image tag to v1.99:

   kubectl set image sts/<appsmith> -n <appsmith-namespace> appsmith=appsmith/appsmith-ee:v1.99

6. Restart the StatefulSet to pull and run version v1.99:

   kubectl rollout restart sts/<appsmith> -n <appsmith-namespace>

Deployments for high availability

1. List the Deployments in your Appsmith namespace:

   kubectl get deployments -n <appsmith-namespace>

   Note the name of the Appsmith Deployment.

2. Set the Deployment image to checkpoint version v1.9.2:

   kubectl set image deployment/<appsmith> -n <appsmith-namespace> appsmith=appsmith/appsmith-ee:v1.9.2

3. After the instance is stable, update the image tag to v1.99:

   kubectl set image deployment/<appsmith> -n <appsmith-namespace> appsmith=appsmith/appsmith-ee:v1.99

AWS ECS (EC2) and Fargate

These instructions apply to Appsmith instances running on AWS ECS (EC2) and Fargate.

1. Sign in to your AWS account and open the Amazon ECS console.
2. Select the cluster that contains the container instance you want to update.
3. Open the task definition and set the image tag to v1.9.2:

   appsmith/appsmith-ee:v1.9.2
4. Restart the ECS service.
5. Verify that the updated version is running.
6. Open the task definition and update the image tag to v1.99:

   appsmith/appsmith-ee:v1.99
7. Restart the ECS service.
8. Verify that the updated version is running.

After your instance is running v1.99, upgrade to v2.0 or later by following Upgrade Appsmith versions.

Upgrade to v1.96–v1.99

Follow these steps if your current version is v1.9.2 or later, but earlier than v1.96. You must install one of the versions from v1.96 to v1.99 before you upgrade to v2.0 or later. Appsmith recommends v1.99.

1. Follow the steps in Upgrade Appsmith versions for your platform, and set the image tag to v1.99.
2. Wait for the instance to start, and verify that your Appsmith apps work as expected.
3. Upgrade to v2.0 or later by following Upgrade Appsmith versions again.

If you already upgraded directly to v2.0 or later and the logs show failures, roll back to your previous version by following the Restore instance guide. Then follow the steps above.

Troubleshooting

If the upgrade fails, roll back to the previous version by following the Restore instance guide.

If the problem persists, contact Appsmith support using the chat widget in the bottom-right corner of this page.

See also

• Upgrade checkpoints: Learn how Appsmith enforces checkpoints in later releases, and what to do if the server does not start after an upgrade.
• Upgrade Appsmith versions: Learn how to upgrade your Appsmith installation to the latest version.
• Schedule automatic updates for Appsmith installation: Learn how to schedule automatic updates to keep your installation up to date.