headscale/nix/README.md

Headscale NixOS Module

This directory contains the NixOS module for Headscale.

Rationale

The module is maintained in this repository to keep the code and module synchronized at the same commit. This allows faster iteration and ensures the module stays compatible with the latest Headscale changes. All changes should aim to be upstreamed to nixpkgs.

Files

• module.nix - The NixOS module implementation
• example-configuration.nix - Example configuration demonstrating all major features
• tests/ - NixOS integration tests

Usage

Add to your flake inputs:

inputs.headscale.url = "github:juanfont/headscale";

Then import the module:

imports = [ inputs.headscale.nixosModules.default ];

See example-configuration.nix for configuration options.

Upstream

• nixpkgs module
• nixpkgs package

The module in this repository may be newer than the nixpkgs version.