2024-03-26 10:20:41 -04:00
|
|
|
# Headplane
|
|
|
|
|
> An advanced UI for [juanfont/headscale](https://github.com/juanfont/headscale)
|
2024-03-25 15:34:11 -04:00
|
|
|
|
2024-03-29 19:43:57 -04:00
|
|
|
|
2024-03-26 11:01:58 -04:00
|
|
|
|
2024-03-26 10:20:41 -04:00
|
|
|
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.
|
2024-03-25 15:34:11 -04:00
|
|
|
|
2024-03-26 10:20:41 -04:00
|
|
|
- [ ] Editable tags, machine names, users, etc
|
2024-04-15 04:06:18 -04:00
|
|
|
- [x] ACL control through Docker integration
|
2024-03-26 10:20:41 -04:00
|
|
|
- [x] OIDC based login for the web UI
|
|
|
|
|
- [x] Automated API key regeneration
|
2024-03-28 17:27:48 -04:00
|
|
|
- [x] Editable headscale configuration
|
2024-03-25 15:34:11 -04:00
|
|
|
|
|
|
|
|
## Deployment
|
2024-03-29 19:43:57 -04:00
|
|
|
- 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.
|
2024-04-15 04:06:18 -04:00
|
|
|
- For more configuration options, refer to the [Configuration](/docs/Configuration.md) guide.
|
2024-03-25 15:34:11 -04:00
|
|
|
|
2024-03-26 10:20:41 -04:00
|
|
|
## 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.
|
2024-03-25 15:34:11 -04:00
|
|
|
|
2024-03-26 10:20:41 -04:00
|
|
|
> Copyright (c) 2024 Aarnav Tale
|
