dahjah/headplane
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

chore: update readme

Browse Source
This commit is contained in:
Aarnav Tale 2024-05-01 02:51:03 -04:00
parent 82f5e17207
commit 61ae161496
No known key found for this signature in database
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -4,14 +4,13 @@
![Preview](/assets/main-preview.png) ![Preview](/assets/main-preview.png)
Headscale is a self-hosted version of the Tailscale control server, however, it currently lacks a first-party web UI. 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 Remix app that aims to provide a usable GUI for the Headscale server. Headplane aims to solve this issue by providing a GUI that can deeply integrate with the Headscale server.
It's still very early in it's development, however these are some of the features that are planned. It's able to replicate nearly all of the functions of the official Tailscale SaaS UI, including:
- [ ] Editable tags, machine names, users, etc - Machine/Node expiry, network routing, name, and owner management
- [x] ACL control through Docker integration - Access Control List (ACL) and tagging configuration
- [x] OIDC based login for the web UI - Support for OpenID Connect (OIDC) as a login provider
- [x] Automated API key regeneration - DNS and *safe* Headscale configuration management
- [x] Editable headscale configuration
## Deployment ## Deployment
- If you run Headscale in a Docker container, see the [Advanced Deployment](/docs/Advanced-Integration.md) guide. - If you run Headscale in a Docker container, see the [Advanced Deployment](/docs/Advanced-Integration.md) guide.