feat: new documentation (#4735)

This commit is contained in:
Matti Nannt
2025-02-13 21:25:12 +01:00
committed by GitHub
parent 22e8a137ef
commit f6ef3ba7c5
477 changed files with 16955 additions and 0 deletions
@@ -0,0 +1,55 @@
---
title: GitHub Codespaces
description: How to set up Formbricks in a GitHub Codespaces environment
icon: "github"
---
### GitHub Codespaces Setup
<Info>
This guide outlines how to set up Formbricks in a **GitHub Codespaces** environment.
</Info>
**Requirements:**
- A GitHub Codespace that has support for Node.JS, pnpm, and Docker.
**Steps:**
1. **Open your repository in GitHub Codespaces. If needed, clone the repository:**
```bash
git clone https://github.com/formbricks/formbricks && cd formbricks
```
2. **Setup NodeJS with nvm (if not already configured):**
```bash
nvm install && nvm use
```
3. **Install the dependencies:**
```bash
pnpm install
```
4. **Create a `.env` file from the template:**
```bash
cp .env.example .env
```
5. **Generate & set the required secrets:**
```bash
sed -i '/^ENCRYPTION_KEY=/c\ENCRYPTION_KEY='$(openssl rand -hex 32) .env
sed -i '/^NEXTAUTH_SECRET=/c\NEXTAUTH_SECRET='$(openssl rand -hex 32) .env
sed -i '/^CRON_SECRET=/c\CRON_SECRET='$(openssl rand -hex 32) .env
```
6. **Launch the development setup:**
```bash
pnpm go
```
Use the Codespaces port forwarding to access Formbricks at [http://localhost:3000](http://localhost:3000).
<Tip>
Make sure your Codespaces port configuration is set to allow access to the app.
</Tip>
+55
View File
@@ -0,0 +1,55 @@
---
title: Gitpod
description: How to set up Formbricks in a Gitpod workspace
icon: "code"
---
### Gitpod Setup
<Info>
This guide explains how to set up Formbricks in a **Gitpod** workspace.
</Info>
**Requirements:**
- A Gitpod workspace with Node.JS, pnpm, and Docker support.
**Steps:**
1. **Open the repository in Gitpod. The workspace typically clones the repo automatically. If not:**
```bash
git clone https://github.com/formbricks/formbricks && cd formbricks
```
2. **Setup NodeJS with nvm:**
```bash
nvm install && nvm use
```
3. **Install dependencies:**
```bash
pnpm install
```
4. **Create a `.env` file:**
```bash
cp .env.example .env
```
5. **Generate & set secret values:**
```bash
sed -i '/^ENCRYPTION_KEY=/c\ENCRYPTION_KEY='$(openssl rand -hex 32) .env
sed -i '/^NEXTAUTH_SECRET=/c\NEXTAUTH_SECRET='$(openssl rand -hex 32) .env
sed -i '/^CRON_SECRET=/c\CRON_SECRET='$(openssl rand -hex 32) .env
```
6. **Run the development setup:**
```bash
pnpm go
```
Access the running app via the forwarded port (typically [http://localhost:3000](http://localhost:3000) inside Gitpod).
<Tip>
Check your Gitpod settings to ensure Docker is enabled if required.
</Tip>
+57
View File
@@ -0,0 +1,57 @@
---
title: Linux
description: How to set up Formbricks on a Linux machine
icon: "linux"
---
### Local Machine Setup - Linux
<Info>
This guide is recommended for advanced users setting up Formbricks on a **Linux** machine.
</Info>
Here are the requirements for setting up Formbricks on Linux:
- Node.JS (v20 recommended)
- [pnpm](https://pnpm.io/)
- [Docker](https://www.docker.com/) (to run PostgreSQL/MailHog)
**Steps:**
1. **Clone the project & move into the directory:**
```bash
git clone https://github.com/formbricks/formbricks && cd formbricks
```
2. **Setup NodeJS with nvm:**
```bash
nvm install && nvm use
```
3. **Install NodeJS packages via pnpm:**
```bash
pnpm install
```
4. **Create a `.env` file based on `.env.example`:**
```bash
cp .env.example .env
```
5. **Generate & set the secret values:**
```bash
sed -i '/^ENCRYPTION_KEY=/c\ENCRYPTION_KEY='$(openssl rand -hex 32) .env
sed -i '/^NEXTAUTH_SECRET=/c\NEXTAUTH_SECRET='$(openssl rand -hex 32) .env
sed -i '/^CRON_SECRET=/c\CRON_SECRET='$(openssl rand -hex 32) .env
```
6. **Start the development setup:**
```bash
pnpm go
```
You can now access Formbricks at [http://localhost:3000](http://localhost:3000).
<Tip>
Create a new account on first login as no default account is available.
</Tip>
+57
View File
@@ -0,0 +1,57 @@
---
title: Mac
description: How to set up Formbricks on a Mac machine
icon: "apple"
---
### Local Machine Setup - Mac
<Info>
This guide is recommended for advanced users setting up Formbricks on a **Mac** machine.
</Info>
**Requirements:**
- Node.JS (v20 recommended)
- [pnpm](https://pnpm.io/)
- [Docker](https://www.docker.com/)
**Steps:**
1. **Clone the project & change directory:**
```bash
git clone https://github.com/formbricks/formbricks && cd formbricks
```
2. **Setup NodeJS with nvm:**
```bash
nvm install && nvm use
```
3. **Install NodeJS packages with pnpm:**
```bash
pnpm install
```
4. **Create a `.env` file from the example:**
```bash
cp .env.example .env
```
5. **Generate & set secret values (using BSD sed syntax for macOS):**
```bash
sed -i '' '/^ENCRYPTION_KEY=/s|.*|ENCRYPTION_KEY='$(openssl rand -hex 32)'|' .env
sed -i '' '/^NEXTAUTH_SECRET=/s|.*|NEXTAUTH_SECRET='$(openssl rand -hex 32)'|' .env
sed -i '' '/^CRON_SECRET=/s|.*|CRON_SECRET='$(openssl rand -hex 32)'|' .env
```
6. **Start the development setup:**
```bash
pnpm go
```
Visit [http://localhost:3000](http://localhost:3000) to access Formbricks.
<Tip>
Ensure you create a new account at first login.
</Tip>
+57
View File
@@ -0,0 +1,57 @@
---
title: Windows
description: How to set up Formbricks on a Windows machine
icon: "windows"
---
### Local Machine Setup - Windows
<Info>
This guide is intended for **Windows** users. For the best experience, use **WSL2** since pure Windows is not fully supported.
</Info>
**Requirements:**
- Node.JS (v20 recommended) via WSL2
- [pnpm](https://pnpm.io/)
- [Docker](https://www.docker.com/) (ensure Docker Desktop is installed with WSL2 integration enabled)
**Steps (Using WSL2):**
1. **Open your WSL2 terminal and clone the project:**
```bash
git clone https://github.com/formbricks/formbricks && cd formbricks
```
2. **Setup NodeJS with nvm in WSL2:**
```bash
nvm install && nvm use
```
3. **Install packages using pnpm:**
```bash
pnpm install
```
4. **Create a `.env` file:**
```bash
cp .env.example .env
```
5. **Generate & set secret values (Linux commands work in WSL2):**
```bash
sed -i '/^ENCRYPTION_KEY=/c\ENCRYPTION_KEY='$(openssl rand -hex 32) .env
sed -i '/^NEXTAUTH_SECRET=/c\NEXTAUTH_SECRET='$(openssl rand -hex 32) .env
sed -i '/^CRON_SECRET=/c\CRON_SECRET='$(openssl rand -hex 32) .env
```
6. **Start the development setup:**
```bash
pnpm go
```
Access Formbricks at [http://localhost:3000](http://localhost:3000).
<Tip>
If you run into conflicts, ensure any local services (like PostgreSQL) are stopped.
</Tip>