From 2345c38e1e138f8ccc1e69234e7a342244044bab Mon Sep 17 00:00:00 2001 From: nblock Date: Tue, 12 Nov 2024 16:53:30 +0100 Subject: [PATCH] Add a page for third-party tools (#2217) * Remove status from web-ui docs Rename the title to indicate that there multiple web interfaces available. Do not track the status of each web interface here as their status is subject to change over time. * Add page for third-party tools and scripts --- docs/ref/integration/tools.md | 12 ++++++++++++ docs/ref/integration/web-ui.md | 20 +++++++++++--------- docs/setup/install/community.md | 2 +- mkdocs.yml | 1 + 4 files changed, 25 insertions(+), 10 deletions(-) create mode 100644 docs/ref/integration/tools.md diff --git a/docs/ref/integration/tools.md b/docs/ref/integration/tools.md new file mode 100644 index 00000000..9e8b7176 --- /dev/null +++ b/docs/ref/integration/tools.md @@ -0,0 +1,12 @@ +# Tools related to headscale + +!!! warning "Community contributions" + + This page contains community contributions. The projects listed here are not + maintained by the headscale authors and are written by community members. + +This page collects third-party tools and scripts related to headscale. + +| Name | Repository Link | Description | +| ----------------- | --------------------------------------------------------------- | ------------------------------------------------- | +| tailscale-manager | [Github](https://github.com/singlestore-labs/tailscale-manager) | Dynamically manage Tailscale route advertisements | diff --git a/docs/ref/integration/web-ui.md b/docs/ref/integration/web-ui.md index cf06a77d..9f6077e0 100644 --- a/docs/ref/integration/web-ui.md +++ b/docs/ref/integration/web-ui.md @@ -1,17 +1,19 @@ -# Headscale web interface +# Web interfaces for headscale !!! warning "Community contributions" This page contains community contributions. The projects listed here are not maintained by the headscale authors and are written by community members. -| Name | Repository Link | Description | Status | -| --------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------- | ------ | -| headscale-webui | [Github](https://github.com/ifargle/headscale-webui) | A simple headscale web UI for small-scale deployments. | Alpha | -| headscale-ui | [Github](https://github.com/gurucomputing/headscale-ui) | A web frontend for the headscale Tailscale-compatible coordination server | Alpha | -| HeadscaleUi | [GitHub](https://github.com/simcu/headscale-ui) | A static headscale admin ui, no backend enviroment required | Alpha | -| Headplane | [GitHub](https://github.com/tale/headplane) | An advanced Tailscale inspired frontend for headscale | Alpha | -| headscale-admin | [Github](https://github.com/GoodiesHQ/headscale-admin) | Headscale-Admin is meant to be a simple, modern web interface for headscale | Beta | -| ouroboros | [Github](https://github.com/yellowsink/ouroboros) | Ouroboros is designed for users to manage their own devices, rather than for admins | Stable | +Headscale doesn't provide a built-in web interface but users may pick one from the available options. + +| Name | Repository Link | Description | +| --------------- | ------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| headscale-webui | [Github](https://github.com/ifargle/headscale-webui) | A simple headscale web UI for small-scale deployments. | +| headscale-ui | [Github](https://github.com/gurucomputing/headscale-ui) | A web frontend for the headscale Tailscale-compatible coordination server | +| HeadscaleUi | [GitHub](https://github.com/simcu/headscale-ui) | A static headscale admin ui, no backend enviroment required | +| Headplane | [GitHub](https://github.com/tale/headplane) | An advanced Tailscale inspired frontend for headscale | +| headscale-admin | [Github](https://github.com/GoodiesHQ/headscale-admin) | Headscale-Admin is meant to be a simple, modern web interface for headscale | +| ouroboros | [Github](https://github.com/yellowsink/ouroboros) | Ouroboros is designed for users to manage their own devices, rather than for admins | You can ask for support on our dedicated [Discord channel](https://discord.com/channels/896711691637780480/1105842846386356294). diff --git a/docs/setup/install/community.md b/docs/setup/install/community.md index f9d7cc18..8fb71803 100644 --- a/docs/setup/install/community.md +++ b/docs/setup/install/community.md @@ -28,7 +28,7 @@ development version. ## Fedora, RHEL, CentOS -A 3rd-party repository for various RPM based distributions is available at: +A third-party repository for various RPM based distributions is available at: . The site provides detailed setup and installation instructions. diff --git a/mkdocs.yml b/mkdocs.yml index d01c94cc..352c8d39 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -183,3 +183,4 @@ nav: - Integration: - Reverse proxy: ref/integration/reverse-proxy.md - Web UI: ref/integration/web-ui.md + - Tools: ref/integration/tools.md