| description |
|---|
Appsmith can be deployed locally or on your private instance using Docker |
- Docker (version 20.10.7 or later)
- Docker-Compose (version 1.29.2 or later)
Create an installation folder called appsmith, where you would like your Appsmith installation, and data to live in.
cd into the installation folder.
The Appsmith Docker image is built with all the components required for it to run, within a single Docker container. All these multiple processes are managed by a Supervisord instance, which is a lightweight process manager.
Download the below docker-compose.yml file into the appsmith installation folder
{% file src="../.gitbook/assets/docker-compose.yml" caption="docker-compose.yml" %}
or run the following curl if you're on a remote machine
curl -L https://bit.ly/2WMPFPy -o $PWD/docker-compose.ymlThis configuration runs an Appsmith instance, and a Watchtower instance to keep Appsmith automatically up-to-date.
Bring the docker container up by running the following command. (You may need to run as sudo if docker and docker-compose are not accessible by your user)
docker-compose up -dThis command will download the Docker images, if not already locally available, and start the services. You can follow the logs with the following command:
docker logs -f appsmithYou should see a message Appsmith is Running! once the container is ready
{% hint style="success" %} Congratulations! Your Appsmith server should be up and running now. You can access it at http://localhost. {% endhint %}
To quickly get Appsmith up and running, run the following command on your machine:
docker run -d --name appsmith -p 80:80 -p 9001:9001 -v "$PWD/stacks:/appsmith-stacks" appsmith/appsmith-ceThis will download the image and start Appsmith. Once the download is complete, the server should be up in under a minute. You can follow the logs with the following command:
docker logs -f appsmithYou should see a message Appsmith is Running! once the container is ready
In the event that your containers are failing to restart, you can execute the below script to bring them up
{% file src="../.gitbook/assets/restart-container.sh" caption="restart-containers.sh" %}
copy the script to your installation folder and make it executable
chmod +x restart-containers.sh
./restart-containers.shIf you encounter any errors during this process, check out our guide on debugging deployment errors, if you are still facing an issue please reach out to support@appsmith.com or join our Discord Server to directly speak to the appsmith team!