danvics/selfhostblocks
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

update documentation on how to implement a service

Browse source
This commit is contained in:
ibizaman 2025-07-12 21:50:52 +02:00 committed by Pierre Penninckx
parent 13f4064e93
commit 1a5ecc9328
1 changed files with 8 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/service-implementation-guide.md
View file

@ -381,14 +381,16 @@ source: @OPTIONS_JSON@
Note: Replace `servicename` with your actual service name (e.g., `nzbget`, `jellyfin`).
For the `@OPTIONS_JSON@` to work, the following snippet must be added
in the `docs/default.nix` file.
For the `@OPTIONS_JSON@` to work, a line must be added
in the `flake.nix` file:
```nix
substituteInPlace ./modules/services/servicename/docs/default.md \
--replace \
'@OPTIONS_JSON@' \
${individualModuleOptionsDocs [ ../modules/services/servicename.nix ]}/share/doc/nixos/options.json
packages.manualHtml = pkgs.callPackage ./docs {
modules = {
"blocks/authelia" = ./modules/blocks/authelia.nix;
// Add line and keep in alphabetical order.
};
};
```
### 7. Update Redirects Automatically {#update-redirects-automatically}