juanfont · kradalby · Jan 4, 2022 · Jan 2, 2022 · Jan 2, 2022 · Jan 2, 2022
@@ -8,16 +8,16 @@ listen_addr: 0.0.0.0:8080
 
 # Private key file which will be
 # autogenerated if it's missing
-private_key_path: private.key
+private_key_path: /var/lib/headscale/private.key
 
 derp:
   # List of externally available DERP maps encoded in JSON
   urls:
     - https://controlplane.tailscale.com/derpmap/default
 
   # Locally available DERP map files encoded in YAML
-  paths:
-    - derp-example.yaml
+  # paths:
+  #   - /etc/headscale/derp-example.yaml
 
   # If enabled, a worker will be set up to periodically
   # refresh the given sources and update the derpmap
@@ -33,7 +33,7 @@ ephemeral_node_inactivity_timeout: 30m
 
 # SQLite config
 db_type: sqlite3
-db_path: db.sqlite
+db_path: /var/lib/headscale/db.sqlite
 
 # # Postgres config
 # db_type: postgres
@@ -48,7 +48,7 @@ acme_email: ""
 
 tls_letsencrypt_hostname: ""
 tls_letsencrypt_listen: ":http"
-tls_letsencrypt_cache_dir: ".cache"
+tls_letsencrypt_cache_dir: /var/lib/headscale/cache
 tls_letsencrypt_challenge_type: HTTP-01
 
 tls_cert_path: ""

@@ -1,7 +1,28 @@
-# Official headscale documentation
+# headscale documentation
 
-- [Configuration](Configuration.md)
-- [Running](Running.md)
+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/XcQxk2VHjx) instead of opening an Issue.
+
+## Official documentation
+
+### How-to
+
+- [Running headscale on Linux](running-headscale-linux.md)
 - [DNS](DNS.md)
 - [TLS](TLS.md)
+
+### References
+
+- [Configuration](Configuration.md)
 - [Glossary](Glossary.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 container](running-headscale-container.md)
diff --git a/k8s/.gitignore → docs/examples/kubernetes/.gitignore b/k8s/.gitignore → docs/examples/kubernetes/.gitignore
diff --git a/k8s/README.md → docs/examples/kubernetes/README.md b/k8s/README.md → docs/examples/kubernetes/README.md
@@ -1,5 +1,7 @@
 # Deploying headscale on Kubernetes
 
+**Note:** This is contributed by the community and not verified by the headscale authors.
+
 This directory contains [Kustomize](https://kustomize.io) templates that deploy
 headscale in various configurations.
 
@@ -66,7 +68,7 @@ tasks like creating namespaces, authkeys, etc.
 
 headscale is an open source implementation of the Tailscale control server
 
-https://gitlab.com/juanfont/headscale
+https://github.com/juanfont/headscale
 
 Usage:
   headscale [command]

diff --git a/k8s/base/configmap.yaml → docs/examples/kubernetes/base/configmap.yaml b/k8s/base/configmap.yaml → docs/examples/kubernetes/base/configmap.yaml
diff --git a/k8s/base/ingress.yaml → docs/examples/kubernetes/base/ingress.yaml b/k8s/base/ingress.yaml → docs/examples/kubernetes/base/ingress.yaml
diff --git a/k8s/base/kustomization.yaml → ...amples/kubernetes/base/kustomization.yaml b/k8s/base/kustomization.yaml → ...amples/kubernetes/base/kustomization.yaml
diff --git a/k8s/base/service.yaml → docs/examples/kubernetes/base/service.yaml b/k8s/base/service.yaml → docs/examples/kubernetes/base/service.yaml
diff --git a/k8s/headscale.bash → docs/examples/kubernetes/headscale.bash b/k8s/headscale.bash → docs/examples/kubernetes/headscale.bash
diff --git a/k8s/init.bash → docs/examples/kubernetes/init.bash b/k8s/init.bash → docs/examples/kubernetes/init.bash
diff --git a/k8s/install-cert-manager.bash → ...ples/kubernetes/install-cert-manager.bash b/k8s/install-cert-manager.bash → ...ples/kubernetes/install-cert-manager.bash
diff --git a/k8s/postgres/deployment.yaml → ...mples/kubernetes/postgres/deployment.yaml b/k8s/postgres/deployment.yaml → ...mples/kubernetes/postgres/deployment.yaml
diff --git a/k8s/postgres/kustomization.yaml → ...es/kubernetes/postgres/kustomization.yaml b/k8s/postgres/kustomization.yaml → ...es/kubernetes/postgres/kustomization.yaml
diff --git a/k8s/postgres/postgres-service.yaml → ...kubernetes/postgres/postgres-service.yaml b/k8s/postgres/postgres-service.yaml → ...kubernetes/postgres/postgres-service.yaml
diff --git a/k8s/postgres/postgres-statefulset.yaml → ...rnetes/postgres/postgres-statefulset.yaml b/k8s/postgres/postgres-statefulset.yaml → ...rnetes/postgres/postgres-statefulset.yaml
diff --git a/k8s/production-tls/ingress-patch.yaml → ...ernetes/production-tls/ingress-patch.yaml b/k8s/production-tls/ingress-patch.yaml → ...ernetes/production-tls/ingress-patch.yaml
diff --git a/k8s/production-tls/kustomization.yaml → ...ernetes/production-tls/kustomization.yaml b/k8s/production-tls/kustomization.yaml → ...ernetes/production-tls/kustomization.yaml
diff --git a/k8s/production-tls/production-issuer.yaml → ...tes/production-tls/production-issuer.yaml b/k8s/production-tls/production-issuer.yaml → ...tes/production-tls/production-issuer.yaml
diff --git a/k8s/sqlite/kustomization.yaml → ...ples/kubernetes/sqlite/kustomization.yaml b/k8s/sqlite/kustomization.yaml → ...ples/kubernetes/sqlite/kustomization.yaml
diff --git a/k8s/sqlite/statefulset.yaml → ...amples/kubernetes/sqlite/statefulset.yaml b/k8s/sqlite/statefulset.yaml → ...amples/kubernetes/sqlite/statefulset.yaml
diff --git a/k8s/staging-tls/ingress-patch.yaml → ...kubernetes/staging-tls/ingress-patch.yaml b/k8s/staging-tls/ingress-patch.yaml → ...kubernetes/staging-tls/ingress-patch.yaml
diff --git a/k8s/staging-tls/kustomization.yaml → ...kubernetes/staging-tls/kustomization.yaml b/k8s/staging-tls/kustomization.yaml → ...kubernetes/staging-tls/kustomization.yaml
diff --git a/k8s/staging-tls/staging-issuer.yaml → ...ubernetes/staging-tls/staging-issuer.yaml b/k8s/staging-tls/staging-issuer.yaml → ...ubernetes/staging-tls/staging-issuer.yaml