From 1019c1ebf0872bd798012ac3d25232741fd535b5 Mon Sep 17 00:00:00 2001 From: Aarnav Tale Date: Thu, 28 Mar 2024 17:27:48 -0400 Subject: [PATCH] chore: update readme progress --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 072c75a..6a1a15f 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,12 @@ It's still very early in it's development, however these are some of the feature - [ ] ACL control through Docker integration - [x] OIDC based login for the web UI - [x] Automated API key regeneration -- [ ] Editable headscale configuration +- [x] Editable headscale configuration ## Deployment > The docker image is not available yet. For now you can build it locally with `docker build -t ghcr.io/tale/headplane:latest .` +In order to use Headplane, you need to be running the Headscale 0.23 alpha or later. Currently I'd only recommend deploying this with Docker because environment variables are required. Here's a very basic `docker-compose.yaml` file that utilizes each configuration variable.