Skip to content
Huell

Installation

Requirements

Section titled “Requirements”
  • A Linux server
  • Docker, with the Docker Compose plugin (docker compose version should work)
  • A domain you control DNS for

Deploy

Section titled “Deploy”
Terminal window
git clone <this-repo> huell && cd huell
./setup.sh

The first run creates .env from .env.example and stops there — fill it in before continuing. See Configuration for what each variable does.

Terminal window
./setup.sh

The second run builds the images, applies database migrations, and starts everything.

DNS

Section titled “DNS”

Before your first real sign-in, point DNS at your server:

Dashboard host

Whatever host you set in DASHBOARD_URL → your server’s IP.

Project subdomains

A wildcard record for *.docs.<ORG_DOMAIN> → your server’s IP. Every project gets <slug>.docs.<ORG_DOMAIN> automatically once this resolves.

First sign-in

Section titled “First sign-in”

Open the dashboard and sign in with Google. The first person to sign in becomes org admin — there’s no separate setup step for this.

From there:

  1. Settings → GitHub — click “Create GitHub App” (a one-click flow; no manual GitHub App setup)
  2. New project — connect a repo, or upload a docs.zip
  3. Push to the connected branch (or re-upload) to trigger a rebuild