dahjah/headplane
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

fix: use absolute markdown paths

Browse Source
This commit is contained in:
Aarnav Tale 2024-03-29 19:43:57 -04:00
parent 9244d63826
commit 029f395673
No known key found for this signature in database
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,7 +1,7 @@
# Headplane
> An advanced UI for [juanfont/headscale](https://github.com/juanfont/headscale)
![Preview](./assets/main-preview.png)
![Preview](/assets/main-preview.png)
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.
@ -16,8 +16,8 @@ It's still very early in it's development, however these are some of the feature
## 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.
- 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.

4
docs/Advanced-Integration.md
View File

@ -1,6 +1,6 @@
# Advanced Integration
![Integration Preview](./assets/advanced-preview.png)
![Integration Preview](/assets/advanced-preview.png)
With the advanced integration it's possible to control Access Control Lists (ACLs) and the Headscale configuration via the Headplane UI.
Every single aspect of this integration is optional, meaning you can only use what you want.
@ -82,7 +82,7 @@ services:
OIDC_CLIENT_SECRET: 'super_secret_client_secret'
```
> For a breakdown of each configuration variable, please refer to the [Configuration](./docs/Configuration.md) guide.
> For a breakdown of each configuration variable, please refer to the [Configuration](/docs/Configuration.md) guide.
> It explains what each variable does, how to configure them, and what the default values are.
You may also choose to run it natively with the distributed binaries on the releases page.

2
docs/Basic-Integration.md
View File

@ -39,7 +39,7 @@ services:
PORT: '3000'
```
> For a breakdown of each configuration variable, please refer to the [Configuration](./docs/Configuration.md) guide.
> For a breakdown of each configuration variable, please refer to the [Configuration](/docs/Configuration.md) guide.
> It explains what each variable does, how to configure them, and what the default values are.
You may also choose to run it natively with the distributed binaries on the releases page.