Sign up to generate a key
Get started here to generate a free trial license key. You can then select the Local deployment option and copy the 1-line command.
The instructions below share more about how the installation options work.
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/ssop/deploy-retool)" < <(echo "YOUR_LICENSE_KEY")
Installing Retool without the one-line command
Prefer to install manually rather using the one-line command? That's cool too. Just follow the steps below:
git clone https://github.com/tryretool/retool-onpremise.gitto clone our repository
cd retool-onpremiseto switch into the directory and run the script with
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:
- Downloaded the latest version of Retool and installed it in ~/retool
- Configured the docker.env file with the correct environment variables
- 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.
That's it! Have fun, build a few apps, and reach out if you'd like help with a more permanent deployment!
To run trial Retool on a cloud service like AWS, Azure, or Heroku, get started here. If you need help creating a machine with the right resources to run Retool, check out these instructions to create the right kind of machine.
Retool has support accessible through the Intercom bubble on this page! You can contact us if the FAQs below don't answer your question.
There are a few common reasons Retool fails:
- You don't have docker or docker-compose installed correctly.
- You are on Linux to add sudo when running
- You need to add the license key LOCAL-ONLY-TRIAL to the docker.env file
Make sure COOKIE_INSECURE=true is set in the docker.env file
Updated 2 months ago