From 1a7fd1fad209d9b443a0b699bb65f82cb1bbb6a7 Mon Sep 17 00:00:00 2001 From: Aarnav Tale Date: Tue, 26 Mar 2024 10:20:41 -0400 Subject: [PATCH] chore: add license and readme again --- LICENSE | 21 +++++++++++++++++++++ README.md | 46 ++++++++++++++++------------------------------ 2 files changed, 37 insertions(+), 30 deletions(-) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..5fa701e --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Aarnav Tale + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index c05e097..3712ef2 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,22 @@ -# Welcome to Remix + Vite! +# Headplane +> An advanced UI for [juanfont/headscale](https://github.com/juanfont/headscale) -📖 See the [Remix docs](https://remix.run/docs) and the [Remix Vite docs](https://remix.run/docs/en/main/future/vite) for details on supported features. +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. -## Development - -Run the Vite dev server: - -```shellscript -npm run dev -``` +- [ ] Editable tags, machine names, users, etc +- [ ] ACL control through Docker integration +- [x] OIDC based login for the web UI +- [x] Automated API key regeneration +- [ ] Editable headscale configuration ## Deployment +Instructions for deploying this will come soon. It will utilize Docker to support advanced features. +If you do want to fight with the environment variables right now, the image is `ghcr.io/tale/headplane:latest` -First, build your app for production: +## 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. -```sh -npm run build -``` - -Then run the app in production mode: - -```sh -npm start -``` - -Now you'll need to pick a host to deploy it to. - -### DIY - -If you're familiar with deploying Node applications, the built-in Remix app server is production-ready. - -Make sure to deploy the output of `npm run build` - -- `build/server` -- `build/client` +> Copyright (c) 2024 Aarnav Tale