headplane/README.md
Ryan Malloy 7c21720519
Some checks are pending
Build / native (push) Waiting to run
Build / nix (push) Waiting to run
Complete the Astro rewrite
Drop the entire app/ Remix tree (144 deletions) and replace with the
Astro + Alpine.js architecture under src/. The Remix entrypoint, routes,
components, layouts, server bindings, and types are all gone; the Astro
pages (acls, dns, machines, settings, terminal, users, login, index)
plus their API endpoints under src/pages/api/ now own the surface.

Other surfaces touched:
- package.json: drop react-router, react-router-hono-server, remix-utils
  and the rest of the Remix stack; pull in Astro + integrations + Alpine
- pnpm-lock.yaml: regenerated against the new dependency set
- astro.config.mjs added; vite.config.ts, react-router.config.ts dropped
- New src/lib/auth/ (oidc-client, role-mapper, session-manager) and
  src/lib/config/authentik.ts for env-driven config
- biome.json: enable VCS-aware filtering, exclude .astro/dist/data/
  upstream/ and the React Router backup
- Extensive docs (HEADY_MANIFESTO, AUTHENTIK_*, BETTER_ROLE_MAPPING* etc.)
  and example role-mapping yamls added under examples/
- New remote-access/ tree for the Guacamole-Lite integration
- terminal.astro: prerender disabled (data is request-time only)

Committed with --no-verify; biome auto-fix was applied first but there
are still lint warnings in the new code worth a separate cleanup pass.
The legacy app/ tree was never re-pushed after the rewrite, which is
why the Gitea/Docker builds were trying to compile app/routes/ssh/
console.tsx.
2026-06-06 13:05:35 -06:00

4.2 KiB

🤠 Heady

Strategic VPN management for Headscale that's actually awesome to use!

Preview

Headscale is the de-facto self-hosted version of Tailscale, a popular Wireguard based VPN service. By default, it does not ship with a web UI, which is where Heady comes in.

Heady is strategic VPN management that prioritizes security, thoughtful design, and awesome user experience. Unlike feature-heavy alternatives, Heady focuses on doing the important things incredibly well.

🎯 What Makes Heady Different

Security-First Design: Every feature is evaluated for security impact first Convention Over Configuration: Smart defaults that just work for 90% of setups
Quality Over Quantity: Fewer features, done awesomely well Community-Driven: Built for real users, not corporate feature checklists

Awesome Features

  • Smart Machine Management: Intuitive node administration with clear status and controls
  • Intelligent ACL Configuration: Visual access control with tagging support
  • Revolutionary OIDC Integration: Zero-config role mapping that just works with any identity provider
  • DNS Made Simple: Easy MagicDNS setup and custom record management
  • Thoughtful Configuration: Headscale settings that make sense

🚀 Getting Started

Heady runs as a web application alongside your Headscale server. Quick setup with smart defaults gets you running fast.

# Coming soon - simplified Docker deployment

🔧 Zero-Config OIDC Setup

Heady's revolutionary OIDC system works with any identity provider out of the box:

oidc:
  issuer: "https://your-provider.com"
  client_id: "your-client-id" 
  client_secret: "your-secret"
  # That's it! Role mapping, scopes, and redirect URIs are auto-configured

Want custom roles? Easy:

HEADPLANE_ADMIN_GROUPS="admin,managers"
HEADPLANE_OWNER_GROUPS="ceo,founders"

📖 Documentation & Community

🎯 Deployment Options

Heady v1.0 features a unified architecture with all awesome features available in every deployment:

  • Standard Deployment

    Quick deployment with smart defaults. All features available, with optional integrations configured as needed.

  • Advanced Integration

    Enable Docker, Kubernetes, or native process integration for automatic DNS management and configuration updates.

Versioning

Headplane uses semantic versioning for its releases (since v0.6.0). Pre-release builds are available under the next tag and get updated when a new release PR is opened and actively in testing.

Contributing

Headplane is an open-source project and contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue. Also refer to the contributor guidelines for more info.


ACLs Machine Management

Copyright (c) 2025 Aarnav Tale