rsp2k/headplane
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
headplane/README.md

126 lines
4.2 KiB
Markdown
Raw Normal View History

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
# 🤠 Heady
> Strategic VPN management for [Headscale](https://headscale.net) that's actually awesome to use!
chore: initial commit from create-remix
2024-03-25 15:34:11 -04:00
feat: update images
2024-06-03 23:32:13 -04:00
<picture>
<source
media="(prefers-color-scheme: dark)"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
srcset="./docs/assets/preview-dark.png"
feat: update images
2024-06-03 23:32:13 -04:00
>
<source
media="(prefers-color-scheme: light)"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
srcset="./docs/assets/preview-light.png"
feat: update images
2024-06-03 23:32:13 -04:00
>
<img
alt="Preview"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
src="./docs/assets/preview-dark.png"
feat: update images
2024-06-03 23:32:13 -04:00
>
</picture>
chore: add preview
2024-03-26 11:01:58 -04:00
docs: redo docs
2025-02-27 15:29:36 -05:00
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
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
**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.
### Quick Start (Docker - Recommended)
```bash
# Coming soon - simplified Docker deployment
```
### 🔧 Zero-Config OIDC Setup
Heady's revolutionary OIDC system works with any identity provider out of the box:
```yaml
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:
```bash
HEADPLANE_ADMIN_GROUPS="admin,managers"
HEADPLANE_OWNER_GROUPS="ceo,founders"
```
## 📖 Documentation & Community
- [📋 OIDC Setup Guide](docs/OIDC-Authentication.md) - Zero-config authentication
- [🏗️ Architecture Design](GUACAMOLE_REMOTE_ACCESS_DESIGN.md) - Security-first remote access
- [🤠 Heady Manifesto](HEADY_MANIFESTO.md) - Our philosophy and values
- [🔧 Configuration Examples](config.example.yaml) - Smart defaults you can customize
## 🎯 Deployment Options
**Heady v1.0** features a unified architecture with all awesome features available in every deployment:
- ### [Standard Deployment](/docs/Simple-Mode.md)
Quick deployment with smart defaults. All features available, with optional integrations configured as needed.
- ### [Advanced Integration](/docs/Integrated-Mode.md)
Enable Docker, Kubernetes, or native process integration for automatic DNS management and configuration updates.
chore: document the new integration providers
2024-05-26 19:40:46 -04:00
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
## Versioning
docs: mention versioning policy
2025-04-04 15:44:16 -04:00
Headplane uses [semantic versioning](https://semver.org/) 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.
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
## Contributing
chore: add 'community' things
2025-03-18 01:32:05 -04:00
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](./docs/CONTRIBUTING.md) for more info.
docs: mention versioning policy
2025-04-04 15:44:16 -04:00
---
docs: redo docs
2025-02-27 15:29:36 -05:00
<picture>
<source
media="(prefers-color-scheme: dark)"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
srcset="./docs/assets/acls-dark.png"
docs: redo docs
2025-02-27 15:29:36 -05:00
>
<source
media="(prefers-color-scheme: light)"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
srcset="./docs/assets/acls-light.png"
docs: redo docs
2025-02-27 15:29:36 -05:00
>
<img
alt="ACLs"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
src="./docs/assets/acls-dark.png"
docs: redo docs
2025-02-27 15:29:36 -05:00
>
</picture>
chore: initial commit from create-remix
2024-03-25 15:34:11 -04:00
docs: redo docs
2025-02-27 15:29:36 -05:00
<picture>
<source
media="(prefers-color-scheme: dark)"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
srcset="./docs/assets/machine-dark.png"
docs: redo docs
2025-02-27 15:29:36 -05:00
>
<source
media="(prefers-color-scheme: light)"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
srcset="./docs/assets/machine-light.png"
docs: redo docs
2025-02-27 15:29:36 -05:00
>
<img
alt="Machine Management"
feat: documentation website using Vitepress Adds documentation website using https://vitepress.dev. Some decisions are questionable, for example creation of a symbolic link for the README in the `docs/`. I wanted to preserve the ability to read docs using Github. Maybe not needed. Another issue, is the page outline for the `NixOS` chapter is too narrow. But should serve as a scaffold/basis for doing it properly.
2025-08-09 21:35:27 +00:00
src="./docs/assets/machine-dark.png"
docs: redo docs
2025-02-27 15:29:36 -05:00
>
</picture>
chore: initial commit from create-remix
2024-03-25 15:34:11 -04:00
docs: redo docs
2025-02-27 15:29:36 -05:00
> Copyright (c) 2025 Aarnav Tale
Reference in a new issue Copy permalink