From ffbf1085afc0f2be3aa73d05094e995269e41cd7 Mon Sep 17 00:00:00 2001 From: RGBCube Date: Sat, 30 Dec 2023 14:06:30 +0300 Subject: [PATCH] Document NixOS module options --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a72b708..9d1f4a2 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,31 @@ The official website and link portal of RGBCube and his work. ## Running -Simply run `nix run`. This will run the page at `0.0.0.0:80`. +The flake provides a NixOS module, you can use it by adding the flake to your +inputs and then adding `site.nixosModules.default` to the `modules` parameter +on the call set to `nixpkgs.lib.nixosSystem`. + +Check out the options to configure the service. + +### Options + +#### `services.site.enable` + +Enables the site service. + +Default: false. + +#### `services.site.port` + +Specifies on which port the site service listens for connections. + +Default: 8080. + +#### `services.site.openFirewall` + +Whether to open the firewall port for the tcp listener. + +Default: false. ## License