dahjah/headplane
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

docs: improve Nix documentation

Browse Source 
* Reflect recent changes.
* Link `Nix` in README
This commit is contained in:
Igor Ramazanov 2025-03-12 13:32:02 +00:00
parent 654d09b44d
commit 4e886c1a5b
2 changed files with 51 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -74,4 +74,12 @@ There are 2 ways to deploy Headplane:
>
</picture>
### NixOS Deployment
Integration with Nix provided:
* development environment
* building packages
* NixOS module
See [./docs/Nix.md](./docs/Nix.md) for details.
> Copyright (c) 2025 Aarnav Tale

57
docs/Nix.md
View File

@ -28,8 +28,15 @@ git+file:///home/igor/personal/headplane?ref=refs/heads/nix&rev=2d78a95a0648a377
└───headplane-agent: package 'hp_agent-0.5.3-SNAPSHOT'
```
## NixOS module options
Defined as `services.headplane.*`, check the `./nix/` directory for details.
## Usage
1. Add the `github:tale/headplane` flake input.
2. Import a default overlay to add `pkgs.headplane` and `pkgs.headplane-agent`.
3. Import NixOS module for `services.headplane.*`.
```nix
# Your flake.nix
{
@ -56,36 +63,58 @@ git+file:///home/igor/personal/headplane?ref=refs/heads/nix&rev=2d78a95a0648a377
nixpkgs.overlays = [ headplane.overlays.default ];
}
{
{config, pkgs, ...}: {
services.headplane = let
headscaleConfig =
(pkgs.formats.yaml {}).generate
"headscale-for-headplane.yml"
config.services.headscale.settings;
in {
{config, pkgs, ...}:
let
format = pkgs.formats.yaml {};
# A workaround generate a valid Headscale config accepted by Headplane when `config_strict == true`.
settings = lib.recursiveUpdate config.services.headscale.settings {
acme_email = "/dev/null";
tls_cert_path = "/dev/null";
tls_key_path = "/dev/null";
policy.path = "/dev/null";
oidc.client_secret_path = "/dev/null";
};
headscaleConfig = format.generate "headscale.yml" settings;
in {
services.headplane = {
enable = true;
agent.enable = false;
agent = {
# As an example only.
# Headplane Agent hasn't yet been ready at the moment of writing the doc.
enable = true;
settings = {
HEADPLANE_AGENT_DEBUG = true;
HEADPLANE_AGENT_HOSTNAME = "localhost";
HEADPLANE_AGENT_TS_SERVER = "https://example.com";
HEADPLANE_AGENT_TS_AUTHKEY = "xxxxxxxxxxxxxx";
HEADPLANE_AGENT_HP_SERVER = "https://example.com/admin/dns";
HEADPLANE_AGENT_HP_AUTHKEY = "xxxxxxxxxxxxxx";
};
};
settings = {
server = {
host = "127.0.0.1";
port = 3000;
cookie_secret = "replace me";
cookie_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
cookie_secure = true;
};
headscale = {
url = "https://example.com";
config_path = "${headscaleConfig}";
config_strict = false;
config_strict = true;
};
integration.proc.enabled = true;
oidc = {
issuer = "https://authelia.example.com";
issuer = "https://oidc.example.com";
client_id = "headplane";
client_secret = "replace me";
client_secret = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
disable_api_key_login = true;
# Might needed when integrating with Authelia.
token_endpoint_auth_method = "client_secret_basic";
headscale_api_key = "replace me";
redirect_uri = "https://authelia.example.com/admin/oidc/callback";
headscale_api_key = "xxxxxxxxxx.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
redirect_uri = "https://oidc.example.com/admin/oidc/callback";
};
};
};