Docroot

MVP Release

This is an early MVP release. The API, file layout, and configuration keys may change between releases without a compatibility guarantee. Review the changelog before upgrading.

Docroot is a lightweight, self-hosted documentation host. Upload versioned documentation archives (ZIP files containing index.html) and browse them through a web UI or REST API.

Installation

Create a docker-compose.yml and start the stack:

services:
  api:
    image: ghcr.io/exhuma/docroot/backend:latest
    environment:
      DOCROOT_API_DATA_ROOT: /data
      DOCROOT_API_OAUTH_JWKS_URL: "https://your-idp/jwks.json"
      DOCROOT_API_OAUTH_AUDIENCE: "docroot-api"
    volumes:
      - docroot_data:/data
  web:
    image: ghcr.io/exhuma/docroot/nginx:latest
    ports:
      - "80:80"
    environment:
      DOCROOT_WEB_OIDC_ISSUER: "https://your-idp"
      DOCROOT_WEB_OIDC_CLIENT_ID: "docroot-web"
    volumes:
      - docroot_data:/data
volumes:
  docroot_data:

docker compose up -d

Open http://localhost in a browser.

See Operator Manual for all environment variables and provider-specific OIDC configuration guides.

Who Are You?