Local Deploy

Running Retool locally on Mac or Linux

Running the easy install script

Run this script to create Retool at ~/retool/retool-onpremise and run the docker containers

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/tryretool/retool-onpremise/master/local-trial)"
  • Note, if you've run the local-trial script on your computer in the distant past and now want to run it again with updated code, you may want to delete the directory at ~/retool/retool-onpremise, and then re-run the local-trial script.

Installing Retool without the script

Prefer to install manually rather using the script? That's cool too. Just follow the steps below:

  1. Run git clone https://github.com/tryretool/retool-onpremise.git to clone our repository
  2. Run the local-trial script by running ~/retool/retool-onpremise/install.sh

After installing
Retool will now be running at localhost:3000. You can open this page in your browser, then click sign up.

Explaining the local-trial script

The local-trial script did three main things:

  1. Downloaded the latest version of Retool and installed it in ~/retool
  2. Configured the docker.env file with the correct environment variables
  3. Ran the Retool docker containers

To stop running Retool, you can end the process by running stop-local-trial, which is inside ~/retool/retool-onpremise by default.

Connecting to a resource (database or API)

A resource is a datasource that you can read into your Retool application and use while building an app.

If your machine is on your company's VPN, you should be able to add your internal resources.

If you want to add a database that you have running locally, make sure to use host.docker.internal as the host in the resource configuration screen to tell Retool to look outside of the Docker container that it is running in.

Next steps

That's it! Have fun, build a few apps, and reach out if you'd like help with a more permanent deployment!

Running Retool in a cloud service

To run trial Retool on a cloud service like AWS, Azure, or Heroku you can just run the easy install script on the machine. If you need help creating a machine with the right resources to run Retool, You can follow these instructions to create the right kind of machine.

Troubleshooting and FAQs

Retool has support accessible through the Intercom bubble on this page! You can contact us if the FAQs below don't answer your question.

Retool failed to start when I ran the script and I'm not sure why

There are a few common reasons Retool fails:

  1. You don't have docker or docker-compose installed correctly.
  2. You are on Linux to add sudo when running docker-compose up
  3. You need to add the license key LOCAL-ONLY-TRIAL to the docker.env file

I keep getting redirected to the homepage after logging in or signing up

Make sure COOKIE_INSECURE=true is set in the docker.env file

Updated 15 days ago


Local Deploy


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.