Requirements
Make sure Docker and Docker Compose are installed on your system. These are usually included in tools like Docker Desktop and Rancher Desktop.docker compose
without the hyphen is now the primary method of using docker-compose, according to the
Docker documentation.Start
-
Create a New Directory for Formbricks
Open a terminal and run the following commands to create and enter a new directory for Formbricks:
-
Download the Docker-Compose File
Get the docker-compose file from the Formbricks repository by running:
-
Generate NextAuth Secret
You need a NextAuth secret for session signing and encryption. Run one of the commands below based on your operating system:
For Linux:
For macOS:
-
Generate Encryption Key
Next, you need to generate an Encryption Key. This will be used for authenticating and verifying 2 Factor Authentication. Run one of the commands below based on your operating system:
For Linux:
For macOS:
-
Generate Cron Secret
You require a Cron secret to secure API access for running cron jobs. Run one of the commands below based on your operating system:
For Linux:
For macOS:
-
Start the Docker Setup
Now, you’re ready to run Formbricks with Docker. Use the command below to start Formbricks along with a PostgreSQL database using Docker Compose:
The
-d
flag runs the containers in the background, so they keep running even after you close the terminal. - Open Formbricks in Your Browser Once the setup is running, open http://localhost:3000 in your browser to access Formbricks. The first time you visit, you’ll see a setup wizard. Follow the steps to create your first user and start using Formbricks.
Update
Please take a look at our migration guide for version specific steps to update Formbricks.-
Pull the latest Formbricks image
-
Stop the Formbricks stack
-
Re-start the Formbricks stack with the updated image
Debug
If you encounter any issues, you can check the logs of the container with this command:CTRL + C
.
Customizing environment variablesTo edit any of the available environment variables, check out our Configuration section!