gsadmin/headplane
1
0
Fork 0
mirror of https://github.com/tale/headplane.git synced 2026-08-31 17:28:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Cleanup doc and set sane defaults

Browse Source
This commit is contained in:
StealthBadger747
2025-05-20 14:24:17 -07:00
committed by Aarnav Tale
parent e0fde7d0f4
commit 441e31690b
2 changed files with 17 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Nix.md
+13 -17
View File
@@ -165,43 +165,39 @@ The Headplane NixOS module provides the following options under `services.headpl
# Configure the Headplane server application # Configure the Headplane server application
settings = { settings = {
server = { server = {
# host = "0.0.0.0"; # Default: bind to all interfaces # host = "127.0.0.1";
# port = 3000; # Default port # port = 3000;
cookie_secret_path = config.sops.secrets.headplane_cookie_secret.path; cookie_secret_path = config.sops.secrets.headplane_cookie_secret.path;
# cookie_secret = "your-32-character-secret"; # Alternative to cookie_secret_path
cookie_secure = true; cookie_secure = true;
agent = { agent = {
enabled = false; enabled = false;
# authkey = "your-agent-authkey"; # Alternative to authkey_path
# authkey_path = config.sops.secrets.headplane_server_agent_authkey.path; # authkey_path = config.sops.secrets.headplane_server_agent_authkey.path;
# ttl = 180000; # Default: 3 minutes in milliseconds # ttl = 180000; # milliseconds
# cache_path = "/var/lib/headplane/agent_cache.json"; # Default cache location # cache_path = "/var/lib/headplane/agent_cache.json";
}; };
}; };
headscale = { headscale = {
# url = "http://127.0.0.1:8080"; # Default Headscale URL # url = "http://127.0.0.1:8080";
config_path = headscaleConfig; # Use the generated config file config_path = headscaleConfig; # Use the generated config file
# config_strict = true; # Default: strict config validation # config_strict = true;
# tls_cert = "your-tls-cert"; # Alternative to tls_cert_path # tls_cert = "your-tls-cert"; # Alternative to tls_cert_path
# tls_cert_path = config.sops.secrets.headplane_tls_cert.path; # tls_cert_path = config.sops.secrets.headplane_tls_cert.path;
# tls_key = "your-tls-key"; # Alternative to tls_key_path # tls_key = "your-tls-key"; # Alternative to tls_key_path
# tls_key_path = config.sops.secrets.headplane_tls_key.path; # tls_key_path = config.sops.secrets.headplane_tls_key.path;
}; };
integration.proc.enabled = true;
oidc = { oidc = {
# issuer = ""; # Default: empty # issuer = "";
# client_id = ""; # Default: empty # client_id = "";
client_secret_path = config.sops.secrets.headplane_oidc_client_secret.path; # client_secret_path = config.sops.secrets.headplane_oidc_client_secret.path;
# client_secret = "your_oidc_client_secret"; # Alternative to client_secret_path # client_secret = "your_oidc_client_secret"; # Alternative to client_secret_path
# disable_api_key_login = false; # Default: allow API key login # disable_api_key_login = false;
# token_endpoint_auth_method = "client_secret_post"; # Default auth method # token_endpoint_auth_method = "client_secret_post";
headscale_api_key_path = config.sops.secrets.headplane_headscale_api_key.path; # headscale_api_key_path = config.sops.secrets.headplane_headscale_api_key.path;
# headscale_api_key = "your_headscale_api_key"; # Alternative to headscale_api_key_path # headscale_api_key = "your_headscale_api_key"; # Alternative to headscale_api_key_path
redirect_uri = "https://headscale.example.com/admin/oidc/callback"; # redirect_uri = "";
}; };
}; };
}; };
nix/module.nix
+4 -9
View File
@@ -50,9 +50,9 @@ in {
options = { options = {
host = lib.mkOption { host = lib.mkOption {
type = lib.types.str; type = lib.types.str;
default = "0.0.0.0"; default = "127.0.0.1";
description = "The host address to bind to."; description = "The host address to bind to.";
example = "127.0.0.1"; example = "0.0.0.0";
}; };
port = lib.mkOption { port = lib.mkOption {
@@ -67,7 +67,6 @@ in {
description = '' description = ''
Path to a file containing the cookie secret. Path to a file containing the cookie secret.
The secret must be exactly 32 characters long. The secret must be exactly 32 characters long.
Can be used instead of cookie_secret.
''; '';
example = "config.sops.secrets.headplane_cookie.path"; example = "config.sops.secrets.headplane_cookie.path";
}; };
@@ -90,7 +89,6 @@ in {
default = null; default = null;
description = '' description = ''
Path to a file containing the agent auth key. Path to a file containing the agent auth key.
Can be used instead of authkey.
''; '';
example = "config.sops.secrets.agent_authkey.path"; example = "config.sops.secrets.agent_authkey.path";
}; };
@@ -137,7 +135,6 @@ in {
default = null; default = null;
description = '' description = ''
Path to a file containing the TLS certificate. Path to a file containing the TLS certificate.
Can be used instead of tls_cert.
''; '';
example = "config.sops.secrets.tls_cert.path"; example = "config.sops.secrets.tls_cert.path";
}; };
@@ -147,7 +144,6 @@ in {
default = null; default = null;
description = '' description = ''
Path to a file containing the TLS private key. Path to a file containing the TLS private key.
Can be used instead of tls_key.
''; '';
example = "config.sops.secrets.tls_key.path"; example = "config.sops.secrets.tls_key.path";
}; };
@@ -213,7 +209,7 @@ in {
type = lib.types.str; type = lib.types.str;
default = ""; default = "";
description = "URL to OpenID issuer."; description = "URL to OpenID issuer.";
example = "https://authentik.parawell.cloud/application/o/test-headscale/"; example = "https://provider.example.com/issuer-url";
}; };
client_id = lib.mkOption { client_id = lib.mkOption {
@@ -228,7 +224,6 @@ in {
default = null; default = null;
description = '' description = ''
Path to a file containing the OIDC client secret. Path to a file containing the OIDC client secret.
Can be used instead of client_secret.
''; '';
example = "config.sops.secrets.oidc_client_secret.path"; example = "config.sops.secrets.oidc_client_secret.path";
}; };
@@ -253,13 +248,13 @@ in {
default = null; default = null;
description = '' description = ''
Path to a file containing the Headscale API key. Path to a file containing the Headscale API key.
Can be used instead of headscale_api_key.
''; '';
example = "config.sops.secrets.headscale_api_key.path"; example = "config.sops.secrets.headscale_api_key.path";
}; };
redirect_uri = lib.mkOption { redirect_uri = lib.mkOption {
type = lib.types.str; type = lib.types.str;
default = "";
description = '' description = ''
This should point to your publicly accessible URL This should point to your publicly accessible URL
for your Headplane instance with /admin/oidc/callback. for your Headplane instance with /admin/oidc/callback.