public/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

nixos/dokuwiki: modify usersFile and aclFile

Browse Source 
Use types.str instead of types.path to exclude private information from
the derivation.
Add a warinig about the contents of acl beeing included in the nix
store.
This commit is contained in:
dadada 2020-04-04 14:01:23 +02:00
parent 2b67a89f29
commit 9460fb5788
No known key found for this signature in database
GPG Key ID: EEB8D1CE62C4DFEA
1 changed files with 15 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
nixos/modules/services/web-apps/dokuwiki.nix
View File

@ -87,11 +87,14 @@ let
Access Control Lists: see <link xlink:href="https://www.dokuwiki.org/acl"/> Access Control Lists: see <link xlink:href="https://www.dokuwiki.org/acl"/>
Mutually exclusive with services.dokuwiki.aclFile Mutually exclusive with services.dokuwiki.aclFile
Set this to a value other than null to take precedence over aclFile option. Set this to a value other than null to take precedence over aclFile option.
Warning: Consider using aclFile instead if you do not
want to store the ACL in the world-readable Nix store.
''; '';
}; };
aclFile = mkOption { aclFile = mkOption {
type = types.nullOr types.path; type = with types; nullOr str;
default = null; default = null;
description = '' description = ''
Location of the dokuwiki acl rules. Mutually exclusive with services.dokuwiki.acl Location of the dokuwiki acl rules. Mutually exclusive with services.dokuwiki.acl
@ -99,6 +102,7 @@ let
Consult documentation <link xlink:href="https://www.dokuwiki.org/acl"/> for further instructions. Consult documentation <link xlink:href="https://www.dokuwiki.org/acl"/> for further instructions.
Example: <link xlink:href="https://github.com/splitbrain/dokuwiki/blob/master/conf/acl.auth.php.dist"/> Example: <link xlink:href="https://github.com/splitbrain/dokuwiki/blob/master/conf/acl.auth.php.dist"/>
''; '';
example = "/var/lib/dokuwiki/${name}/acl.auth.php";
}; };
aclUse = mkOption { aclUse = mkOption {
@ -135,14 +139,15 @@ let
}; };
usersFile = mkOption { usersFile = mkOption {
type = types.nullOr types.path; type = with types; nullOr str;
default = "/var/lib/dokuwiki/${name}/users.php"; default = null;
description = '' description = ''
Location of the dokuwiki users file. List of users. Format: Location of the dokuwiki users file. List of users. Format:
login:passwordhash:Real Name:email:groups,comma,separated login:passwordhash:Real Name:email:groups,comma,separated
Create passwordHash easily by using:$ mkpasswd -5 password `pwgen 8 1` Create passwordHash easily by using:$ mkpasswd -5 password `pwgen 8 1`
Example: <link xlink:href="https://github.com/splitbrain/dokuwiki/blob/master/conf/users.auth.php.dist"/> Example: <link xlink:href="https://github.com/splitbrain/dokuwiki/blob/master/conf/users.auth.php.dist"/>
''; '';
example = "/var/lib/dokuwiki/${name}/users.auth.php";
}; };
disableActions = mkOption { disableActions = mkOption {
@ -284,11 +289,11 @@ in
assertions = flatten (mapAttrsToList (hostName: cfg: assertions = flatten (mapAttrsToList (hostName: cfg:
[{ [{
assertion = cfg.aclUse -> (cfg.acl != null || cfg.aclFile != null); assertion = cfg.aclUse -> (cfg.acl != null || cfg.aclFile != null);
message = "Either services.dokuwiki.${hostName}.acl or services.dokuwiki.${hostName}.aclFile is mandatory when aclUse is true"; message = "Either services.dokuwiki.${hostName}.acl or services.dokuwiki.${hostName}.aclFile is mandatory if aclUse true";
} }
{ {
assertion = cfg.usersFile != null -> cfg.aclUse != false; assertion = cfg.usersFile != null -> cfg.aclUse != false;
message = "services.dokuwiki.${hostName}.aclUse must be true when usersFile is not null"; message = "services.dokuwiki.${hostName}.aclUse must must be true if usersFile is not null";
} }
]) eachSite); ]) eachSite);
@ -299,6 +304,7 @@ in
phpEnv = { phpEnv = {
DOKUWIKI_LOCAL_CONFIG = "${dokuwikiLocalConfig cfg}"; DOKUWIKI_LOCAL_CONFIG = "${dokuwikiLocalConfig cfg}";
DOKUWIKI_PLUGINS_LOCAL_CONFIG = "${dokuwikiPluginsLocalConfig cfg}"; DOKUWIKI_PLUGINS_LOCAL_CONFIG = "${dokuwikiPluginsLocalConfig cfg}";
} // optionalAttrs (cfg.usersFile != null) {
DOKUWIKI_USERS_AUTH_CONFIG = "${cfg.usersFile}"; DOKUWIKI_USERS_AUTH_CONFIG = "${cfg.usersFile}";
} //optionalAttrs (cfg.aclUse) { } //optionalAttrs (cfg.aclUse) {
DOKUWIKI_ACL_AUTH_CONFIG = if (cfg.acl != null) then "${dokuwikiAclAuthConfig cfg}" else "${toString cfg.aclFile}"; DOKUWIKI_ACL_AUTH_CONFIG = if (cfg.acl != null) then "${dokuwikiAclAuthConfig cfg}" else "${toString cfg.aclFile}";
@ -314,7 +320,7 @@ in
services.nginx = { services.nginx = {
enable = true; enable = true;
virtualHosts = mapAttrs (hostName: cfg: mkMerge [ cfg.nginx { virtualHosts = mapAttrs (hostName: cfg: mkMerge [ cfg.nginx {
root = mkForce "${pkg hostName cfg}/share/dokuwiki/"; root = mkForce "${pkg hostName cfg}/share/dokuwiki";
extraConfig = "fastcgi_param HTTPS on;"; extraConfig = "fastcgi_param HTTPS on;";
locations."~ /(conf/|bin/|inc/|install.php)" = { locations."~ /(conf/|bin/|inc/|install.php)" = {
@ -370,8 +376,9 @@ in
"d ${cfg.stateDir}/meta 0750 ${user} ${group} - -" "d ${cfg.stateDir}/meta 0750 ${user} ${group} - -"
"d ${cfg.stateDir}/pages 0750 ${user} ${group} - -" "d ${cfg.stateDir}/pages 0750 ${user} ${group} - -"
"d ${cfg.stateDir}/tmp 0750 ${user} ${group} - -" "d ${cfg.stateDir}/tmp 0750 ${user} ${group} - -"
"C ${cfg.usersFile} 0640 ${user} ${group} - ${pkg hostName cfg}/share/dokuwiki/conf/users.auth.php.dist" ] ++ lib.optional (cfg.aclFile != null) "C ${cfg.aclFile} 0640 ${user} ${group} - ${pkg hostName cfg}/share/dokuwiki/conf/acl.auth.php.dist"
]) eachSite); ++ lib.optional (cfg.usersFile != null) "C ${cfg.usersFile} 0640 ${user} ${group} - ${pkg hostName cfg}/share/dokuwiki/conf/users.auth.php.dist"
) eachSite);
users.users.${user} = { users.users.${user} = {
group = group; group = group;