Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve Docker docs #263

Merged
merged 2 commits into from
Jan 6, 2022
Merged

Improve Docker docs #263

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d971cf1
Improve Docker docs
JJGadgets Jan 6, 2022
897fa55
prettier: Docker docs
Jan 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 24 additions & 9 deletions docs/running-headscale-container.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,31 +7,46 @@ it is up to date, or working.

This documentation has the goal of showing a user how-to set up and run `headscale` in a container.
[Docker](https://www.docker.com) is used as the reference container implementation, but there is no reason that it should
not work with alternatives like [Podman](https://podman.io).
not work with alternatives like [Podman](https://podman.io). The Docker image can be found on Docker Hub [here](https://hub.docker.com/r/headscale/headscale).

## Configure and run `headscale`

1. Prepare a direction to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database:
1. Prepare a directory on the host Docker node in your directory of choice, used to hold `headscale` configuration and the [SQLite](https://www.sqlite.org/) database:

```shell
mkdir config
mkdir ./headscale && cd ./headscale
mkdir ./config
```

2. Create an empty SQlite datebase:
2. Create an empty SQlite datebase in the headscale directory:

```shell
touch config/db.sqlite
touch ./config/db.sqlite
```

3. Create a `headscale` configuration:
3. **(Strongly Recommended)** Download a copy of the [example configuration](../config-example.yaml) from the [headscale repository](https://github.com/juanfont/headscale/).

Using wget:

```shell
wget -O ./config/config.yaml https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml
```

Using curl:

```shell
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:

```shell
touch config/config.yaml
touch ./config/config.yaml
```

It is **strongly recommended** to copy the [example configuration](../config.yaml) from the [headscale repository](../)
Modify the config file to your preferences before launching Docker container.

4. Start the headscale server:
4. Start the headscale server while working in the host headscale directory:

```shell
docker run \
Expand Down