Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

nixos/acme: fix documentation build #111186

Closed
wants to merge 1 commit into from
Closed

nixos/acme: fix documentation build #111186

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Jan 29, 2021

Motivation for this change

#100356 broke the NixOS manual build:

manual-combined.xml:7474: element link: validity error : IDREF attribute linkend references an unknown ID "users.users._name_.extraGroups"
  7470
  7471  # /var/lib/acme/.challenges must be writable by the ACME user
  7472  # and readable by the Nginx user. The easiest way to achieve
  7473  # this is to add the Nginx user to the ACME group.
  7474  <link linkend="users.users._name_.extraGroups">users.users.nginx.extraGroups</link> = [ "acme" ];
  7475
  7476  services.nginx = {

manual-combined.xml:7492: element link: validity error : IDREF attribute linkend references an unknown ID "users.users._name_.extraGroups"
  7488      };
  7489    };
  7490  }
  7491  # Alternative config for Apache
  7492  <link linkend="users.users._name_.extraGroups">users.users.wwwrun.extraGroups</link> = [ "acme" ];
  7493  services.httpd = {
  7494    <link linkend="opt-services.httpd.enable">enable = true;</link>

manual-combined.xml fails to validate
builder for '/nix/store/66wp67l65wbnkdwdl0lv9l41b37ynfh4-nixos-manual-combined.drv' failed with exit code 3

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS linux)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Ensured that relevant documentation is up to date
  • Fits CONTRIBUTING.md.

@ghost ghost requested review from flokli and m1cr0man January 29, 2021 17:53
@ghost
Copy link
Author

ghost commented Jan 29, 2021

dfb2bc8 has done the same change.

@ghost ghost closed this Jan 29, 2021
@m1cr0man
Copy link
Contributor

Ah, sorry about that 😖 I usually do a full docs build before I make docs PRs, but I must not have on that PR.

@ghost ghost deleted the feature/fix-acme-manual branch January 30, 2021 01:04
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant