The best way to build internal software

Below are the instructions for deploying with Docker Compose, see our docs for more specific details for AWS, GCP, or Azure, as well as for deploying with Helm, Kubernetes, or ECS. Check out our Community Forums if you have questions or issues, and see our deprecated-onpremise repo if you need to reference legacy deployment instructions.

Deploy with Docker Compose

Install → Configure → Run → Upgrade

Install

Important

We test and support running on Ubuntu. If on a different platform, you may need to manually install requirements like Docker.

1. Download this repo

git clone https://github.com/tryretool/retool-onpremise retool && cd retool

2. Run our install script to attempt to set up Docker and initialize the .env files

./install.sh

The script will create docker.env and retooldb.env if successful, else it should call out potential issues to address before rerunning.

Warning

We now assume Compose v2 is installed as a plugin accessed through docker compose, we no longer use the legacy v1 docker-compose syntax. You may need to use the latter based on your OS and installation, see Docker's docs for more context on the migration.

Configure

Tip

Optionally run sudo usermod -aG docker $USER and log out/back in to not require sudo for every Docker command moving forward. Not required, but we'll assume this in the guide

1. Check the generated .env files to make sure the license key and randomized keys were set as expected during the installation.

2. Save off the ENCRYPTION_KEY value, since this is needed to encrypt/decrypt values saved into the Postgres database the Retool instance runs on.

3. To set up HTTPS, you'll need your domain pointing to your server's IP address. If that's in place, make sure DOMAINS is correct in docker.env, and then set STAGE=production in docker-compose.yml for the https-portal container to attempt to get and use a free Let's Encrypt cert for your domain on startup.

Warning

You must set COOKIE_INSECURE=true in docker.env to allow logging into Retool without HTTPS configured (not recommended)

Run

1. Bring up containers

docker compose up -d

2. Check your container statuses after a few minutes

docker compose ps

3. Check your container logs if any container isn't up and running

docker compose logs

4. Go to your domain or IP in a browser and click Sign up to initialize and log into the new instance

Upgrade

1. Set the new version in Dockerfile

2. Download and build the new images

docker compose build

3. Bring up the new containers to replace the old ones

docker compose up -d

4. Remove the old images from the system

docker image prune -a -f