From 61ae161496abe87736b10b7b539fb184e85cffc4 Mon Sep 17 00:00:00 2001 From: Aarnav Tale Date: Wed, 1 May 2024 02:51:03 -0400 Subject: [PATCH] chore: update readme --- README.md | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3263f50..0920508 100644 --- a/README.md +++ b/README.md @@ -4,14 +4,13 @@ ![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. -This is a relatively tiny Remix 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. +Headplane aims to solve this issue by providing a GUI that can deeply integrate with the Headscale server. +It's able to replicate nearly all of the functions of the official Tailscale SaaS UI, including: -- [ ] Editable tags, machine names, users, etc -- [x] ACL control through Docker integration -- [x] OIDC based login for the web UI -- [x] Automated API key regeneration -- [x] Editable headscale configuration +- Machine/Node expiry, network routing, name, and owner management +- Access Control List (ACL) and tagging configuration +- Support for OpenID Connect (OIDC) as a login provider +- DNS and *safe* Headscale configuration management ## Deployment - If you run Headscale in a Docker container, see the [Advanced Deployment](/docs/Advanced-Integration.md) guide.