With Formbricks 3.0, we introduced an automatic data migration system. If you're using a version older than **v2.7**, you must upgrade step-by-step through earlier versions (e.g. **2.4 → 2.5 → 2.6 → 2.7**). Once you reach **v2.7**, you can upgrade directly to **any v3.x or future release** without needing intermediate migrations.
With Formbricks 3.0, we introduced an automatic data migration system. If you're using a version older than
**v2.7**, you must upgrade step-by-step through earlier versions (e.g. **2.4 → 2.5 → 2.6 → 2.7**). Once you
reach **v2.7**, you can upgrade directly to **any v3.x or future release** without needing intermediate
migrations.
</Info>
### Steps to Migrate
@@ -18,11 +21,12 @@ Before running these steps, **navigate to the `formbricks` directory** where you
1. **Backup your Database**: Backing up your database is crucial before upgrading. Use the following command to create a backup:
If you run into “**No such container**”, use`docker ps`to find your container name, e.g.`formbricks_postgres_1`.
If you run into “**No such container**”, use`docker ps`to find your container name,
e.g.`formbricks_postgres_1`.
</Info>
If you prefer storing the backup as an `*.sql` file remove the `-Fc` (custom format) option. In case of a restore scenario you will need to use `psql` then with an empty `formbricks` database.
@@ -47,7 +51,61 @@ docker compose up -d
When you start the latest version of **Formbricks**, it will **automatically detect and apply any required data migrations** during startup. You don’t need to run any manual migration steps or download separate migration images.
* Access your updated instance
- Access your updated instance
Once the containers are running, simply go to the **same URL** as before to access your updated **Formbricks** instance.
That’s it! This new process ensures your **Formbricks** setup stays up to date with the latest schema changes as soon as you run the updated container.
### v3.1
<Info>
With Formbricks 3.0, we introduced an automatic data migration system. If you're using a version older than
**v2.7**, you must upgrade step-by-step through earlier versions (e.g. **2.4 → 2.5 → 2.6 → 2.7**). Once you
reach **v2.7**, you can upgrade directly to **any v3.x or future release** without needing intermediate
migrations.
</Info>
### Steps to Migrate
This guide is for users who are **self-hosting Formbricks** using the **one-click setup**. If you have a different setup, you may need to adjust the commands accordingly.
Before running these steps, **navigate to the `formbricks` directory** where your `docker-compose.yml` file is located.
1. **Backup your Database**: Backing up your database is crucial before upgrading. Use the following command to create a backup:
If you run into “**No such container**”, use`docker ps`to find your container name,
e.g.`formbricks_postgres_1`.
</Info>
If you prefer storing the backup as an `*.sql` file remove the `-Fc` (custom format) option. In case of a restore scenario you will need to use `psql` then with an empty `formbricks` database.
1. Pull the latest version of Formbricks:
```bash
docker compose pull
```
1. Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
1. Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
When you start the latest version of **Formbricks**, it will **automatically detect and apply any required data migrations** during startup. You don’t need to run any manual migration steps or download separate migration images.
- Access your updated instance
Once the containers are running, simply go to the **same URL** as before to access your updated **Formbricks** instance.
@@ -58,28 +116,27 @@ That’s it! This new process ensures your **Formbricks** setup stays up to date
<Warning>
**Important: Do Not Upgrade to 3.0 If You Need SSO, User Identification, or Cluster Support**
With **Formbricks 3.0**, we're making changes to ensure long-term sustainability while still supporting open source. While the **Community Edition** has gained [new features](https://formbricks.com/blog/formbricks-3-0), some [advanced capabilities](https://formbricks.com/docs/self-hosting/license) are now part of the **Enterprise Edition**.
With **Formbricks 3.0**, we're making changes to ensure long-term sustainability while still supporting open source. While the **Community Edition** has gained [new features](https://formbricks.com/blog/formbricks-3-0), some [advanced capabilities](https://formbricks.com/docs/self-hosting/license) are now part of the **Enterprise Edition**.
⚠️ **No Downgrade Option:** If you upgrade to **3.0** and run the data migration, **you cannot revert to 2.7.2**. If you rely on **SSO, user identification, or cluster support**, either **stay on version 2.7.x** or [reach out](https://formbricks.com/cdn-cgi/l/email-protection#1e7671727f5e78716c737c6c777d756d307d7173) **for a custom quote**.
⚠️ **No Downgrade Option:** If you upgrade to **3.0** and run the data migration, **you cannot revert to 2.7.2**. If you rely on **SSO, user identification, or cluster support**, either **stay on version 2.7.x** or [reach out](https://formbricks.com/cdn-cgi/l/email-protection#1e7671727f5e78716c737c6c777d756d307d7173) **for a custom quote**.
</Warning>
This major release brings a better approach to **data migrations**.
* If you're using **Formbricks v2.7 or later**, you can upgrade **directly** to **v3.x** and future versions.
- If you're using **Formbricks v2.7 or later**, you can upgrade **directly** to **v3.x** and future versions.
* If you're on a version **older than v2.7**, you **must upgrade step-by-step** (e.g. **2.4 → 2.5 → 2.6 → 2.7**) before moving to v3.x.
- If you're on a version **older than v2.7**, you **must upgrade step-by-step** (e.g. **2.4 → 2.5 → 2.6 → 2.7**) before moving to v3.x.
### Steps to Migrate
This guide is for users **self-hosting** Formbricks with the **one-click setup**. If you're using a different setup, you may need to adjust the commands.
*  Navigate to the Formbricks Directory
-  Navigate to the Formbricks Directory
Before running any steps, go to the directory where your `docker-compose.yml` file is located.
* Backup Your Database
- Backup Your Database
Backing up your database is **crucial** before upgrading. Use the following command to create a backup:
**Note:** If you see a “No such container” error, run `docker ps` to find your actual container name (e.g. `formbricks_postgres_1`).
**Note:** If you see a “No such container” error, run `docker ps` to find your actual container name (e.g.
`formbricks_postgres_1`).
</Info>
<Info>
Tip: If you want to store the backup as a `.sql` file, remove the `-Fc` (custom format) option. If you need to restore it later, use `psql` with an empty Formbricks database.
Tip: If you want to store the backup as a `.sql` file, remove the `-Fc` (custom format) option. If you need
to restore it later, use `psql` with an empty Formbricks database.
</Info>
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
@@ -116,7 +175,7 @@ docker compose up -d
When you start the latest version of Formbricks, it will automatically detect and run any necessary data migrations during startup. There is no need to run any manual migration steps or pull any separate migration images.
* Access your updated instance
- Access your updated instance
That’s it! Once the containers are up and running, simply navigate to the same URL as before to access your fully migrated Formbricks instance.
@@ -125,7 +184,8 @@ That’s it! Once the containers are up and running, simply navigate to the same
<Info>
AI Features & Database Update: This release lays the groundwork for upcoming AI features, now in private beta. Formbricks requires the `pgvector` extension in PostgreSQL.
One-Click Setup Users: Use the `pgvector/pgvector:pg15` image instead of `postgres:15-alpine` to ensure compatibility.
One-Click Setup Users: Use the `pgvector/pgvector:pg15` image instead of `postgres:15-alpine` to ensure compatibility.
</Info>
Formbricks v2.7 includes all the features and improvements developed by the community during Hacktoberfest 2024. Additionally, this release introduces an advanced team-based access control system, which is available in the Formbricks Enterprise Edition.
@@ -140,21 +200,23 @@ This guide is for users who are self-hosting Formbricks using our one-click setu
To run all these steps, please navigate to the Formbricks folder where your `docker-compose.yml` file is located.
* **Backup your Database:** This is a crucial step. Please make sure to backup your database before proceeding with the upgrade. You can use the following command to backup your database. 
- **Backup your Database:** This is a crucial step. Please make sure to backup your database before proceeding with the upgrade. You can use the following command to backup your database. 
If you run into “No such container”, use`docker ps`to find your container name, e.g.`formbricks_postgres_1`.
If you run into “No such container”, use`docker ps`to find your container name,
e.g.`formbricks_postgres_1`.
</Note>
<Note>
If you want to store the backup as an \*.sql file, remove the `-Fc` option. To restore, use `psql` with an empty Formbricks database.
If you want to store the backup as an \*.sql file, remove the `-Fc` option. To restore, use `psql` with an
empty Formbricks database.
</Note>
* If you use an older `docker-compose.yml` file from the one-click setup, modify it to use the `pgvector/pgvector:pg15` image instead of `postgres:15-alpine`:
- If you use an older `docker-compose.yml` file from the one-click setup, modify it to use the `pgvector/pgvector:pg15` image instead of `postgres:15-alpine`:
```yaml
services:
@@ -170,29 +232,27 @@ services:
- 5432:5432
```
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance and remove the related containers:
- Stop the running Formbricks instance and remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Tip>
To find the Docker network name for your Postgres database, run `docker network ls`.
</Tip>
<Tip>To find the Docker network name for your Postgres database, run `docker network ls`.</Tip>
The command above will migrate your data to the latest schema. This step is important to update your existing data to the new structure. The changes will only be made if the script runs successfully. You can run the script multiple times safely.
* That's it! Once the migration is finished, you can **access your Formbricks instance** at the same URL as before.
- That's it! Once the migration is finished, you can **access your Formbricks instance** at the same URL as before.
## v2.6
Formbricks v2.6 introduces advanced logic jumps for surveys, allowing more complex branching logic, including variables, conditions, and more. This release also includes numerous bug fixes, significant performance improvements for website and app surveys, and enhanced stability.
<Info>
This release includes the final step of deprecating server-side action tracking (previously used for segment filtering by performed actions). The migrations will delete all tracked actions from the database. If you still need these action records, ensure you export them before upgrading.
This release includes the final step of deprecating server-side action tracking (previously used for segment
filtering by performed actions). The migrations will delete all tracked actions from the database. If you
still need these action records, ensure you export them before upgrading.
</Info>
### Steps to Migrate
@@ -222,43 +284,43 @@ This guide is for users who are self-hosting Formbricks using our one-click setu
To run these steps, navigate to the folder where your `docker-compose.yml` file is located.
* **Backup your Database:** This is an important step. Make sure to back up your database before proceeding with the upgrade. You can use this command to back up your database:
- **Backup your Database:** This is an important step. Make sure to back up your database before proceeding with the upgrade. You can use this command to back up your database:
If you get a "No such container" error, run `docker ps` to find your container name, for example, `formbricks_postgres_1`.
If you get a "No such container" error, run `docker ps` to find your container name, for example,
`formbricks_postgres_1`.
</Info>
<Info>
If you prefer storing the backup as an`*.sql`file remove the`-Fc`(custom format) option. In case of a restore scenario, you will need to use`psql`then with an empty`formbricks`database.
If you prefer storing the backup as an`*.sql`file remove the`-Fc`(custom format) option. In case of a
restore scenario, you will need to use`psql`then with an empty`formbricks`database.
</Info>
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Info>
To find the Docker network name for your Postgres database, run the command:
</Info>
<Info>To find the Docker network name for your Postgres database, run the command:</Info>
The command above will migrate your data to the latest schema. This is an important step to update your existing data to the new structure. Changes will only be made if the script runs successfully. You can run the script multiple times without issues.
* Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
- Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
## v2.5
Formbricks v2.5 lets you visualise responses in a data table format. This release also brings a few bug fixes and performance improvements.
<Info>
This release fixes the inconsistency of CTA and consent question values when a question is skipped. The value will now be set to an empty string instead of "dismissed" to maintain consistency with other questions.
This release fixes the inconsistency of CTA and consent question values when a question is skipped. The
value will now be set to an empty string instead of "dismissed" to maintain consistency with other
questions.
</Info>
### Steps to Migrate
@@ -287,43 +351,43 @@ This guide is for users self-hosting Formbricks with our one-click setup. If you
To begin, navigate to the folder where your `docker-compose.yml` file is located.
* **Backup your Database**: This step is important. Please make sure to back up your database before upgrading. You can use the following command to back up your database:
- **Backup your Database**: This step is important. Please make sure to back up your database before upgrading. You can use the following command to back up your database:
If you run into “No such container”, use `docker ps` to find your container name, e.g.`formbricks_postgres_1`.
If you run into “No such container”, use `docker ps` to find your container name,
e.g.`formbricks_postgres_1`.
</Info>
<Info>
If you prefer storing the backup as an`*.sql`file remove the`-Fc`(custom format) option. In case of a restore scenario you will need to use`psql`then with an empty`formbricks`database.
If you prefer storing the backup as an`*.sql`file remove the`-Fc`(custom format) option. In case of a
restore scenario you will need to use`psql`then with an empty`formbricks`database.
</Info>
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Info>
To find your Docker Network name for your Postgres Database, find it using `docker network ls`
</Info>
<Info>To find your Docker Network name for your Postgres Database, find it using `docker network ls`</Info>
The command will migrate your data to the latest schema, ensuring your existing data is updated to the new structure. Changes will only be made if the script runs successfully, and you can safely run the script multiple times.
* Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
- Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
## v2.4
Formbricks v2.4 lets you create multiple endings for your surveys and choose which one users see based on logic jumps. This version also includes bug fixes and performance improvements.
<Info>
This release will remove support for advanced targeting (enterprise targeting for app surveys) using actions (e.g. targeting users who triggered action x 3 times in the last month). Actions can still be used as triggers, but they will no longer be stored on the server to improve Formbricks' overall performance.
This release will remove support for advanced targeting (enterprise targeting for app surveys) using actions
(e.g. targeting users who triggered action x 3 times in the last month). Actions can still be used as
triggers, but they will no longer be stored on the server to improve Formbricks' overall performance.
If you run into “No such container”, use`docker ps`to find your container name, e.g.`formbricks_postgres_1`.
If you run into “No such container”, use`docker ps`to find your container name,
e.g.`formbricks_postgres_1`.
</Info>
<Info>
If you prefer storing the backup as a`*.sql`file, remove the`-Fc`(custom format) option. In case of a restore scenario, you will need to use`psql`then with an empty`formbricks`database.
If you prefer storing the backup as a`*.sql`file, remove the`-Fc`(custom format) option. In case of a
restore scenario, you will need to use`psql`then with an empty`formbricks`database.
</Info>
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
@@ -399,11 +467,11 @@ docker run --rm \
The command above will migrate your data to the latest schema. This is an important step to update your data structure. Changes are only applied if the script runs successfully. You can run the script multiple times without issues.
* That's it! Once the migration is done, you can access your Formbricks instance at the same URL as before.
- That's it! Once the migration is done, you can access your Formbricks instance at the same URL as before.
### Additional Updates
* The `CRON_SECRET` environment variable is now required to enhance the security of the internal cron APIs. Please ensure that this variable is set in your environment or `docker-compose.yml`. You can generate a secure secret using `openssl rand -hex 32`
- The `CRON_SECRET` environment variable is now required to enhance the security of the internal cron APIs. Please ensure that this variable is set in your environment or `docker-compose.yml`. You can generate a secure secret using `openssl rand -hex 32`
## v2.3
@@ -412,50 +480,51 @@ Formbricks v2.3 introduces new colour options for rating questions, enhanced mul
### Steps to Migrate
<Info>
You only need to run the data migration if you have surveys set up in Chinese (`zh`). If you don't have any surveys in Chinese, you can skip the migration step.
You only need to run the data migration if you have surveys set up in Chinese (`zh`). If you don't have any
surveys in Chinese, you can skip the migration step.
</Info>
This guide is for users self-hosting Formbricks with our one-click setup. If you're using a different setup, adjust the commands as needed.
To proceed, go to the folder where your `docker-compose.yml` file is located.
* **Backup your Database**: This is a crucial step. Please make sure to backup your database before proceeding with the upgrade. You can use the following command to backup your database:
- **Backup your Database**: This is a crucial step. Please make sure to backup your database before proceeding with the upgrade. You can use the following command to backup your database:
If you run into “**No such containe**r”, use `docker ps` to find your container name, e.g. `formbricks_postgres_1`.
If you run into “**No such containe**r”, use `docker ps` to find your container name, e.g.
`formbricks_postgres_1`.
</Info>
<Info>
If you prefer storing the backup as an `*.sql` file remove the `-Fc` (custom format) option. In case of a restore scenario you will need to use `psql` then with an empty `formbricks` database.
If you prefer storing the backup as an `*.sql` file remove the `-Fc` (custom format) option. In case of a
restore scenario you will need to use `psql` then with an empty `formbricks` database.
</Info>
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Info>
To find your Docker Network name for your Postgres Database, find it using `docker network ls`
</Info>
<Info>To find your Docker Network name for your Postgres Database, find it using `docker network ls`</Info>
The command above will migrate your data to the latest schema, which is essential for updating your data structure. Changes will only be made if the script runs successfully. You can safely run the script multiple times.
* Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
- Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
If you run into “No such container”, use `docker ps` to find your container name, e.g. `formbricks_postgres_1`.
If you run into “No such container”, use `docker ps` to find your container name, e.g.
`formbricks_postgres_1`.
</Info>
<Info>
If you prefer storing the backup as an`*.sql`file remove the`-Fc`(custom format) option. In case of a restore scenario you will need to use`psql`then with an empty`formbricks`database.
If you prefer storing the backup as an`*.sql`file remove the`-Fc`(custom format) option. In case of a
restore scenario you will need to use`psql`then with an empty`formbricks`database.
</Info>
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Info>
To find your Docker Network name for your Postgres Database, find it using `docker network ls`
</Info>
<Info>To find your Docker Network name for your Postgres Database, find it using `docker network ls`</Info>
The command above will migrate your data to the latest schema. This is an important step to update your existing data. Changes will only be made if the script runs successfully. You can safely run the script multiple times.
* Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
- Once the migration is complete, **you can access your Formbricks instance** at the same URL as before.
### Changes in Environment Variables
* The `ONBOARDING_DISABLED` environment variable is now deprecated. We have replaced the user onboarding with a product onboarding process that only runs when creating a new product.
- The `ONBOARDING_DISABLED` environment variable is now deprecated. We have replaced the user onboarding with a product onboarding process that only runs when creating a new product.
## v2.1
@@ -547,7 +616,8 @@ Formbricks v2.1 introduces more options for creating No-Code Actions and improve
<Info>
To improve the user experience and simplify setup for self-hosting instances, we are transitioning to a single organization model. This change allows self-hosts to manage their instance centrally and more easily control access. A new permissions system will also be introduced soon, providing more granular control over projects and resources within an organization.
If you've previously created multiple organizations, you can still switch between them in the UI, but creating new organizations will no longer be possible.
If you've previously created multiple organizations, you can still switch between them in the UI, but creating new organizations will no longer be possible.
</Info>
### Steps to Migrate
@@ -556,43 +626,43 @@ This guide is for users self-hosting Formbricks using our one-click setup. If yo
To follow these steps, please navigate to the Formbricks folder where your `docker-compose.yml` file is located.
* **Backup your Database**: This is an essential step. Please ensure that you back up your database before proceeding with the upgrade. You can use the following command to back it up:
- **Backup your Database**: This is an essential step. Please ensure that you back up your database before proceeding with the upgrade. You can use the following command to back it up:
If you run into “No such container”, use `docker ps` to find your container name, e.g. `formbricks_postgres_1`.
If you run into “No such container”, use `docker ps` to find your container name, e.g.
`formbricks_postgres_1`.
</Info>
<Info>
If you prefer storing the backup as a `*.sql` file remove the `-Fc` (custom format) option. In case of a restore scenario you will need to use `psql` then with an empty `formbricks` database.
If you prefer storing the backup as a `*.sql` file remove the `-Fc` (custom format) option. In case of a
restore scenario you will need to use `psql` then with an empty `formbricks` database.
</Info>
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers.
- Stop the running Formbricks instance & remove the related containers.
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Info>
To find your Docker network name for the Postgres database, run the following `docker network ls`
</Info>
<Info>To find your Docker network name for the Postgres database, run the following `docker network ls`</Info>
Once the migration script runs successfully, your data will be migrated to the latest schema. The script is designed to run safely multiple times, so you don’t need to worry if it’s executed more than once. After completing the migration, you can continue to access your Formbricks instance at the same URL as before.
* That's it! Once the migration is complete, you can **now access your Formbricks instance** at the same URL as before.
- That's it! Once the migration is complete, you can **now access your Formbricks instance** at the same URL as before.
### Changes in Environment Variables
* **SIGNUP\_DISABLED** is now deprecated. Self-hosting instances have signup disabled by default, and new users can only be invited by the organization owner or admin.
- **SIGNUP_DISABLED** is now deprecated. Self-hosting instances have signup disabled by default, and new users can only be invited by the organization owner or admin.
* **DEFAULT\_TEAM\_ID** has been renamed to **DEFAULT\_ORGANIZATION\_ID**.
- **DEFAULT_TEAM_ID** has been renamed to **DEFAULT_ORGANIZATION_ID**.
* **DEFAULT\_TEAM\_ROLE** has been renamed to **DEFAULT\_ORGANIZATION\_ROLE**.
- **DEFAULT_TEAM_ROLE** has been renamed to **DEFAULT_ORGANIZATION_ROLE**.
## v2.0
@@ -622,15 +692,21 @@ Formbricks v2.0 introduces significant features such as **Multi-Language Surveys
If you are upgrading to Formbricks v2.0, follow this guide to ensure a smooth migration of your existing Formbricks instance without encountering issues or build errors.
<Info>
This upgrade requires a **data migration**. Please make sure to back up your database before proceeding. Follow the steps below to upgrade your Formbricks instance to v2.0.
This upgrade requires a **data migration**. Please make sure to back up your database before proceeding.
Follow the steps below to upgrade your Formbricks instance to v2.0.
</Info>
<Info>
If you've used the Formbricks Enterprise Edition with a free beta license key, your instance will be downgraded to the Community Edition 2.0. You can find all license details on the [license page](https://formbricks.com/docs/self-hosting/license).
If you've used the Formbricks Enterprise Edition with a free beta license key, your instance will be
downgraded to the Community Edition 2.0. You can find all license details on the [license
We are moving from DockerHub to GitHub Packages for our images. If you are still pulling the images from DockerHub please change`image: formbricks/formbricks:latest`to`image:ghcr.io/formbricks/formbricks:latest`in your`docker-compose.yml`file.
We are moving from DockerHub to GitHub Packages for our images. If you are still pulling the images from
If you run into “No such container”, use`docker ps`to find your container name, e.g.`formbricks_postgres_1`.
If you run into “No such container”, use`docker ps`to find your container name,
e.g.`formbricks_postgres_1`.
</Info>
If you prefer storing the backup as an `*.sql` file remove the `-Fc` (custom format) option. In case of a restore scenario you will need to use `psql` then with an empty `formbricks` database.
* Pull the latest version of Formbricks:
- Pull the latest version of Formbricks:
```bash
docker compose pull
```
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers with the latest version of Formbricks:
- Restarting the containers with the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Info>
To find your Docker Network name for your Postgres Database, find it using `docker network ls`
</Info>
<Info>To find your Docker Network name for your Postgres Database, find it using `docker network ls`</Info>
The above command will migrate your data to the latest schema. This is a crucial step to migrate your existing data to the new structure. Only if the script runs successful, changes are made to the database. The script can safely run multiple times.
* That's it! Once the migration is complete, you can **now access your Formbricks instance** at the same URL as before.
- That's it! Once the migration is complete, you can **now access your Formbricks instance** at the same URL as before.
### App Surveys with @formbricks/js
@@ -702,7 +777,6 @@ formbricks.init({
apiHost: "<api-host>",
userId: "<user-id>", // optional
});
```
**New approach:** (v2.0.0)
@@ -717,7 +791,6 @@ formbricks.init({
apiHost: "<api-host>",
// userId is not supported here
});
```
App surveys:
@@ -730,7 +803,6 @@ formbricks.init({
apiHost: "<api-host>",
userId: "<user-id>", // required
});
```
## v1.6
@@ -738,7 +810,8 @@ formbricks.init({
Formbricks v1.6 introduces key features like Advanced Targeting, Segmentation, on-the-fly survey triggers, and stability improvements. This update also changes some environment variables. Follow this guide to upgrade your Formbricks instance to v1.6 smoothly.
<Info>
This upgrade requires a data migration. Ensure you back up your database before proceeding. Follow the steps below to upgrade your Formbricks instance to v1.6.
This upgrade requires a data migration. Ensure you back up your database before proceeding. Follow the steps
below to upgrade your Formbricks instance to v1.6.
</Info>
### Steps to Migrate
@@ -747,37 +820,37 @@ This guide is for users self-hosting Formbricks with our one-click setup. If you
Navigate to the Formbricks folder containing your `docker-compose.yml` file to run the steps.
* **Backup your Database**: This is a crucial step. Please make sure to backup your database before proceeding with the upgrade. You can use the following command to backup your database:
- **Backup your Database**: This is a crucial step. Please make sure to backup your database before proceeding with the upgrade. You can use the following command to backup your database:
If you run into “No such container”, use`docker ps`to find your container name, e.g.`formbricks_postgres_1`.
If you run into “No such container”, use`docker ps`to find your container name,
e.g.`formbricks_postgres_1`.
</Info>
<Info>
If you prefer storing the backup as a`*.sql`file remove the`-Fc`(custom format) option. In case of a restore scenario you will need to use`psql`then with an empty`formbricks`database.
If you prefer storing the backup as a`*.sql`file remove the`-Fc`(custom format) option. In case of a
restore scenario you will need to use`psql`then with an empty`formbricks`database.
</Info>
* Stop the running Formbricks instance & remove the related containers:
- Stop the running Formbricks instance & remove the related containers:
```bash
docker compose down
```
* Restarting the containers will automatically pull the latest version of Formbricks:
- Restarting the containers will automatically pull the latest version of Formbricks:
```bash
docker compose up -d
```
* Now let's migrate the data to the latest schema:
- Now let's migrate the data to the latest schema:
<Info>
To find your Docker Network name for your Postgres Database, find it using `docker network ps`
</Info>
<Info>To find your Docker Network name for your Postgres Database, find it using `docker network ps`</Info>
@@ -870,17 +942,17 @@ Please note that their values and the logic remains exactly the same. Only the p
### Deprecated Environment Variables
* **`NEXT_PUBLIC_VERCEL_URL`**: Was used as Vercel URL (used instead of `WEBAPP_URL)`, but from v1.1, you can just set the `WEBAPP_URL` environment variable to your Vercel URL.
- **`NEXT_PUBLIC_VERCEL_URL`**: Was used as Vercel URL (used instead of `WEBAPP_URL)`, but from v1.1, you can just set the `WEBAPP_URL` environment variable to your Vercel URL.
* **`RAILWAY_STATIC_URL`**: Was used as Railway Static URL (used instead of `WEBAPP_URL`), but from v1.1, you can just set the `WEBAPP_URL` environment variable.
- **`RAILWAY_STATIC_URL`**: Was used as Railway Static URL (used instead of `WEBAPP_URL`), but from v1.1, you can just set the `WEBAPP_URL` environment variable.
* **`RENDER_EXTERNAL_URL`**: Was used as an external URL to Render (used instead of `WEBAPP_URL`), but from v1.1, you can just set the `WEBAPP_URL` environment variable.
- **`RENDER_EXTERNAL_URL`**: Was used as an external URL to Render (used instead of `WEBAPP_URL`), but from v1.1, you can just set the `WEBAPP_URL` environment variable.
* **`HEROKU_APP_NAME`**: Was used to build the App name on a Heroku hosted webapp, but from v1.1, you can just set the `WEBAPP_URL` environment variable.
- **`HEROKU_APP_NAME`**: Was used to build the App name on a Heroku hosted webapp, but from v1.1, you can just set the `WEBAPP_URL` environment variable.
* **`NEXT_PUBLIC_WEBAPP_URL`**: Was used for the same purpose as `WEBAPP_URL`, but from v1.1, you can just set the `WEBAPP_URL` environment variable.
- **`NEXT_PUBLIC_WEBAPP_URL`**: Was used for the same purpose as `WEBAPP_URL`, but from v1.1, you can just set the `WEBAPP_URL` environment variable.
* **`PRISMA_GENERATE_DATAPROXY`**: Was used to tell Prisma that it should generate the runtime for Dataproxy usage. But its officially deprecated now.
- **`PRISMA_GENERATE_DATAPROXY`**: Was used to tell Prisma that it should generate the runtime for Dataproxy usage. But its officially deprecated now.
### Helper Shell Script
@@ -953,8 +1025,7 @@ x-environment: &environment
# GOOGLE_AUTH_ENABLED:
# GOOGLE_CLIENT_ID:
# GOOGLE_CLIENT_SECRET:
```
If you have any questions or require help, feel free to reach out to us on[**GitHub Discussions**](https://github.com/formbricks/formbricks/discussions). 😃[
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Matti Nannt