Skip to content
Hibouhibou

Quick Start

Prerequisites

Section titled “Prerequisites”
  • Docker & Docker Compose
  • Git
  • Make, Go 1.26.9+, Node.js 22+ (the devcontainer provides them)

One command

Section titled “One command”

The fastest way to a running instance with sample data:

  1. Clone the repository

    Terminal window
    git clone https://github.com/hibouhq/hibou.git
    cd hibou

  2. Copy the environment file

    Terminal window
    cp .env.example .env

  3. Start everything

    Terminal window
    make start-quick

    This starts PostgreSQL, seeds sample organizations, repositories and findings, builds the Vue UI, and runs the API and Vite dev server together.

The UI is available at http://localhost:3000 and the API at http://localhost:8585. On the login page, click Dev Login to sign in as a local admin.

Step by step

Section titled “Step by step”

Prefer to run each stage yourself?

Command What it does
make up Start PostgreSQL only (Docker Compose)
make setup make up + seed sample data
make dev Build the dev binary and run the API + Vite with hot reload
make seed / make reset Re-seed / drop and re-seed the database
Terminal window
make setup   # postgres + sample data
make dev     # run the app

With Forgejo OAuth

Section titled “With Forgejo OAuth”

To exercise the full forge OAuth flow against a local Forgejo instance:

Terminal window
make up-all       # postgres + Forgejo + Trivy
make setup-full   # provision Forgejo admin + OAuth2 app, write creds to .env
make dev

make start rolls the full OAuth setup, real seed data, and make dev into a single command.

Development Login

Section titled “Development Login”

When no forge providers are configured (or for quick local development), Hibou exposes a Dev Login button on the login page. This creates a local admin user without requiring OAuth2.

Next Steps

Section titled “Next Steps”