movefasta/nixpkgs
0
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-07-14 06:00:33 +03:00
Code Activity

mediawiki: add support for postgresql

Browse source
This commit is contained in:
Jörg Thalheim 2023-04-03 17:05:21 +02:00
parent 5af1d31e42
commit d9c613d746
2 changed files with 92 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

56
nixos/modules/services/web-apps/mediawiki.nix
View file

@ -46,6 +46,15 @@ let
done done
''; '';
dbAddr = if cfg.database.socket == null then
"${cfg.database.host}:${toString cfg.database.port}"
else if cfg.database.type == "mysql" then
"${cfg.database.host}:${cfg.database.socket}"
else if cfg.database.type == "postgres" then
"${cfg.database.socket}"
else
throw "Unsupported database type: ${cfg.database.type} for socket: ${cfg.database.socket}";
mediawikiConfig = pkgs.writeText "LocalSettings.php" '' mediawikiConfig = pkgs.writeText "LocalSettings.php" ''
<?php <?php
# Protect against web entry # Protect against web entry
@ -87,7 +96,8 @@ let
## Database settings ## Database settings
$wgDBtype = "${cfg.database.type}"; $wgDBtype = "${cfg.database.type}";
$wgDBserver = "${cfg.database.host}:${if cfg.database.socket != null then cfg.database.socket else toString cfg.database.port}"; $wgDBserver = "${dbAddr}";
$wgDBport = "${toString cfg.database.port}";
$wgDBname = "${cfg.database.name}"; $wgDBname = "${cfg.database.name}";
$wgDBuser = "${cfg.database.user}"; $wgDBuser = "${cfg.database.user}";
${optionalString (cfg.database.passwordFile != null) "$wgDBpassword = file_get_contents(\"${cfg.database.passwordFile}\");"} ${optionalString (cfg.database.passwordFile != null) "$wgDBpassword = file_get_contents(\"${cfg.database.passwordFile}\");"}
@ -246,7 +256,8 @@ in
port = mkOption { port = mkOption {
type = types.port; type = types.port;
default = 3306; default = if cfg.database.type == "mysql" then 3306 else 5432;
defaultText = literalExpression "3306";
description = lib.mdDoc "Database host port."; description = lib.mdDoc "Database host port.";
}; };
@ -286,14 +297,19 @@ in
socket = mkOption { socket = mkOption {
type = types.nullOr types.path; type = types.nullOr types.path;
default = if cfg.database.createLocally then "/run/mysqld/mysqld.sock" else null; default = if (cfg.database.type == "mysql" && cfg.database.createLocally) then
"/run/mysqld/mysqld.sock"
else if (cfg.database.type == "postgres" && cfg.database.createLocally) then
"/run/postgresql"
else
null;
defaultText = literalExpression "/run/mysqld/mysqld.sock"; defaultText = literalExpression "/run/mysqld/mysqld.sock";
description = lib.mdDoc "Path to the unix socket file to use for authentication."; description = lib.mdDoc "Path to the unix socket file to use for authentication.";
}; };
createLocally = mkOption { createLocally = mkOption {
type = types.bool; type = types.bool;
default = cfg.database.type == "mysql"; default = cfg.database.type == "mysql" || cfg.database.type == "postgres";
defaultText = literalExpression "true"; defaultText = literalExpression "true";
description = lib.mdDoc '' description = lib.mdDoc ''
Create the database and database user locally. Create the database and database user locally.
@ -354,8 +370,8 @@ in
config = mkIf cfg.enable { config = mkIf cfg.enable {
assertions = [ assertions = [
{ assertion = cfg.database.createLocally -> cfg.database.type == "mysql"; { assertion = cfg.database.createLocally -> (cfg.database.type == "mysql" || cfg.database.type == "postgres");
message = "services.mediawiki.createLocally is currently only supported for database type 'mysql'"; message = "services.mediawiki.createLocally is currently only supported for database type 'mysql' and 'postgres'";
} }
{ assertion = cfg.database.createLocally -> cfg.database.user == user; { assertion = cfg.database.createLocally -> cfg.database.user == user;
message = "services.mediawiki.database.user must be set to ${user} if services.mediawiki.database.createLocally is set true"; message = "services.mediawiki.database.user must be set to ${user} if services.mediawiki.database.createLocally is set true";
@ -374,15 +390,23 @@ in
Vector = "${cfg.package}/share/mediawiki/skins/Vector"; Vector = "${cfg.package}/share/mediawiki/skins/Vector";
}; };
services.mysql = mkIf cfg.database.createLocally { services.mysql = mkIf (cfg.database.type == "mysql" && cfg.database.createLocally) {
enable = true; enable = true;
package = mkDefault pkgs.mariadb; package = mkDefault pkgs.mariadb;
ensureDatabases = [ cfg.database.name ]; ensureDatabases = [ cfg.database.name ];
ensureUsers = [ ensureUsers = [{
{ name = cfg.database.user; name = cfg.database.user;
ensurePermissions = { "${cfg.database.name}.*" = "ALL PRIVILEGES"; }; ensurePermissions = { "${cfg.database.name}.*" = "ALL PRIVILEGES"; };
} }];
]; };
services.postgresql = mkIf (cfg.database.type == "postgres" && cfg.database.createLocally) {
enable = true;
ensureDatabases = [ cfg.database.name ];
ensureUsers = [{
name = cfg.database.user;
ensurePermissions = { "DATABASE \"${cfg.database.name}\"" = "ALL PRIVILEGES"; };
}];
}; };
services.phpfpm.pools.mediawiki = { services.phpfpm.pools.mediawiki = {
@ -431,7 +455,8 @@ in
systemd.services.mediawiki-init = { systemd.services.mediawiki-init = {
wantedBy = [ "multi-user.target" ]; wantedBy = [ "multi-user.target" ];
before = [ "phpfpm-mediawiki.service" ]; before = [ "phpfpm-mediawiki.service" ];
after = optional cfg.database.createLocally "mysql.service"; after = optional (cfg.database.type == "mysql" && cfg.database.createLocally) "mysql.service"
++ optional (cfg.database.type == "postgres" && cfg.database.createLocally) "postgresql.service";
script = '' script = ''
if ! test -e "${stateDir}/secret.key"; then if ! test -e "${stateDir}/secret.key"; then
tr -dc A-Za-z0-9 </dev/urandom 2>/dev/null | head -c 64 > ${stateDir}/secret.key tr -dc A-Za-z0-9 </dev/urandom 2>/dev/null | head -c 64 > ${stateDir}/secret.key
@ -442,7 +467,7 @@ in
${pkgs.php}/bin/php ${pkg}/share/mediawiki/maintenance/install.php \ ${pkgs.php}/bin/php ${pkg}/share/mediawiki/maintenance/install.php \
--confpath /tmp \ --confpath /tmp \
--scriptpath / \ --scriptpath / \
--dbserver ${cfg.database.host}${optionalString (cfg.database.socket != null) ":${cfg.database.socket}"} \ --dbserver "${dbAddr}" \
--dbport ${toString cfg.database.port} \ --dbport ${toString cfg.database.port} \
--dbname ${cfg.database.name} \ --dbname ${cfg.database.name} \
${optionalString (cfg.database.tablePrefix != null) "--dbprefix ${cfg.database.tablePrefix}"} \ ${optionalString (cfg.database.tablePrefix != null) "--dbprefix ${cfg.database.tablePrefix}"} \
@ -464,7 +489,8 @@ in
}; };
}; };
systemd.services.httpd.after = optional (cfg.database.createLocally && cfg.database.type == "mysql") "mysql.service"; systemd.services.httpd.after = optional (cfg.database.createLocally && cfg.database.type == "mysql") "mysql.service"
++ optional (cfg.database.createLocally && cfg.database.type == "postgres") "postgresql.service";
users.users.${user} = { users.users.${user} = {
group = group; group = group;

73
nixos/tests/mediawiki.nix
View file

@ -1,28 +1,57 @@
import ./make-test-python.nix ({ pkgs, lib, ... }: { {
name = "mediawiki"; system ? builtins.currentSystem,
meta.maintainers = [ lib.maintainers.aanderse ]; config ? {},
pkgs ? import ../.. { inherit system config; },
}:
nodes.machine = let
{ ... }: shared = {
{ services.mediawiki.enable = true; services.mediawiki.enable = true;
services.mediawiki.virtualHost.hostName = "localhost"; services.mediawiki.virtualHost.hostName = "localhost";
services.mediawiki.virtualHost.adminAddr = "root@example.com"; services.mediawiki.virtualHost.adminAddr = "root@example.com";
services.mediawiki.passwordFile = pkgs.writeText "password" "correcthorsebatterystaple"; services.mediawiki.passwordFile = pkgs.writeText "password" "correcthorsebatterystaple";
services.mediawiki.extensions = { services.mediawiki.extensions = {
Matomo = pkgs.fetchzip { Matomo = pkgs.fetchzip {
url = "https://github.com/DaSchTour/matomo-mediawiki-extension/archive/v4.0.1.tar.gz"; url = "https://github.com/DaSchTour/matomo-mediawiki-extension/archive/v4.0.1.tar.gz";
sha256 = "0g5rd3zp0avwlmqagc59cg9bbkn3r7wx7p6yr80s644mj6dlvs1b"; sha256 = "0g5rd3zp0avwlmqagc59cg9bbkn3r7wx7p6yr80s644mj6dlvs1b";
};
ParserFunctions = null;
}; };
ParserFunctions = null;
}; };
};
testScript = '' testLib = import ../lib/testing-python.nix {
start_all() inherit system pkgs;
extraConfigurations = [ shared ];
};
in
{
mysql = testLib.makeTest {
name = "mediawiki-mysql";
nodes.machine = {
services.mediawiki.database.type = "mysql";
};
testScript = ''
start_all()
machine.wait_for_unit("phpfpm-mediawiki.service") machine.wait_for_unit("phpfpm-mediawiki.service")
page = machine.succeed("curl -fL http://localhost/") page = machine.succeed("curl -fL http://localhost/")
assert "MediaWiki has been installed" in page assert "MediaWiki has been installed" in page
''; '';
}) };
postgresql = testLib.makeTest {
name = "mediawiki-postgres";
nodes.machine = {
services.mediawiki.database.type = "postgres";
};
testScript = ''
start_all()
machine.wait_for_unit("phpfpm-mediawiki.service")
page = machine.succeed("curl -fL http://localhost/")
assert "MediaWiki has been installed" in page
'';
};
}