nixos/nextcloud: allow more declarative config

This adds two options to the nextcloud module, with the aim of allowing
the entirety of `config.php` to be set declaratively:
1. `services.nextcloud.extraOptions`, which takes free-form options
   given as an attribute set, and reads them in via json from the php
   side (which lets us prevent syntax errors in php, if not key errors –
   given the full length of nextcloud's potential options, I don't think
   specifying them all via Nix is a viable option)
2. `services.nextcloud.secretFile`, which takes a path to a json file
   specifying options which a user may want to keep secret and not add
   to their nix store; this file is read in the same way on startup by
   php, and may even overwrite options set in some other way.
This commit is contained in:
stuebinm 2021-03-30 18:20:28 +02:00
parent 24466250ec
commit 4ca2f27a60
No known key found for this signature in database
GPG key ID: 8FBE8AAD32FA12B7

View file

@ -367,6 +367,32 @@ in {
The nextcloud-occ program preconfigured to target this Nextcloud instance. The nextcloud-occ program preconfigured to target this Nextcloud instance.
''; '';
}; };
extraOptions = mkOption {
type = with types; attrsOf anything;
default = {};
description = ''
Extra options which should be appended to nextcloud's config.php file.
'';
example = {
redis = {
host = "/run/redis/redis.sock";
port = 0;
dbindex = 0;
password = "secret";
timeout = 1.5;
};
};
};
secretFile = mkOption {
type = types.nullOr types.str;
default = null;
description = ''
Secret options which will be appended to nextcloud's config.php file (written as JSON, in the same
form as the `extraOptions` option), for example '{"redis":{"password":"secret","timeout"=2}}'.
'';
};
}; };
config = mkIf cfg.enable (mkMerge [ config = mkIf cfg.enable (mkMerge [
@ -457,6 +483,19 @@ in {
return trim(file_get_contents($file)); return trim(file_get_contents($file));
} }
''} ''}
${optionalString (cfg.secretFile != null) ''
function nix_read_secrets() {
$file = "${cfg.secretFile}";
if (!file_exists($file)) {
throw new \RuntimeException(sprintf(
"Cannot start Nextcloud, secrets file %s set by NixOS doesn't exist!",
$file
));
}
return json_decode(file_get_contents($file));
}
''}
$CONFIG = [ $CONFIG = [
'apps_paths' => [ 'apps_paths' => [
[ 'path' => '${cfg.home}/apps', 'url' => '/apps', 'writable' => false ], [ 'path' => '${cfg.home}/apps', 'url' => '/apps', 'writable' => false ],
@ -480,6 +519,11 @@ in {
'trusted_proxies' => ${writePhpArrary (c.trustedProxies)}, 'trusted_proxies' => ${writePhpArrary (c.trustedProxies)},
${optionalString (c.defaultPhoneRegion != null) "'default_phone_region' => '${c.defaultPhoneRegion}',"} ${optionalString (c.defaultPhoneRegion != null) "'default_phone_region' => '${c.defaultPhoneRegion}',"}
]; ];
$EXTRACONFIG = json_decode('${builtins.toJSON cfg.extraOptions}', true);
array_push($CONFIG, $EXTRACONFIG);
${optionalString (cfg.secretFile != null) "array_push($CONFIG, nix_read_secrets());"}
''; '';
occInstallCmd = let occInstallCmd = let
dbpass = if c.dbpassFile != null dbpass = if c.dbpassFile != null