Skip to content

Commit

Permalink
Add admonitions marking community-provided docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Orhideous authored and juanfont committed Apr 7, 2023
1 parent 1723a6b commit 66c5f74
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 2 deletions.
7 changes: 7 additions & 0 deletions docs/dns-records.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
7 changes: 7 additions & 0 deletions docs/reverse-proxy.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 6 additions & 2 deletions docs/running-headscale-container.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
7 changes: 7 additions & 0 deletions docs/running-headscale-openbsd.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down

0 comments on commit 66c5f74

Please sign in to comment.