Skip to main content

Hesperida

Hesperida logo

Hesperida is a Docker-first, self-hosted platform for website scanning, reporting, and operations monitoring.

This documentation is the canonical entry point for architecture, deployment, API behavior, ACL, and dashboard usage.

What You Can Do​

  • Manage users, websites, jobs, and queue tasks through dashboard and API.
  • Run multi-tool scans (probe, domain, whois, ssl, seo, wcag, security, stress, mail).
  • Enforce website verification before scan execution.
  • Generate client-facing PDF reports for completed jobs.
  • Receive notifications (API-level and dashboard in-app toasts).

Start Here​

  1. Install and run Hesperida
  2. Run your first scan
  3. Review architecture
  4. Review API auth and ACL

Current Scope​

The docs currently target the current release line:

  • Dashboard CRUD and live updates
  • Multi-tenant ACL (role, group, is_superuser)
  • Website ownership transfer and membership control
  • Group-scoped shared website verification records with method tracking (dns|file)
  • Mandatory website verification gate for job creation (no verification expiry)
  • SSR HTML reports + Gotenberg PDF conversion
  • TypeScript SEO scanner implementation

Source of Truth​

  • Runtime architecture: ARCHITECTURE.md
  • Configuration and usage notes: README.md
  • Release history: CHANGELOG.md
  • Database schema: schema.surql

Support​

  • Report bugs or request features on the GitHub issue tracker.
  • Prefer linking exact routes, schema snippets, or logs in bug reports.