Quick Start: Run Pentographer Locally

This guide gets a local Pentographer instance running in minutes. It uses the development server and a local SQLite database — suitable for evaluation and development, not production use.

For production, choose one of these paths instead:

• Managed cloud: Getting Started with Pentographer Cloud — no infrastructure to manage.
• Your own server: Self-Hosting Pentographer — Docker Compose deployment with PostgreSQL.

Running Locally

Clone the repository and install dependencies using pnpm:

$ git clone https://github.com/lswartsenburg/pentographer.git
$ cd pentographer
$ cp .env.example .env.local

Open .env.local and set a random string for NEXTAUTH_SECRET.

Database Migrations

Pentographer uses Drizzle ORM. Run the seed script to set up migrations and default system playbooks:

$ pnpm install
$ pnpm db:migrate
$ pnpm db:seed

[!NOTE] The seed command creates the default OWASP Top 10 (2021) system playbook. This playbook is required for linking findings to test items during your audits.

Starting the Server

Run the local development server:

$ pnpm dev

Open http://localhost:3000 in your browser.

Next Steps

1. Create your administrator account on the signup page.
2. Visit Organization settings to invite team members.