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 new file mode 100644 index 0000000..d176490 --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# 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 SvelteKit 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 +Instructions for deploying this will come soon. It will utilize Docker to support advanced features. + +## Contributing +If you would like to contribute, please install a relatively modern version of Node.js and NPM. +Clone this repository, run `npm install`, and then run `npm run dev` to start the development server. + +> Copyright (c) 2024 Aarnav Tale