Skip to main content

Docker

Follow the steps listed below to upgrade your Community Edition (CE) to a Business Edition (BE) installed on docker.

Step 1: Database backup

The Community and Business editions use MongoDB, so you don't have to migrate the database. It's still recommended to backup the Community Edition MongoDB.

Ensure that you backup the database with the docker instance up and running.

Step 2: Update image

If you are using docker run, head to Step 4: Recreate the instance.

Go to the directory where the docker-compose.yml file is located. Open the docker-compose.yml file, and look for the image: key. Update the image in the docker-compose.yml file from Community Edition (appsmith-ce) to Business Edition (appsmith-ee).

The updated file should have the image attribute set as below and save the file:

 services:
appsmith:
image: index.docker.io/appsmith/appsmith-ee

Step 3: Add or replace license key

Go to the directory stacks/configuration and open the docker.env file. Add/replace the Business Edition license key and save the file.

APPSMITH_LICENSE_KEY=<ENTER_THE_LICENSE_KEY>

Step 4: Recreate the instance

You can recreate the instance by running the below command:
docker-compose up -d
note

If you have only replaced the license key then you have to run the following command to restart the instance.

docker-compose restart appsmith

You have successfully upgraded the docker instance to the Business Edition. Once the container is up and running, you can verify that the business image (appsmith-ee) is in use. Use the docker ps command to verify the image name.

Rollback (optional)

Follow the below steps to rollback to the Community Edition.

  1. Stop the docker instance by using

    docker-compose down
  2. Go to the directory (stacks\configuration) and open the docker.env. Remove the license key (APPSMITH_LICENSE_KEY)

  3. Go to the docker-compose.yml file, and look for the image: key. Update the image in the docker-compose.yml file from Business Edition (appsmith-ee) to Community Edition (appsmith-ce).

The updated file should have the image attribute set as below:

services:
appsmith:
image: index.docker.io/appsmith/appsmith-ce
  1. Recreate the instance by running the below command:
docker-compose up -d

You have successfully upgraded the docker instance to the Business Edition. Once the container is up and running, you can verify that the business image (appsmith-ee) is in use. Use the docker ps command to verify the image name.

  • Restore the database backup you had taken at the start of the upgrade process.

If you’re having issues with the deployment, please see the deployment errors troubleshooting guide. If you continue to have problems reach out on discord or send an email to support or ask questions on the community forum.