27 lines
1.2 KiB
Markdown
27 lines
1.2 KiB
Markdown
# Headplane
|
|
> An advanced UI for [juanfont/headscale](https://github.com/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 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.
|
|
|
|
- [ ] Editable tags, machine names, users, etc
|
|
- [ ] ACL control through Docker integration
|
|
- [x] OIDC based login for the web UI
|
|
- [x] Automated API key regeneration
|
|
- [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 .`
|
|
|
|
- If you run Headscale in a Docker container, see the [Advanced Deployment](/docs/Advanced-Integration.md) guide.
|
|
- If you run Headscale natively, see the [Basic Deployment](/docs/Basic-Integration.md) guide.
|
|
|
|
## Contributing
|
|
If you would like to contribute, please install a relatively modern version of Node.js and PNPM.
|
|
Clone this repository, run `pnpm install`, and then run `pnpm dev` to start the development server.
|
|
|
|
> Copyright (c) 2024 Aarnav Tale
|