https://github.com/kazauwa/ansible-role-headscale
Ansible role for Headscale
https://github.com/kazauwa/ansible-role-headscale
ansible headscale tailscale tailscale-control-server tailscale-server
Last synced: 2 months ago
JSON representation
Ansible role for Headscale
- Host: GitHub
- URL: https://github.com/kazauwa/ansible-role-headscale
- Owner: kazauwa
- License: mit
- Created: 2022-05-02T11:29:03.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-02-25T22:01:14.000Z (4 months ago)
- Last Synced: 2025-04-09T17:14:30.800Z (2 months ago)
- Topics: ansible, headscale, tailscale, tailscale-control-server, tailscale-server
- Language: Jinja
- Homepage:
- Size: 52.7 KB
- Stars: 33
- Watchers: 3
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.MD
- License: LICENSE
Awesome Lists containing this project
README
# Ansible Role for Headscale
A role that installs and manages [Headscale](https://github.com/juanfont/headscale) on Linux.
## Requirements
- Ansible >= 7
## Installation
```shell
ansible-galaxy install kazauwa.headscale
```
## Role Variables
- `headscale_version`
- Default: `0.23.0`
- Description: version of Headscale to install. List of avaliable versions can be found on [official releases page](https://github.com/juanfont/headscale/releases). Defaults to the latest avaliable.
- `headscale_arch`
- Default: `amd64`
- Description: headscale binary target architecture.
- `headscale_os`
- Default: `linux`
- Description: headscale binary target OS.
- `headscale_user_name`
- Default: `headscale`
- Description: name for service user for running Headscale binary.
- `headscale_user_group`
- Default: `headscale`
- Description: group for service user for running Headscale binary.
- `headscale_user_uid`
- Default: `800`
- Description: uid for service user for running Headscale binary.
- `headscale_user_gid`
- Default: `800`
- Description: gid for service user for running Headscale binary.
- `headscale_binary_path`
- Default: `/usr/local/bin/headscale`
- Description: path for installing headscale binary.
- `headscale_config_dir`
- Default: `/etc/headscale`
- Description: path to headscale configs.
- `headscale_var_data_dir`
- Default: `/var/lib/headscale`
- Description: path to headscale data.
- `headscale_pid_dir`
- Default: `/var/run/headscale`
- Description: path to headscale socket.
- `headscale_config`
- Default: `{}`
- Description: yaml formatted headscale config, consider using [default config](https://github.com/juanfont/headscale/blob/main/config-example.yaml) as a starting point.
- `headscale_config_template`
- Default: `""`
- Description: path to Jinja2 formatted headscale config template. If present, will override `headscale_config`.
- `headscale_acl_file`
- Default: `""`
- Description: path to HuJSON formatted headscale acl file. **Make sure** that you've read the [docs](https://github.com/juanfont/headscale/blob/main/docs/ref/acls.md) on how to use this feature and the HuJSON syntax [acl-syntax](https://tailscale.com/kb/1337/acl-syntax).
- `headscale_users`
- Default: `[]`
- Description: list of users to create, e.g. to use with tagOwners.
- `headscale_enable_routes`
- Default: `[]`
- Description: list of nodes with advertised routes to enable. Accepts an integer id of headscale node, list of comma-separated routes and an optional comment to output during execution. Used when [autoApprovers](https://tailscale.com/kb/1018/acls/#auto-approvers-for-routes-and-exit-nodes) are not set.
- Example: `{'id': 14, 'routes': '10.0.0.0/24,10.2.3.4/32', 'comment': 'Gateway to prod'}`
- `headscale_exit_nodes`
- Default: `[]`
- Description: list of nodes acting as an exit node. Accepts an integer id of headscale node and an optional comment to output during execution. Used when [autoApprovers](https://tailscale.com/kb/1018/acls/#auto-approvers-for-routes-and-exit-nodes) are not set.
- Example: `{'id': 14, 'comment': 'eu-fra-01'}`
## Dependencies
None.
## Example Playbook
- hosts: all
roles:
- kazauwa.headscale
vars:
headscale_version: '0.22.3'
## License
MIT