nixos-router
Jump to
↵select↑↓navigateescclose

Reference

Reference

Lookup pages for nixos-router, covering Cloudflare API tokens, ports and services, the settings file and its JSON schema.

On this page

These pages collect details that several features share. Use them to look something up rather than to follow a task from start to finish.

  • Cloudflare API tokens: the permissions each Cloudflare feature needs, the default token files, and how to create, store, rotate and remove tokens.

  • Ports and services: the ports the router listens on and the services behind them.

  • The settings file: /etc/nixos/router-settings.json, the file the Cockpit settings pages read and write.

Settings schema

Every key the settings file accepts, with its type, default and description, is listed in the JSON Schema at pkgs/cockpit-router/src/router-settings.schema.json in the repository. It's generated from the router's NixOS options, and Cockpit checks the settings file against it before it applies a change.