Skip to content

Commit

Permalink
various doc updates in prep for 0.23
Browse files Browse the repository at this point in the history
Signed-off-by: Kristoffer Dalby <[email protected]>
  • Loading branch information
kradalby committed Aug 30, 2024
1 parent fffd9d7 commit 5e3d512
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 43 deletions.
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 want to help, please post an feature request about it.

Please be aware that there are a number of reasons why we might not accept specific contributions:

Expand Down
6 changes: 0 additions & 6 deletions docs/glossary.md

This file was deleted.

7 changes: 1 addition & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

Expand All @@ -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
Expand Down

0 comments on commit 5e3d512

Please sign in to comment.