export const metadata = {
  title: "Step by Step Guide on Deploying Formbricks to Production on Ubuntu",
  description:
    "Master the swift deployment of Formbricks on an Ubuntu server with our step-by-step guide. Use a single command to automate Docker, Postgres DB, SSL certificate configuration, and more. Encounter issues? Dive into our troubleshooting steps or join our community on Discord for assistance.",
};

#### Self-Hosting

# One-Click Setup

<Note>This only works with an Ubuntu machine so please verify the underlying OS beforehand!</Note>

If you want to quickly set up a production instance of Formbricks on a server running Ubuntu, we've got you covered! This method utilizes a convenient shell script that takes care of everything, including **Docker**, **Postgres DB**, and **SSL certificate configuration**. The shell script will automatically install all the required dependencies and configure your server, making the process a breeze.

<Note>
  This setup installs **Traefik** to work as a **reverse proxy**. This configuration is crucial for directing
  incoming traffic to the correct container, allowing Formbricks to be accessible from the internet securely.
  Traefik is chosen for its simplicity and automatic SSL management with Let's Encrypt.
</Note>

If you want to run Formbricks on a different OS or have more control over the installation process, you can follow the [advanced installation guide with Docker](/self-hosting/docker).

### Requirements

Before you proceed, make sure you have the following:

- A **Linux Ubuntu** Virtual Machine deployed with SSH access.
- An **A record** set up to connect a custom domain to your instance. Formbricks will **automatically create an SSL certificate** for your domain using Let's Encrypt.
- **Port 80 and 443** open in your VM's Security Group to allow Traefik to create the SSL certificate.

## Start

Copy and paste the following command into your terminal:

<Col>
<CodeGroup title="Single Command to deploy Formbricks">

```bash
curl -fsSL https://raw.githubusercontent.com/formbricks/formbricks/main/docker/formbricks.sh -o formbricks.sh && chmod +x formbricks.sh && ./formbricks.sh install
```

</CodeGroup>
</Col>

The script will prompt you for the following information:

1. **Overwriting Docker GPG Keys**: If Docker GPG keys already exist, the script will ask if you want to overwrite them.

<Col>
<CodeGroup title="Docker GPG Keys Overwrite Prompt">

```bash
🧱 Welcome to the Formbricks single instance installer

🛸 Fasten your seatbelts! We're setting up your Formbricks environment on your Ubuntu 22.04.2 LTS server.

🧹 Time to sweep away any old Docker installations.
🔄 Updating your package list.
📦 Installing the necessary dependencies.
🔑 Adding Docker's official GPG key and setting up the stable repository.
File '/etc/apt/keyrings/docker.gpg' exists. Overwrite? (y/N)
```

</CodeGroup>
</Col>

2. **Email Address**: Provide your email address for SSL certificate registration with Let's Encrypt.

<Col>
<CodeGroup title="Email Prompt">

```bash
 🧱 Welcome to the Formbricks single instance installer
 🛸 Fasten your seatbelts! We're setting up your Formbricks environment on your Ubuntu 22.04.2 LTS server.

 🧹 Time to sweep away any old Docker installations.
 🔄 Updating your package list.
 📦 Installing the necessary dependencies.
 🔑 Adding Docker's official GPG key and setting up the stable repository.
 File '/etc/apt/keyrings/docker.gpg' exists. Overwrite? (y/N) y
 🔄 Updating your package list again.
 🐳 Installing Docker.
 🚀 Testing your Docker installation.
 🎉 Docker is installed!
 🐳 Adding your user to the Docker group to avoid using sudo with docker commands.
 🎉 Hooray! Docker is all set and ready to go. Youre now ready to run your Formbricks instance!
 🚗 Installing Traefik...
 📁 Created Formbricks Quickstart directory at ./formbricks.
 💡 Please enter your email address for the SSL certificate:
```

</CodeGroup>
</Col>

3. **Domain Name**: Enter the domain name that Traefik will use to create the SSL certificate and forward requests to Formbricks. Please make sure that port 80 and 443 are open in your VM's Security Group to allow Traefik to create the SSL certificate.

<Col>
<CodeGroup title="Domain Name for SSL certificate Prompt">

```bash
🧱 Welcome to the Formbricks single instance installer

🛸 Fasten your seatbelts! We're setting up your Formbricks environment on your Ubuntu 22.04.2 LTS server.

🧹 Time to sweep away any old Docker installations.
🔄 Updating your package list.
📦 Installing the necessary dependencies.
🔑 Adding Dockers official GPG key and setting up the stable repository.
File '/etc/apt/keyrings/docker.gpg' exists. Overwrite? (y/N) y
🔄 Updating your package list again.
🐳 Installing Docker.
🚀 Testing your Docker installation.
🎉 Docker is installed!
🐳 Adding your user to the Docker group to avoid using sudo with docker commands.
🎉 Hooray! Docker is all set and ready to go. You're now ready to run your Formbricks instance!
🚗 Installing Traefik...
📁 Created Formbricks Quickstart directory at ./formbricks.
💡 Please enter your email address for the SSL certificate:
docs@formbricks.com
💡 Created traefik.yaml file with your provided email address.
💡 Created acme.json file with correct permissions.
🔗 Please enter your domain name for the SSL certificate (🚨 do NOT enter the protocol (http/https/etc)):
```

</CodeGroup>
</Col>

**That's it**! After running the command and providing the required information, visit the domain name you entered, and you should see the Formbricks home wizard!

<Col>
<CodeGroup title="Successfully setup Formbricks on your Ubuntu machine">

```bash
🧱 Welcome to the Formbricks single instance installer

🛸 Fasten your seatbelts! Were setting up your Formbricks environment on your Ubuntu 22.04.2 LTS server.

🧹 Time to sweep away any old Docker installations.
🔄 Updating your package list.
📦 Installing the necessary dependencies.
🔑 Adding Dockers official GPG key and setting up the stable repository.
File '/etc/apt/keyrings/docker.gpg' exists. Overwrite? (y/N) y
🔄 Updating your package list again.
🐳 Installing Docker.
🚀 Testing your Docker installation.
🎉 Docker is installed!
🐳 Adding your user to the Docker group to avoid using sudo with docker commands.
🎉 Hooray! Docker is all set and ready to go. Youre now ready to run your Formbricks instance!
🚗 Installing Traefik...
📁 Created Formbricks Quickstart directory at ./formbricks.
💡 Please enter your email address for the SSL certificate:
docs@formbricks.com
💡 Created traefik.yaml file with your provided email address.
💡 Created acme.json file with correct permissions.
🔗 Please enter your domain name for the SSL certificate (🚨 do NOT enter the protocol (http/https/etc)):
my.hosted.url.com
🚙 Updating NEXTAUTH_SECRET in the Formbricks container...
🚗 NEXTAUTH_SECRET updated successfully!
[+] Running 4/4
✔ Network formbricks_default         Created                                                                                                                                                                                           0.1s
✔ Container formbricks-postgres-1    Started                                                                                                                                                                                           0.5s
✔ Container formbricks-formbricks-1  Started                                                                                                                                                                                           0.7s
✔ Container traefik                  Started                                                                                                                                                                                           1.1s
🚨 Make sure you have set up the DNS records as well as inbound rules for the domain name and IP address of this instance.

🎉 All done! Check the status of Formbricks & Traefik with 'cd formbricks && sudo docker compose ps.'
```

</CodeGroup>
</Col>

## Update

To update Formbricks, simply run the following command:

<Col>
<CodeGroup title="Update Formbricks">

```bash
./formbricks.sh update
```

</CodeGroup>
</Col>

The script will automatically pull the latest version of Formbricks from GitHub Container Registry and restart the containers.

## Stop

To stop Formbricks, simply run the following command:

<Col>
<CodeGroup title="Stop Formbricks">

```bash
./formbricks.sh stop
```

</CodeGroup>
</Col>

The script will automatically stop all the Formbricks related containers and brings the entire stack down.

## Restart

To restart Formbricks, simply run the following command:

<Col>
<CodeGroup title="Restart Formbricks">

```bash
./formbricks.sh restart
```

</CodeGroup>
</Col>

The script will automatically restart all the Formbricks related containers and brings the entire stack up with the previous configuration.

## Uninstall

To uninstall Formbricks, simply run the following command, but keep in mind that this will delete all your data!

<Col>
<CodeGroup title="Uninstall Formbricks">

```bash
./formbricks.sh uninstall
```

</CodeGroup>
</Col>

The script will automatically stop all the Formbricks related containers, remove the Formbricks directory, and delete the Docker network.

## Debug

If you encounter any issues, you can check the logs of the containers with:

<Col>
<CodeGroup title="Check logs of the container">

```bash
./formbricks.sh logs
```

</CodeGroup>
</Col>

## Troubleshooting

If you encounter any issues, consider the following steps:

- **Inbound Rules**: Make sure you have added inbound rules for Port 80 and 443 in your VM's Security Group.

- **A Record**: Verify that you have set up an A record for your domain, pointing to your VM's IP address.

- **Check Docker Instances**: Run `docker ps` to check the status of the Docker instances.

- **Check Formbricks Logs**: Run `cd formbricks && docker compose logs` to check the logs of the Formbricks stack.
