nixpkgs/nixos/modules/services/web-apps/matomo.nix

247 lines
9.3 KiB
Nix
Raw Normal View History

{ config, lib, pkgs, ... }:
2017-04-23 13:51:21 +00:00
with lib;
let
2018-01-16 17:44:27 +00:00
cfg = config.services.matomo;
2017-04-23 13:51:21 +00:00
2018-01-16 17:44:27 +00:00
user = "matomo";
2017-04-23 13:51:21 +00:00
dataDir = "/var/lib/${user}";
2018-01-16 17:44:27 +00:00
deprecatedDataDir = "/var/lib/piwik";
2017-04-23 13:51:21 +00:00
pool = user;
# it's not possible to use /run/phpfpm/${pool}.sock because /run/phpfpm/ is root:root 0770,
# and therefore is not accessible by the web server.
phpSocket = "/run/phpfpm-${pool}.sock";
phpExecutionUnit = "phpfpm-${pool}";
databaseService = "mysql.service";
fqdn =
let
join = hostName: domain: hostName + optionalString (domain != null) ".${domain}";
in join config.networking.hostName config.networking.domain;
2017-04-23 13:51:21 +00:00
in {
options = {
2018-01-16 17:44:27 +00:00
services.matomo = {
2017-04-23 13:51:21 +00:00
# NixOS PR for database setup: https://github.com/NixOS/nixpkgs/pull/6963
2018-01-16 17:44:27 +00:00
# matomo issue for automatic matomo setup: https://github.com/matomo-org/matomo/issues/10257
# TODO: find a nice way to do this when more NixOS MySQL and / or matomo automatic setup stuff is implemented.
2017-04-23 13:51:21 +00:00
enable = mkOption {
type = types.bool;
default = false;
description = ''
2018-01-16 17:44:27 +00:00
Enable matomo web analytics with php-fpm backend.
Either the nginx option or the webServerUser option is mandatory.
2017-04-23 13:51:21 +00:00
'';
};
webServerUser = mkOption {
type = types.nullOr types.str;
default = null;
example = "lighttpd";
2018-01-16 17:44:27 +00:00
# TODO: piwik.php might get renamed to matomo.php in future releases
2017-04-23 13:51:21 +00:00
description = ''
2018-01-16 17:44:27 +00:00
Name of the web server user that forwards requests to the ${phpSocket} fastcgi socket for matomo if the nginx
option is not used. Either this option or the nginx option is mandatory.
2017-04-23 13:51:21 +00:00
If you want to use another webserver than nginx, you need to set this to that server's user
and pass fastcgi requests to `index.php` and `piwik.php` to this socket.
'';
};
phpfpmProcessManagerConfig = mkOption {
type = types.str;
default = ''
; default phpfpm process manager settings
pm = dynamic
pm.max_children = 75
pm.start_servers = 10
pm.min_spare_servers = 5
pm.max_spare_servers = 20
pm.max_requests = 500
; log worker's stdout, but this has a performance hit
catch_workers_output = yes
'';
description = ''
2018-01-16 17:44:27 +00:00
Settings for phpfpm's process manager. You might need to change this depending on the load for matomo.
2017-04-23 13:51:21 +00:00
'';
};
nginx = mkOption {
type = types.nullOr (types.submodule (
recursiveUpdate
(import ../web-servers/nginx/vhost-options.nix { inherit config lib; })
{
# enable encryption by default,
2018-01-16 17:44:27 +00:00
# as sensitive login and matomo data should not be transmitted in clear text.
options.forceSSL.default = true;
options.enableACME.default = true;
}
)
);
2017-04-23 13:51:21 +00:00
default = null;
example = {
serverAliases = [
"matomo.$\{config.networking.domain\}"
"stats.$\{config.networking.domain\}"
];
enableACME = false;
};
2017-04-23 13:51:21 +00:00
description = ''
2018-01-16 17:44:27 +00:00
With this option, you can customize an nginx virtualHost which already has sensible defaults for matomo.
Either this option or the webServerUser option is mandatory.
Set this to {} to just enable the virtualHost if you don't need any customization.
If enabled, then by default, the <option>serverName</option> is
<literal>${user}.$\{config.networking.hostName\}.$\{config.networking.domain\}</literal>,
SSL is active, and certificates are acquired via ACME.
If this is set to null (the default), no nginx virtualHost will be configured.
2017-04-23 13:51:21 +00:00
'';
};
};
};
config = mkIf cfg.enable {
warnings = mkIf (cfg.nginx != null && cfg.webServerUser != null) [
2018-01-16 17:44:27 +00:00
"If services.matomo.nginx is set, services.matomo.nginx.webServerUser is ignored and should be removed."
];
assertions = [ {
assertion = cfg.nginx != null || cfg.webServerUser != null;
2018-01-16 17:44:27 +00:00
message = "Either services.matomo.nginx or services.matomo.nginx.webServerUser is mandatory";
}];
2017-04-23 13:51:21 +00:00
users.users.${user} = {
2017-04-23 13:51:21 +00:00
isSystemUser = true;
createHome = true;
home = dataDir;
group = user;
};
users.groups.${user} = {};
2017-04-23 13:51:21 +00:00
2018-01-16 17:44:27 +00:00
systemd.services.matomo_setup_update = {
# everything needs to set up and up to date before matomo php files are executed
2017-04-23 13:51:21 +00:00
requiredBy = [ "${phpExecutionUnit}.service" ];
before = [ "${phpExecutionUnit}.service" ];
# the update part of the script can only work if the database is already up and running
requires = [ databaseService ];
after = [ databaseService ];
2018-01-16 17:44:27 +00:00
path = [ pkgs.matomo ];
2017-04-23 13:51:21 +00:00
serviceConfig = {
Type = "oneshot";
User = user;
# hide especially config.ini.php from other
UMask = "0007";
2018-01-16 17:44:27 +00:00
# TODO: might get renamed to MATOMO_USER_PATH in future versions
2017-04-23 13:51:21 +00:00
Environment = "PIWIK_USER_PATH=${dataDir}";
# chown + chmod in preStart needs root
PermissionsStartOnly = true;
};
# correct ownership and permissions in case they're not correct anymore,
# e.g. after restoring from backup or moving from another system.
# Note that ${dataDir}/config/config.ini.php might contain the MySQL password.
preStart = ''
2018-01-16 17:44:27 +00:00
# migrate data from piwik to matomo folder
if [ -d ${deprecatedDataDir} ]; then
echo "Migrating from ${deprecatedDataDir} to ${dataDir}"
mv -T ${deprecatedDataDir} ${dataDir}
fi
2017-04-23 13:51:21 +00:00
chown -R ${user}:${user} ${dataDir}
chmod -R ug+rwX,o-rwx ${dataDir}
'';
script = ''
2018-01-16 17:44:27 +00:00
# Use User-Private Group scheme to protect matomo data, but allow administration / backup via matomo group
2017-04-23 13:51:21 +00:00
# Copy config folder
chmod g+s "${dataDir}"
2018-01-16 17:44:27 +00:00
cp -r "${pkgs.matomo}/config" "${dataDir}/"
2017-04-23 13:51:21 +00:00
chmod -R u+rwX,g+rwX,o-rwx "${dataDir}"
# check whether user setup has already been done
if test -f "${dataDir}/config/config.ini.php"; then
# then execute possibly pending database upgrade
2018-01-16 17:44:27 +00:00
matomo-console core:update --yes
2017-04-23 13:51:21 +00:00
fi
'';
};
systemd.services.${phpExecutionUnit} = {
2018-01-16 17:44:27 +00:00
# stop phpfpm on package upgrade, do database upgrade via matomo_setup_update, and then restart
restartTriggers = [ pkgs.matomo ];
2017-04-23 13:51:21 +00:00
# stop config.ini.php from getting written with read permission for others
serviceConfig.UMask = "0007";
};
services.phpfpm.poolConfigs = let
# workaround for when both are null and need to generate a string,
# which is illegal, but as assertions apparently are being triggered *after* config generation,
# we have to avoid already throwing errors at this previous stage.
socketOwner = if (cfg.nginx != null) then config.services.nginx.user
else if (cfg.webServerUser != null) then cfg.webServerUser else "";
in {
2017-04-23 13:51:21 +00:00
${pool} = ''
listen = "${phpSocket}"
listen.owner = ${socketOwner}
2017-04-23 13:51:21 +00:00
listen.group = root
listen.mode = 0600
user = ${user}
env[PIWIK_USER_PATH] = ${dataDir}
${cfg.phpfpmProcessManagerConfig}
'';
};
services.nginx.virtualHosts = mkIf (cfg.nginx != null) {
# References:
# https://fralef.me/piwik-hardening-with-nginx-and-php-fpm.html
# https://github.com/perusio/piwik-nginx
"${user}.${fqdn}" = mkMerge [ cfg.nginx {
2018-01-16 17:44:27 +00:00
# don't allow to override the root easily, as it will almost certainly break matomo.
# disadvantage: not shown as default in docs.
2018-01-16 17:44:27 +00:00
root = mkForce "${pkgs.matomo}/share";
# define locations here instead of as the submodule option's default
# so that they can easily be extended with additional locations if required
2018-01-16 17:44:27 +00:00
# without needing to redefine the matomo ones.
# disadvantage: not shown as default in docs.
2017-04-23 13:51:21 +00:00
locations."/" = {
index = "index.php";
};
# allow index.php for webinterface
locations."= /index.php".extraConfig = ''
fastcgi_pass unix:${phpSocket};
'';
2018-01-16 17:44:27 +00:00
# TODO: might get renamed to matomo.php in future versions
2017-04-23 13:51:21 +00:00
# allow piwik.php for tracking
locations."= /piwik.php".extraConfig = ''
fastcgi_pass unix:${phpSocket};
'';
# Any other attempt to access any php files is forbidden
locations."~* ^.+\.php$".extraConfig = ''
return 403;
'';
# Disallow access to unneeded directories
# config and tmp are already removed
locations."~ ^/(?:core|lang|misc)/".extraConfig = ''
return 403;
'';
# Disallow access to several helper files
locations."~* \.(?:bat|git|ini|sh|txt|tpl|xml|md)$".extraConfig = ''
return 403;
'';
# No crawling of this site for bots that obey robots.txt - no useful information here.
locations."= /robots.txt".extraConfig = ''
return 200 "User-agent: *\nDisallow: /\n";
'';
2018-01-16 17:44:27 +00:00
# TODO: might get renamed to matomo.js in future versions
2017-04-23 13:51:21 +00:00
# let browsers cache piwik.js
locations."= /piwik.js".extraConfig = ''
expires 1M;
'';
}];
2017-04-23 13:51:21 +00:00
};
};
meta = {
2018-01-16 17:44:27 +00:00
doc = ./matomo-doc.xml;
2018-07-09 04:45:52 +00:00
maintainers = with lib.maintainers; [ florianjacob ];
2017-04-23 13:51:21 +00:00
};
}