8 Commits

Author SHA1 Message Date
val 4f48752ff8 added env for expiration time 2026-05-28 17:49:04 +02:00
3wc 311d08d461 docs: Add @val as backup maintainer 2026-04-27 13:54:51 -04:00
3wordchant 899e0746cc Merge pull request 'docs: Maintainers, assemble!' (#7) from docs/3wc/putting-together-a-team into main
Reviewed-on: #7
Reviewed-by: ammaratef45 <ammaratef45@proton.me>
2026-04-27 17:52:36 +00:00
3wc 0ef57f229f docs: Maintainers, assemble!
Re: #6
2026-04-16 12:54:55 -04:00
3wordchant d6092108f3 Merge pull request 'info about headless container and ui' (#4) from val/headscale:getting-start-docs into main
Reviewed-on: #4
Reviewed-by: decentral1se <decentral1se@noreply.git.coopcloud.tech>
2026-04-09 17:04:11 +00:00
3wc 1fcc21e48f chore: publish 0.3.0+v0.28 release 2026-04-09 12:59:27 -04:00
3wc b72fd39e38 chore: update image tags 2026-04-09 12:35:42 -04:00
val 7100c38bc8 info about headless container and ui 2026-03-26 16:29:59 +01:00
6 changed files with 66 additions and 5 deletions
+2
View File
@@ -25,3 +25,5 @@ ENABLE_DERP=false
# See https://git.coopcloud.tech/coop-cloud/backup-bot-two
ENABLE_BACKUPS=true
# The amount of time a node is authenticated, default is set to 7d
#EXPIRY=0
+35
View File
@@ -0,0 +1,35 @@
# Headscale Recipe Maintenance
All contributions should be made via a pull request. This is to ensure a
certain quality and consistency, that others can rely on.
## Maintainer Responsibilities
`3wc` is responsible for installing regular updates:
- Patch and minor updates within a week of them being released upstream
- Major updates within a month of them being released upstream
`ammaratef45` is responsible for responding to pull requests and issues, within a week of them being filed.
`val` is available as backup for both of these tasks.
In order to fulfill these responsibilities a recipe maintainer:
- Has to watch the repository (to get notifications)
- Needs to make sure Renovate is configured properly
## Pull Requests
A pull request can be merged if it is approved by at least one maintainer. For
pull requests opened by a maintainer they need to be approved by another
maintainer. Even though it is okay to merge a pull request with one approval, it
is always better if all maintainers looked at the pull request and approved it.
## Become a maintainer
Everyone can apply to be a recipe maintainer:
1. Watch the repository to always get updates
2. Simply add yourself to the list in the [README.md](./README.md), add yourself to whichever things you would like to be (co) responsible for in this document, then open a new pull request with the change.
3. Once the pull request gets merged you will be added to the [headscale maintainers team](https://git.coopcloud.tech/org/coop-cloud/teams/headscale-maintainers).
+23 -1
View File
@@ -4,8 +4,10 @@
<!-- metadata -->
* **Maintainer**: [@3wc](https://git.coopcloud.tech/3wordchant), [@ammaratef45](https://git.coopcloud.tech/ammaratef45), [@val](https://git.coopcloud.tech/val)
* **Status**: `stable`
* **Category**: Apps
* **Status**: 3
* **Features**: 3
* **Image**: [`headscale/headscale`](https://hub.docker.com/r/headscale/headscale), 4, upstream
* **Healthcheck**: Yes
* **Backups**: Yes
@@ -22,3 +24,23 @@
* `abra app deploy <app-name>`
For more, see [`docs.coopcloud.tech`](https://docs.coopcloud.tech).
## Getting started using headscale
The recipe deploys two containers.
1. One is headscale itself. Note that it's a "distroless" container, so you can't enter with `bash` or `sh`, but you have to run the commands directly.
> 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 your application running in the Docker container, you can use the -debug variant, for example headscale/headscale:x.x.x-debug.
>
> https://headscale.net/0.24.1/setup/install/container/#debugging-headscale-running-in-docker
To run the command line do this:
```bash
abra app run yourapp.xyz app -- headscale help
```
2. The UI runs on `https://yourapp.xyz/web`, the UI is a mere frontend (a static site), so no data is saved on a server, so you will need to set URL and API-Key yourself on every client. Find more about the UI [here](https://github.com/gurucomputing/headscale-ui).
For the usage of headscale itself, check the [offical docs](https://headscale.net/stable/usage/getting-started/).
+1 -1
View File
@@ -1,3 +1,3 @@
# Set any config versions here
# Docs: https://docs.coopcloud.tech/maintainers/handbook/#manage-configs
export CONFIG_YAML_VERSION=v4
export CONFIG_YAML_VERSION=v5
+4 -2
View File
@@ -8,6 +8,8 @@ services:
volumes:
# - config:/etc/headscale
- data:/var/lib/headscale
environment:
EXPIRY: ${EXPIRY:-7d}
configs:
- source: config_yaml
target: /etc/headscale/config.yaml
@@ -20,7 +22,7 @@ services:
- "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`${EXTRA_DOMAINS})"
- "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
- "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
- "coop-cloud.${STACK_NAME}.version=0.1.0+v0.28"
- "coop-cloud.${STACK_NAME}.version=0.3.0+v0.28"
# Enable backups: https://docs.coopcloud.tech/maintainers/handbook/#how-do-i-configure-backuprestore
- "backupbot.backup=${ENABLE_BACKUPS:-true}"
- "backupbot.backup.path=/var/lib/headscale"
@@ -32,7 +34,7 @@ services:
start_period: 1m
ui:
image: ghcr.io/gurucomputing/headscale-ui:2025.08.23
image: ghcr.io/gurucomputing/headscale-ui:2026.03.17
deploy:
labels:
- traefik.enable=true
+1 -1
View File
@@ -348,7 +348,7 @@ oidc:
# The amount of time a node is authenticated with OpenID until it expires
# and needs to reauthenticate.
# Setting the value to "0" will mean no expiry.
expiry: 7d
expiry: {{ env "EXPIRY" }}
# Use the expiry from the token received from OpenID when the user logged
# in. This will typically lead to frequent need to reauthenticate and should