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

chore: update readme progress

Browse Source
This commit is contained in:
Aarnav Tale 2024-03-28 17:27:48 -04:00
parent e6e3110753
commit 1019c1ebf0
No known key found for this signature in database
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -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 - [ ] ACL control through Docker integration
- [x] OIDC based login for the web UI - [x] OIDC based login for the web UI
- [x] Automated API key regeneration - [x] Automated API key regeneration
- [ ] Editable headscale configuration - [x] Editable headscale configuration
## Deployment ## Deployment
> The docker image is not available yet. For now you can build it locally with `docker build -t ghcr.io/tale/headplane:latest .` > 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. 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. Here's a very basic `docker-compose.yaml` file that utilizes each configuration variable.