Upgrade to Checkpoint Version
A checkpoint version is a milestone release that ensures a proper application of any necessary database schema changes, optimizations, or other updates to prevent compatibility issues or data inconsistencies. When performing a manual update, you first need to upgrade to a checkpoint version if your Appsmith installation version is prior to v1.9.2
. For a complete list of releases, see Appsmith releases.
The available Appsmith checkpoint versions are as follows:
v1.9.2
This page provides steps to upgrade Appsmith to the checkpoint version on your self-hosted Appsmith instance.
Prerequisites
- At least 2 GB of free storage space for backup and update tasks.
Before you begin
- Create a backup of the Appsmith instance, See Backup instance guide. (Recommended)
- Upgrade your embedded or external MongoDB server to MongoDB v5 or later. See the list of compliant platforms and follow the steps to Upgrade a Replica Set to 5.0.
Docker
Before you update to a checkpoint version, ensure you have met all the prerequisites. Follow these steps to update to the checkpoint version v1.9.2
. You can use these instructions to update Appsmith on any platform that supports Docker (Docker, AWS AMI, or DigitalOcean).
- Access your Appsmith instance and change the image attribute in the
docker-compose.yml
file to point to the checkpoint versionv1.9.2
:- If you are on the Community Edition, update the image name as shown below:
services:
appsmith:
image: index.docker.io/appsmith/appsmith-ce:v1.9.2
container_name: appsmith - If you are on the Commercial Edition, update the image name as shown below:
services:
appsmith:
image: index.docker.io/appsmith/appsmith-ee:v1.9.2
container_name: appsmith
- If you are on the Community Edition, update the image name as shown below:
- Save the changes, and restart the Appsmith instance with:
docker-compose up -d
- The server starts with the older version and applies all the necessary schema changes to your Appsmith instance. Once completed, switch back to the original image version in the
docker-compose.yml
file and resume normal operations.- If you are on the Community Edition, update the image name as shown below:
services:
appsmith:
image: index.docker.io/appsmith/appsmith-ce
container_name: appsmith - If you are on the Commercial Edition, update the image name as shown below:
services:
appsmith:
image: index.docker.io/appsmith/appsmith-ee
container_name: appsmith
- If you are on the Community Edition, update the image name as shown below:
- Save the changes and restart the Appsmith instance with:
docker-compose up -d
Troubleshooting
If you see errors, roll back to a previous version to fix the issue. For more information, see the Restore instance section.
If you continue to face issues, contact the support team using the chat widget at the bottom right of this page.