Mirrors/juanfont.headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2025-09-25 17:51:11 +02:00
Code Issues Projects Releases Wiki Activity

Use full image URL in container docs

Browse Source 
This makes it easy to switch the container runtime from docker <->
podman.
This commit is contained in:
Florian Preinstorfer 2025-05-03 13:56:17 +02:00
parent 4d8cf5f252
commit 303b9017de
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
docs/setup/install/container.md
View File

@ -7,11 +7,14 @@
**It might be outdated and it might miss necessary steps**. **It might be outdated and it might miss necessary steps**.
This documentation has the goal of showing a user how-to set up and run headscale in a container. This documentation has the goal of showing a user how-to set up and run headscale in a container. A container runtime
[Docker](https://www.docker.com) is used as the reference container implementation, but there is no reason that it such as [Docker](https://www.docker.com) or [Podman](https://podman.io) is required. The container image can be found on
should not work with alternatives like [Podman](https://podman.io). The container image can be found on [Docker Hub](https://hub.docker.com/r/headscale/headscale) and [GitHub Container
[Docker Hub](https://hub.docker.com/r/headscale/headscale) and Registry](https://github.com/juanfont/headscale/pkgs/container/headscale). The container image URLs are:
[GitHub Container Registry](https://github.com/juanfont/headscale/pkgs/container/headscale).
- [Docker Hub](https://hub.docker.com/r/headscale/headscale): `docker.io/headscale/headscale:<VERSION>`
- [GitHub Container Registry](https://github.com/juanfont/headscale/pkgs/container/headscale):
`ghcr.io/juanfont/headscale:<VERSION>`
## Configure and run headscale ## Configure and run headscale
@ -36,7 +39,7 @@ should not work with alternatives like [Podman](https://podman.io). The containe
--volume "$(pwd)/run:/var/run/headscale" \ --volume "$(pwd)/run:/var/run/headscale" \
--publish 127.0.0.1:8080:8080 \ --publish 127.0.0.1:8080:8080 \
--publish 127.0.0.1:9090:9090 \ --publish 127.0.0.1:9090:9090 \
headscale/headscale:<VERSION> \ docker.io/headscale/headscale:<VERSION> \
serve serve
``` ```
@ -52,7 +55,7 @@ should not work with alternatives like [Podman](https://podman.io). The containe
services: services:
headscale: headscale:
image: headscale/headscale:<VERSION> image: docker.io/headscale/headscale:<VERSION>
restart: unless-stopped restart: unless-stopped
container_name: headscale container_name: headscale
ports: ports:
@ -126,11 +129,11 @@ tailscale up --login-server <YOUR_HEADSCALE_URL> --authkey <YOUR_AUTH_KEY>
## Debugging headscale running in Docker ## Debugging headscale running in Docker
The `headscale/headscale` Docker container is based on a "distroless" image that does not contain a shell or any other debug tools. If you need to debug headscale running in the Docker container, you can use the `-debug` variant, for example `headscale/headscale:x.x.x-debug`. The Headscale container image is based on a "distroless" image that does not contain a shell or any other debug tools. If you need to debug headscale running in the Docker container, you can use the `-debug` variant, for example `docker.io/headscale/headscale:x.x.x-debug`.
### Running the debug Docker container ### Running the debug Docker container
To run the debug Docker container, use the exact same commands as above, but replace `headscale/headscale:x.x.x` with `headscale/headscale:x.x.x-debug` (`x.x.x` is the version of headscale). The two containers are compatible with each other, so you can alternate between them. To run the debug Docker container, use the exact same commands as above, but replace `docker.io/headscale/headscale:x.x.x` with `docker.io/headscale/headscale:x.x.x-debug` (`x.x.x` is the version of headscale). The two containers are compatible with each other, so you can alternate between them.
### Executing commands in the debug container ### Executing commands in the debug container
@ -141,13 +144,13 @@ Additionally, the debug container includes a minimalist Busybox shell.
To launch a shell in the container, use: To launch a shell in the container, use:
```shell ```shell
docker run -it headscale/headscale:x.x.x-debug sh docker run -it docker.io/headscale/headscale:x.x.x-debug sh
``` ```
You can also execute commands directly, such as `ls /ko-app` in this example: You can also execute commands directly, such as `ls /ko-app` in this example:
```shell ```shell
docker run headscale/headscale:x.x.x-debug ls /ko-app docker run docker.io/headscale/headscale:x.x.x-debug ls /ko-app
``` ```
Using `docker exec -it` allows you to run commands in an existing container. Using `docker exec -it` allows you to run commands in an existing container.