From 029f3956738d5a8871625145d8f1ce4f8e10d0c7 Mon Sep 17 00:00:00 2001 From: Aarnav Tale Date: Fri, 29 Mar 2024 19:43:57 -0400 Subject: [PATCH] fix: use absolute markdown paths --- README.md | 6 +++--- docs/Advanced-Integration.md | 4 ++-- docs/Basic-Integration.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3eab1be..e7da91c 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docs/Advanced-Integration.md b/docs/Advanced-Integration.md index ebd61d2..608079c 100644 --- a/docs/Advanced-Integration.md +++ b/docs/Advanced-Integration.md @@ -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. diff --git a/docs/Basic-Integration.md b/docs/Basic-Integration.md index 1908d20..078b16c 100644 --- a/docs/Basic-Integration.md +++ b/docs/Basic-Integration.md @@ -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.