various doc updates in prep for 0.23 (#2091)

* various doc updates in prep for 0.23 Signed-off-by: Kristoffer Dalby <[email protected]> * add note discouraging postgresql Signed-off-by: Kristoffer Dalby <[email protected]> * Update docs/faq.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * remove entry for glossary in doc Signed-off-by: Kristoffer Dalby <[email protected]> * fix typo Signed-off-by: Kristoffer Dalby <[email protected]> --------- Signed-off-by: Kristoffer Dalby <[email protected]> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
juanfont · Aug 30, 2024 · cb0e2e4 · cb0e2e4
1 parent 2b5e52b
commit cb0e2e4
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 44 deletions.
diff --git a/config-example.yaml b/config-example.yaml
@@ -138,6 +138,9 @@ disable_check_updates: false
 ephemeral_node_inactivity_timeout: 30m
 
 database:
+  # Database type. Available options: sqlite, postgres
+  # Please not that using Postgres is highly discouraged as it is only supported for legacy reasons.
+  # All new development, testing and optimisations are done with SQLite in mind.
   type: sqlite
 
   # Enable debug mode. This setting requires the log.level to be set to "debug" or "trace".
@@ -166,6 +169,8 @@ database:
     write_ahead_log: true
 
   # # Postgres config
+  # Please note that using Postgres is highly discouraged as it is only supported for legacy reasons.
+  # See database.type for more information.
   # postgres:
   #   # If using a Unix socket to connect to Postgres, set the socket path in the 'host' field and leave 'port' blank.
   #   host: localhost

diff --git a/docs/faq.md b/docs/faq.md
@@ -31,7 +31,7 @@ We are more than happy to exchange emails, or to have dedicated calls before a P
 
 ## When/Why is Feature X going to be implemented?
 
-We don't know. We might be working on it. If you want to help, please send us a PR.
+We don't know. We might be working on it. If you're interested in contributing, please post a feature request about it.
 
 Please be aware that there are a number of reasons why we might not accept specific contributions:
 

diff --git a/docs/glossary.md b/docs/glossary.md
diff --git a/docs/index.md b/docs/index.md
@@ -31,12 +31,7 @@ buttons available in the repo.
 Headscale is "Open Source, acknowledged contribution", this means that any
 contribution will have to be discussed with the Maintainers before being submitted.
 
-This model has been chosen to reduce the risk of burnout by limiting the
-maintenance overhead of reviewing and validating third-party code.
-
-Headscale is open to code contributions for bug fixes without discussion.
-
-If you find mistakes in the documentation, please submit a fix to the documentation.
+Please see [CONTRIBUTING.md](https://github.com/juanfont/headscale/blob/main/CONTRIBUTING.md) for more information.
 
 ## About
 

diff --git a/docs/running-headscale-container.md b/docs/running-headscale-container.md
@@ -42,36 +42,12 @@ not work with alternatives like [Podman](https://podman.io). The Docker image ca
         curl https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml -o ./config/config.yaml
         ```
 
-    - **(Advanced)** If you would like to hand craft a config file **instead** of downloading the example config file, create a blank `headscale` configuration in the headscale directory to edit:
+    Modify the config file to your preferences before launching Docker container.
+    Here are some settings that you likely want:
 
-        ```shell
-        touch ./config/config.yaml
-        ```
-
-        Modify the config file to your preferences before launching Docker container.
-        Here are some settings that you likely want:
-
-        ```yaml
-        # Change to your hostname or host IP
-        server_url: http://your-host-name:8080
-        # Listen to 0.0.0.0 so it's accessible outside the container
-        metrics_listen_addr: 0.0.0.0:9090
-        # The default /var/lib/headscale path is not writable in the container
-        noise:
-          private_key_path: /etc/headscale/noise_private.key
-        # The default /var/lib/headscale path is not writable in the container
-        derp:
-          private_key_path: /etc/headscale/private.key
-        # The default /var/run/headscale path is not writable  in the container
-        unix_socket: /etc/headscale/headscale.sock
-        # The default /var/lib/headscale path is not writable  in the container
-        database.type: sqlite3
-        database.sqlite.path: /etc/headscale/db.sqlite
-        ```
-
-        Alternatively, you can mount `/var/lib` and `/var/run` from your host system by adding
-        `--volume $(pwd)/lib:/var/lib/headscale` and `--volume $(pwd)/run:/var/run/headscale`
-        in the next step.
+    Alternatively, you can mount `/var/lib` and `/var/run` from your host system by adding
+    `--volume $(pwd)/lib:/var/lib/headscale` and `--volume $(pwd)/run:/var/run/headscale`
+    in the next step.
 
 1. Start the headscale server while working in the host headscale directory:
 
@@ -95,7 +71,7 @@ not work with alternatives like [Podman](https://podman.io). The Docker image ca
 
       ```yaml
       version: "3.7"
-      
+
       services:
         headscale:
           image: headscale/headscale:0.22.3

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -144,4 +144,3 @@ nav:
   - Proposals:
       - ACLs: proposals/001-acls.md
       - Better routing: proposals/002-better-routing.md
-  - Glossary: glossary.md