feedback on first install

Having discovered the buildbot via the various nix-community projects, I tried to deploy my own server to be used in github actions. Here is some preliminary feedback that I might complete later - Copy/pasting readme's github example I got the error `missing domain` , e.g., it should probably be added to the xample ? - trying to deploy I then got greeted with: ``` … while calling the 'throw' builtin at «github:nix-community/buildbot-nix/cd32d1c420320383bfcc80c1b0b402b6a7eccc23?narHash=sha256-kPP7k2b%2BDkd91yJO01y3l1F0t%2BMqvv8%2BFrPfjcCwszg%3D»/nixosModules/niks3.nix:34:24: 33| default = 34| pkgs.niks3 or (throw "niks3 package not found in pkgs. Please add niks3 flake input and overlay."); | ^ 35| description = "The niks3 package to use"; error: niks3 package not found in pkgs. Please add niks3 flake input and overlay. ``` I didn't know about niks3 and had to look it up. Seems like it's a nix cache. I have harmonia already setup so I tried to disable it ``` niks3 = { enable = false; package = pkgs.hello; }; ``` but that was not enough as the eval fails when generate the nixos manpage. Turns out the nixosModule triggers quite a few errors when you have this in your nixos config: ``` documentation.nixos = { # to get manpages enable = true; # adds home-manager and my own option as well to man configuration.nix includeAllModules = true; # had to set it to false because of buildbot-nix options.warningsAreErrors = false; }; ``` A few excerpts: ``` - error: attribute 'buildbot-master' missing at «github:teto/buildbot-nix/63c01b65bb9338ea2a53ab4b51fc439d1060883f»/nixosModules/master.nix:575:19: 574| example = "https://buildbot-webhooks.numtide.com/"; 575| default = config.services.buildbot-master.buildbotUrl error: attribute 'hostName' missing at /home/teto/buildbot-nix/nixosModules/worker.nix:51:19: 50| type = lib.types.str; 51| default = config.networking.hostName; > error: option services.buildbot-nix.master.accessMode has no description > error: option services.buildbot-nix.master.accessMode.fullyPrivate.backend has no description > error: option services.buildbot-nix.master.cachix.auth has no description > error: option services.buildbot-nix.master.pullBased.repositories has no description > error: option services.buildbot-nix.packages.buildbot has no description > error: option services.buildbot-nix.packages.buildbot-effects has no description > error: option services.buildbot-nix.packages.buildbot-gitea has no description > error: option services.buildbot-nix.packages.buildbot-nix has no description > error: option services.buildbot-nix.packages.buildbot-plugins has no description > error: option services.buildbot-nix.packages.buildbot-worker has no description > Treating warnings as errors. Set documentation.nixos.options.warningsAreErrors to false to ignore these warnings. ``` I believe the niks3 module should be disabled by default to avoid trigger errors. The defaults should be reworked such that one's config doesn't appear in the nixos doc. Here are the hacks I made to fix eval: https://github.com/teto/buildbot-nix/tree/teto/hack-niks3-eval-error - doc https://github.com/nix-community/buildbot-nix#step-2-configure-buildbot-nix says oauth is optional for github but the code says otherwise. - `workersFile` has no example, had to lookup the repo test. Aka it can look like this: ``` pkgs.writeText "workers.json" '' [ { "name": "eve", "pass": "XXXXXXXXXXXXXXXXXXXX", "cores": 16 } ] ```