A feature-complete Web UI for Headscale

Go to file

Aarnav Tale 8cce3258a2 feat: add login via oidc or api key		2024-03-18 13:06:45 -04:00
src	feat: add login via oidc or api key	2024-03-18 13:06:45 -04:00
.env.example	feat: add login via oidc or api key	2024-03-18 13:06:45 -04:00
.gitignore	feat: initial commit	2024-03-17 19:34:54 -04:00
.npmrc	feat: initial commit	2024-03-17 19:34:54 -04:00
LICENSE	chore: add readme and license	2024-03-17 19:51:56 -04:00
package-lock.json	feat: add login via oidc or api key	2024-03-18 13:06:45 -04:00
package.json	feat: add login via oidc or api key	2024-03-18 13:06:45 -04:00
postcss.config.js	feat: initial commit	2024-03-17 19:34:54 -04:00
README.md	chore: add readme and license	2024-03-17 19:51:56 -04:00
svelte.config.js	feat: initial commit	2024-03-17 19:34:54 -04:00
tailwind.config.js	feat: initial commit	2024-03-17 19:34:54 -04:00
tsconfig.json	feat: initial commit	2024-03-17 19:34:54 -04:00
vite.config.ts	feat: initial commit	2024-03-17 19:34:54 -04:00

README.md

Headplane

An advanced UI for juanfont/headscale

Headscale is a self-hosted version of the Tailscale control server, however, it currently lacks a first-party web UI. This is a relatively tiny SvelteKit app that aims to provide a usable GUI for the Headscale server. It's still very early in it's development, however these are some of the features that are planned.

Editable tags, machine names, users, etc
ACL control through Docker integration
OIDC based login for the web UI
Automated API key regeneration
Editable headscale configuration

Deployment

Instructions for deploying this will come soon. It will utilize Docker to support advanced features.

Contributing

If you would like to contribute, please install a relatively modern version of Node.js and NPM. Clone this repository, run npm install, and then run npm run dev to start the development server.

Copyright (c) 2024 Aarnav Tale