Docker | Appsmith - SolFind Web Lens

Docker | Appsmith

https://docs.appsmith.com/getting-started/setup/installation-guides/docker • 54 KB fetched
Open original page

Docker | Appsmith

Ask AI
Search

Ask Appsmith AI Submit message

Examples How do I install Appsmith using Docker? How do I connect to my local PostgreSQL database? How do I pass inputs from a widget to a query? How do I trigger multiple queries conditionally? How do I fix the error: This value does not evaluate to type Array<Object>?

Try Appsmith

* Get Started

* Introduction

* Build Your First App

* Self Hosting

* New Installation Guides

* Docker

* Kubernetes (k8s)

* AWS AMI

* AWS ECS on EC2

* AWS ECS on Fargate

* Azure Container Instance

* Google Cloud Run

* DigitalOcean

* Ansible

* Airgapped Edition

* Manage Installation

* Upgrade Installation Guides

* Concepts

* Connect Data

* Overview

* How-to Guides

* Reference

* Datasources

* Query Settings

* Concepts

* Build Apps

* Overview

* Quickstart

* How-to Guides

* Reference

* Widgets

* Accessibility

* Theme

* Sample Apps

* Write Code

* Overview

* How-to Guides

* Reference

* Global Objects

* Global Functions

* JS Libraries

* Fetch API

* Data Transformation

* JavaScript Settings

* Concepts

* Best Practices

* Manage Apps and Users

* Authentication

* Granular Access Control

* Versioning with Git

* Setup SCIM Provisioning

* Embed Appsmith

* Migrate Applications

* Audit Logs

* Branding

* External Client Portal

* Packages

* Overview

* Tutorial

* How-to Guides

* Reference

* Package Version Control

* GIT Apps with Packages Best Practices

* Code Packages

* UI Packages

* Workflows

* Overview

* Tutorial

* How-to Guides

* Reference

* Workflow Triggers

* Workflow Queries

* Workflow Functions

* Pass Parameters to Workflows

* Run History

* Troubleshooting

* Overview

* Self-hosting Errors

* Application Errors

* Product

* FAQ

* Security

* Telemetry

* Support at Appsmith

* Privacy Policy

* Release Notes

* Contribute

* Self Hosting

* New Installation Guides

* Docker
On this page
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. To verify connectivity after install, see Verify connectivity to cs.appsmith.com .

* Host memory : The default Docker Compose setup runs MongoDB, Redis, and PostgreSQL inside the Appsmith container. Plan for at least 8 GB of RAM on the host for this all-in-one deployment. If you externalize supporting services, the Appsmith container may need less host memory. See Infrastructure and capacity planning .

Install Appsmith

Follow these steps to install Appsmith:

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

*
Create a docker-compose.yml file with:

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

Pin the image to a release tag
Replace <version> with a release tag from Appsmith on GitHub (for example, v1.98 ). Pinning the image avoids unexpected upgrades when you recreate the container and is recommended for production. If you omit the tag, Docker uses latest , which is acceptable for quick local trials but gives you less control over upgrades.

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 name and keep the same :<version> suffix in the image attribute within the docker-compose.yml file.

*
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.

*
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 .

*
Fill in your details to create an administrator account.

*
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.

Docker | Appsmith

Links found on this page