From 66c5f74d78736824275df8bbcfca89d00a211ac5 Mon Sep 17 00:00:00 2001 From: "Andriy Kushnir (Orhideous)" Date: Mon, 27 Mar 2023 20:50:41 +0300 Subject: [PATCH] Add admonitions marking community-provided docs --- docs/dns-records.md | 7 +++++++ docs/reverse-proxy.md | 7 +++++++ docs/running-headscale-container.md | 8 ++++++-- docs/running-headscale-openbsd.md | 7 +++++++ 4 files changed, 27 insertions(+), 2 deletions(-) diff --git a/docs/dns-records.md b/docs/dns-records.md index b7808576..c5a07fe9 100644 --- a/docs/dns-records.md +++ b/docs/dns-records.md @@ -1,5 +1,12 @@ # Setting custom DNS records +!!! warning "Community documentation" + + This page is not actively maintained by the headscale authors and is + written by community members. It is _not_ verified by `headscale` developers. + + **It might be outdated and it might miss necessary steps**. + ## Goal This documentation has the goal of showing how a user can set custom DNS records with `headscale`s magic dns. diff --git a/docs/reverse-proxy.md b/docs/reverse-proxy.md index b00e0f9f..aab9f848 100644 --- a/docs/reverse-proxy.md +++ b/docs/reverse-proxy.md @@ -1,5 +1,12 @@ # Running headscale behind a reverse proxy +!!! warning "Community documentation" + + This page is not actively maintained by the headscale authors and is + written by community members. It is _not_ verified by `headscale` developers. + + **It might be outdated and it might miss necessary steps**. + Running headscale behind a reverse proxy is useful when running multiple applications on the same server, and you want to reuse the same external IP and port - usually tcp/443 for HTTPS. ### WebSockets diff --git a/docs/running-headscale-container.md b/docs/running-headscale-container.md index ef4afe71..33c67393 100644 --- a/docs/running-headscale-container.md +++ b/docs/running-headscale-container.md @@ -1,7 +1,11 @@ # Running headscale in a container -**Note:** the container documentation is maintained by the _community_ and there is no guarentee -it is up to date, or working. +!!! warning "Community documentation" + + This page is not actively maintained by the headscale authors and is + written by community members. It is _not_ verified by `headscale` developers. + + **It might be outdated and it might miss necessary steps**. ## Goal diff --git a/docs/running-headscale-openbsd.md b/docs/running-headscale-openbsd.md index 2ffd397a..394fafa2 100644 --- a/docs/running-headscale-openbsd.md +++ b/docs/running-headscale-openbsd.md @@ -1,5 +1,12 @@ # Running headscale on OpenBSD +!!! warning "Community documentation" + + This page is not actively maintained by the headscale authors and is + written by community members. It is _not_ verified by `headscale` developers. + + **It might be outdated and it might miss necessary steps**. + ## Goal This documentation has the goal of showing a user how-to install and run `headscale` on OpenBSD 7.1.