Imported from Zuescho/gotenberg-nixos (
AGENTS.md). Install upstream withnpx skills add Zuescho/gotenberg-nixos. Copyright stays with the author.
Rules for coding agents
This repository deploys a LAN-only Gotenberg for Stadt Düren. Follow these rules on every change.
- Never push to
main. Commit and push only on a feature branch, and open or update a pull request againstmain. - Host-specific values live only in
hosts/gotenberg/site.nix. Leave the committed placeholders (CHANGE_ME, theREPLACE_MESSH key comment,10.0.10.20,10.0.20.0/24). Do not commit a real address plan, a real public key that replaces the placeholder onmain's history without a request to do so, a password hash, or anything from/var/lib/secrets. - Do not add a
LICENSEfile. The maintainer is choosing the license. The README states the current terms. - Do not publish the Gotenberg port on a non-loopback address. Proxy mode publishes
127.0.0.1only. Direct mode uses the host network and--api-bind-ip. The firewall, notallowedTCPPorts, is the access control. - Factur-X examples use
POST /forms/pdfengines/factur-xwithfacturxXmlandfacturxConformanceLevelset toEN 16931orXRECHNUNG. - Format Nix with
nix fmt. The flakeformatteroutput isnixfmt-tree(nixfmt 1.5, RFC 166, the package formerly callednixfmt-rfc-style). - Before you finish, run
nix flake checkandnix build .#nixosConfigurations.gotenberg.config.system.build.toplevel.nix flake checkincludes the NixOS closure andnixfmt --check. - Flakes only see tracked files.
git addNix changes before those commands.
