A feature-complete Web UI for Headscale

Go to file

Aarnav Tale ca32590e54 fix: string constructor in js causes oidc fast track		2024-04-07 14:01:38 -04:00
.github/workflows	fix: add publish archs	2024-04-02 15:08:47 -04:00
app	fix: string constructor in js causes oidc fast track	2024-04-07 14:01:38 -04:00
assets	feat: redo documentation	2024-03-29 19:41:56 -04:00
docs	fix: use absolute markdown paths	2024-03-29 19:43:57 -04:00
public	chore: initial commit from create-remix	2024-03-25 17:50:10 -04:00
test	chore: add local headscale for testing	2024-03-28 14:58:00 -04:00
.dockerignore	feat: add docker build	2024-03-26 10:10:34 -04:00
.env.example	feat: restart docker container	2024-03-29 01:53:32 -04:00
.eslintrc	feat: initial bootstrappy stuff	2024-03-25 17:50:58 -04:00
.gitignore	chore: initial commit from create-remix	2024-03-25 17:50:10 -04:00
compose.yaml	chore: add a warning to the compose.yaml	2024-04-05 18:32:12 -04:00
Dockerfile	fix: remix relies on build dir	2024-03-30 05:06:17 -04:00
LICENSE	chore: add license and readme again	2024-03-26 10:24:28 -04:00
package.json	fix: replace chokidar with fs.watch	2024-03-30 04:20:16 -04:00
pnpm-lock.yaml	fix: replace chokidar with fs.watch	2024-03-30 04:20:16 -04:00
postcss.config.js	feat: initial bootstrappy stuff	2024-03-25 17:50:58 -04:00
README.md	chore: we now have images!	2024-03-30 04:51:37 -04:00
tailwind.config.ts	feat: initial bootstrappy stuff	2024-03-25 17:50:58 -04:00
tsconfig.json	feat: initial bootstrappy stuff	2024-03-25 17:50:58 -04:00
vite.config.ts	fix: nice one remix	2024-03-26 10:32:55 -04:00

README.md

Headplane

An advanced UI for 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
OIDC based login for the web UI
Automated API key regeneration
Editable headscale configuration

Deployment

If you run Headscale in a Docker container, see the Advanced Deployment guide.
If you run Headscale natively, see the Basic Deployment 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