Skip to main content

​
Local Machine Setup - Linux

This guide is recommended for advanced users setting up Formbricks on a Linux machine.
Here are the requirements for setting up Formbricks on Linux:
  • Node.JS (v20 recommended)
  • pnpm
  • Docker (to run PostgreSQL/MailHog)
Steps:
  1. Clone the project & move into the directory: 
    git clone https://github.com/formbricks/formbricks && cd formbricks
  2. Setup NodeJS with nvm: 
    nvm install && nvm use
  3. Install NodeJS packages via pnpm: 
    pnpm install
  4. Create a .env file based on .env.example: 
    cp .env.example .env
  5. Generate & set the secret values: 
    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. Generate the Next.js AGENTS.md file (optional, for AI-assisted development): This step generates an AGENTS.md file at the repository root that provides Next.js documentation context for AI coding assistants (e.g. Cursor, GitHub Copilot). It runs npx @next/codemod agents-md under the hood. Re-run it whenever you upgrade Next.js. 
    pnpm agents:update
  7. Start the development setup: 
    pnpm go
You can now access Formbricks at http://localhost:3000.
Create a new account on first login as no default account is available.