From 99bd09f688c3f3c8ddb3bc1529e9b0f397affac6 Mon Sep 17 00:00:00 2001 From: "Andriy Kushnir (Orhideous)" Date: Mon, 27 Mar 2023 20:51:26 +0300 Subject: [PATCH] Add new index page --- docs/README.md | 56 -------------------------------------------------- docs/index.md | 12 +++++++++++ 2 files changed, 12 insertions(+), 56 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/index.md diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 843c450d..00000000 --- a/docs/README.md +++ /dev/null @@ -1,56 +0,0 @@ -# headscale documentation - -This page contains the official and community contributed documentation for `headscale`. - -If you are having trouble with following the documentation or get unexpected results, -please ask on [Discord](https://discord.gg/c84AZQhmpx) instead of opening an Issue. - -## Official documentation - -### How-to - -- [Running headscale on Linux](running-headscale-linux.md) -- [Control headscale remotely](remote-cli.md) -- [Using a Windows client with headscale](windows-client.md) -- [Configuring OIDC](oidc.md) - -### References - -- [Configuration](../config-example.yaml) -- [Glossary](glossary.md) -- [TLS](tls.md) - -## Community documentation - -Community documentation 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 in a container](running-headscale-container.md) -- [Running headscale on OpenBSD](running-headscale-openbsd.md) -- [Running headscale behind a reverse proxy](reverse-proxy.md) -- [Set Custom DNS records](dns-records.md) - -## Misc - -### Policy ACLs - -Headscale implements the same policy ACLs as Tailscale.com, adapted to the self-hosted environment. - -For instance, instead of referring to users when defining groups you must -use users (which are the equivalent to user/logins in Tailscale.com). - -Please check https://tailscale.com/kb/1018/acls/, and `./tests/acls/` in this repo for working examples. - -When using ACL's the User borders are no longer applied. All machines -whichever the User have the ability to communicate with other hosts as -long as the ACL's permits this exchange. - -The [ACLs](acls.md) document should help understand a fictional case of setting -up ACLs in a small company. All concepts presented in this document could be -applied outside of business oriented usage. - -### Apple devices - -An endpoint with information on how to connect your Apple devices (currently macOS only) is available at `/apple` on your running instance. diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..2130f7a5 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,12 @@ +--- +hide: + - navigation + - toc +--- + +# headscale documentation + +This site contains the official and community contributed documentation for `headscale`. + +If you are having trouble with following the documentation or get unexpected results, +please ask on [Discord](https://discord.gg/c84AZQhmpx) instead of opening an Issue.