headplane/HEADY_MANIFESTO.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

86 lines
2.7 KiB
Markdown

# 🤠 The Heady Manifesto
## What is Heady?
**Heady** is strategic VPN management for everyone. Not just big corporations, not just deep pockets - everyone who deserves awesome tools.
## Our Philosophy
### Awesome > Enterprise
- **Quality for all**: Great security shouldn't be locked behind "enterprise" paywalls
- **Thoughtful design**: Every feature should make sense, not just look impressive
- **Community first**: Built for real people with real problems, not shareholders
### Security Through Simplicity
- **Boring technology**: Proven, reliable tools over flashy experiments
- **Convention over configuration**: Smart defaults that just work
- **No surprises**: Predictable behavior you can actually trust
### Strategic Decisions
- **Remove the bad**: 38MB WASM SSH console? Gone.
- **Enhance the good**: OIDC role mapping? Made it awesome.
- **Plan the future**: Guacamole remote access? Designed right.
## What Makes Heady Different
### From Headplane
- **Security-first**: Every decision evaluated for security impact
- **Quality-focused**: Fewer features, done incredibly well
- **Community-driven**: Built for users, not feature checklists
### From "Enterprise" Solutions
- **Accessible**: No license fees, no vendor lock-in
- **Transparent**: Open source, auditable, understandable
- **Practical**: Solves real problems without corporate bloat
## The Heady Promise
1. **Your VPN management should be strategic, not stressful**
2. **Security tools should make you safer, not create new risks**
3. **Great software should be available to everyone**
4. **Thoughtful design beats feature creep every time**
## Technical Principles
### Convention Over Configuration
- Smart defaults that work for 90% of use cases
- Environment variables for the other 10%
- Zero-config setup whenever possible
### Security By Design
- Server-side operations wherever possible
- Minimal attack surface
- Audit-friendly architecture
- No client-side crypto
### Awesome UX
- Fast, responsive interfaces
- Clear, helpful error messages
- Mobile-friendly design
- Accessible to all skill levels
## Community Values
### Inclusive Excellence
- High-quality tools for everyone
- Documentation that actually helps
- Examples for real-world scenarios
- Support for all deployment sizes
### Thoughtful Development
- Every feature earns its place
- Breaking changes are rare and well-communicated
- Security trumps convenience
- Maintenance burden is considered
### Open Collaboration
- Issues and discussions welcome
- Contributions valued over credentials
- Learning encouraged over perfection
- Respect for all users and contributors
---
**Heady: Because your infrastructure deserves thoughtful, strategic management - and so do you.** 🤠
*That's HEADY!* (not Hedy) 😉