Skip to main content

Docker

This page provides instructions to install Appsmith using Docker.

How to install Appsmith using Docker Compose

Prerequisites​

Before you begin, ensure you have the following prerequisites:

  • Docker (version 20.10.7 or later)
  • Docker-Compose (version 1.29.2 or later)
  • Whitelist cs.appsmith.com in your firewall or security group’s outbound rules to ensure Docker can pull required images and dependencies.

Install Appsmith​

Follow these steps to install Appsmith:

  1. Create a folder named appsmith on your machine for deployment and data storage. Navigate to this folder using the cd command.

  2. Create a docker-compose.yml file with:

    version: "3"
    services:
       appsmith:
         image: index.docker.io/appsmith/appsmith-ee
         container_name: appsmith
         ports:
             - "80:80"
             - "443:443"
         volumes:
             - ./stacks:/appsmith-stacks
         restart: unless-stopped

    The appsmith-ee image installs the Commercial edition (recommended), which offers a free plan and the flexibility to upgrade to a paid plan at any point. To install the Community edition, replace appsmith-ee with appsmith-ce in the image attribute within the docker-compose.yml file.

  3. Start the Docker container by using the below command. You may need to use sudo if you don't have permission to run docker-compose:

    docker-compose up -d

    This command will download the necessary Docker image if it doesn't exist locally and start the container.

  4. Open http://localhost and wait for the server to come up. This can take up to 5 minutes. Once the server is up and running, you can access Appsmith at http://localhost.

  5. Fill in your details to create an administrator account.

  6. Once you've created an account, you can either start with the free plan or activate your instance with a license key. If you want to generate a license key, sign up on customer.appsmith.com to create one, and then proceed to activate your instance using the newly generated license key.

Post-installation configuration​

Once you have completed the installation process, consider performing the tasks below to configure and manage your Appsmith instance, enhancing its security and performance, specifically if it's intended for production use.


Configure Single Sign-on (SSO)

Configure SSO to allow users to sign in using your identity provider. Learn more about configuring SSO.

Configure Email Service

Set up an email service to enable Appsmith to send notifications and alerts. Learn more about configuring email services.

Set Up Custom Domain and SSL

Set up a custom domain for your Appsmith instance and secure it with SSL. Learn more about setting up custom domains and SSL.

Backup and Restore

Ensure the safety of your Appsmith instance data by regularly backing up and restoring it when needed. Learn more about Backup and Restore.

Troubleshooting​

If you are facing issues during deployment, refer to the guide on troubleshooting deployment errors. If you continue to face issues, contact the support team using the chat widget at the bottom right of this page.

See also​