RGBCube/Site
1
Fork 0
mirror of https://github.com/RGBCube/Site synced 2025-08-03 06:27:46 +00:00
Code Issues Activity Actions

Document NixOS module options

Browse source
This commit is contained in:
RGBCube 2023-12-30 14:06:30 +03:00
parent e1da2eabcb
commit ffbf1085af
No known key found for this signature in database
1 changed files with 25 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -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