From daea63c97f53a8c6480a9d8ca229884850960307 Mon Sep 17 00:00:00 2001 From: Tom Hubrecht Date: Thu, 17 Oct 2024 23:39:02 +0200 Subject: [PATCH] feat(web02): Deploy mattermost on chat.dgnum.eu --- machines/web02/_configuration.nix | 1 + machines/web02/mattermost/default.nix | 38 +++ machines/web02/mattermost/module.nix | 361 ++++++++++++++++++++++++++ 3 files changed, 400 insertions(+) create mode 100644 machines/web02/mattermost/default.nix create mode 100644 machines/web02/mattermost/module.nix diff --git a/machines/web02/_configuration.nix b/machines/web02/_configuration.nix index 898f7f6..c85b38a 100644 --- a/machines/web02/_configuration.nix +++ b/machines/web02/_configuration.nix @@ -10,6 +10,7 @@ lib.extra.mkConfig { # List of services to enable "cas-eleves" "kadenios" + # "mattermost" ]; extraConfig = { diff --git a/machines/web02/mattermost/default.nix b/machines/web02/mattermost/default.nix new file mode 100644 index 0000000..dcd314a --- /dev/null +++ b/machines/web02/mattermost/default.nix @@ -0,0 +1,38 @@ +let + host = "chat.dgnum.eu"; + port = 8065; +in + +{ + imports = [ ./module.nix ]; + + services.mattermost = { + enable = true; + + siteName = "Merle [Discussions ENS]"; + siteUrl = "https://${host}"; + listenAddress = "127.0.0.1:${builtins.toString port}"; + + localDatabaseCreate = false; + + mutableConfig = true; + + extraConfig = { + SqlSettings.DataSource = "postgres:///mattermost?host=/run/postgresql"; + }; + }; + + services.postgresql = { + ensureDatabases = [ "mattermost" ]; + ensureUsers = [ + { + name = "mattermost"; + ensureDBOwnership = true; + } + ]; + }; + + dgn-web.simpleProxies.mattermost = { + inherit host port; + }; +} diff --git a/machines/web02/mattermost/module.nix b/machines/web02/mattermost/module.nix new file mode 100644 index 0000000..df2a6cf --- /dev/null +++ b/machines/web02/mattermost/module.nix @@ -0,0 +1,361 @@ +{ + config, + lib, + pkgs, + ... +}: + +let + inherit (lib) + escapeShellArgs + mkEnableOption + mkIf + mkMerge + mkOption + mkPackageOption + optionalAttrs + recursiveUpdate + ; + + inherit (lib.types) + attrs + bool + listOf + nullOr + oneOf + package + path + str + ; + + cfg = config.services.mattermost; + + mattermostPluginDerivations = + with pkgs; + map ( + plugin: + stdenv.mkDerivation { + name = "mattermost-plugin"; + installPhase = '' + mkdir -p $out/share + cp ${plugin} $out/share/plugin.tar.gz + ''; + dontUnpack = true; + dontPatch = true; + dontConfigure = true; + dontBuild = true; + preferLocalBuild = true; + } + ) cfg.plugins; + + mattermostPlugins = + with pkgs; + if mattermostPluginDerivations == [ ] then + null + else + stdenv.mkDerivation { + name = "${cfg.package.name}-plugins"; + nativeBuildInputs = [ autoPatchelfHook ] ++ mattermostPluginDerivations; + buildInputs = [ cfg.package ]; + installPhase = '' + mkdir -p $out/data/plugins + plugins=(${ + escapeShellArgs (map (plugin: "${plugin}/share/plugin.tar.gz") mattermostPluginDerivations) + }) + for plugin in "''${plugins[@]}"; do + hash="$(sha256sum "$plugin" | cut -d' ' -f1)" + mkdir -p "$hash" + tar -C "$hash" -xzf "$plugin" + autoPatchelf "$hash" + GZIP_OPT=-9 tar -C "$hash" -cvzf "$out/data/plugins/$hash.tar.gz" . + rm -rf "$hash" + done + ''; + + dontUnpack = true; + dontPatch = true; + dontConfigure = true; + dontBuild = true; + preferLocalBuild = true; + }; + + mattermostConfWithoutPlugins = recursiveUpdate { + ServiceSettings.SiteURL = cfg.siteUrl; + ServiceSettings.ListenAddress = cfg.listenAddress; + TeamSettings.SiteName = cfg.siteName; + SqlSettings.DriverName = "postgres"; + PluginSettings.Directory = "${cfg.statePath}/plugins/server"; + PluginSettings.ClientDirectory = "${cfg.statePath}/plugins/client"; + } cfg.extraConfig; + + mattermostConf = recursiveUpdate mattermostConfWithoutPlugins ( + lib.optionalAttrs (mattermostPlugins != null) { + PluginSettings = { + Enable = true; + }; + } + ); + + mattermostConfJSON = pkgs.writeText "mattermost-config.json" (builtins.toJSON mattermostConf); +in + +{ + disabledModules = [ "services/web-apps/mattermost.nix" ]; + + options = { + services.mattermost = { + enable = mkEnableOption "Mattermost chat server"; + + package = mkPackageOption pkgs "mattermost" { }; + + statePath = mkOption { + type = str; + default = "/var/lib/mattermost"; + description = "Mattermost working directory"; + }; + + siteUrl = mkOption { + type = str; + example = "https://chat.example.com"; + description = '' + URL this Mattermost instance is reachable under, without trailing slash. + ''; + }; + + siteName = mkOption { + type = str; + default = "Mattermost"; + description = "Name of this Mattermost site."; + }; + + listenAddress = mkOption { + type = str; + default = ":8065"; + example = "[::1]:8065"; + description = '' + Address and port this Mattermost instance listens to. + ''; + }; + + mutableConfig = mkOption { + type = bool; + default = false; + description = '' + Whether the Mattermost config.json is writeable by Mattermost. + + Most of the settings can be edited in the system console of + Mattermost if this option is enabled. A template config using + the options specified in services.mattermost will be generated + but won't be overwritten on changes or rebuilds. + + If this option is disabled, changes in the system console won't + be possible (default). If an config.json is present, it will be + overwritten! + ''; + }; + + preferNixConfig = mkOption { + type = bool; + default = false; + description = '' + If both mutableConfig and this option are set, the Nix configuration + will take precedence over any settings configured in the server + console. + ''; + }; + + extraConfig = mkOption { + type = attrs; + default = { }; + description = '' + Additional configuration options as Nix attribute set in config.json schema. + ''; + }; + + plugins = mkOption { + type = listOf (oneOf [ + path + package + ]); + default = [ ]; + example = "[ ./com.github.moussetc.mattermost.plugin.giphy-2.0.0.tar.gz ]"; + description = '' + Plugins to add to the configuration. Overrides any installed if non-null. + This is a list of paths to .tar.gz files or derivations evaluating to + .tar.gz files. + ''; + }; + environmentFile = mkOption { + type = nullOr path; + default = null; + description = '' + Environment file (see {manpage}`systemd.exec(5)` + "EnvironmentFile=" section for the syntax) which sets config options + for mattermost (see [the mattermost documentation](https://docs.mattermost.com/configure/configuration-settings.html#environment-variables)). + + Settings defined in the environment file will overwrite settings + set via nix or via the {option}`services.mattermost.extraConfig` + option. + + Useful for setting config options without their value ending up in the + (world-readable) nix store, e.g. for a database password. + ''; + }; + + localDatabaseCreate = mkOption { + type = bool; + default = true; + description = '' + Create a local PostgreSQL database for Mattermost automatically. + ''; + }; + + localDatabaseName = mkOption { + type = str; + default = "mattermost"; + description = '' + Local Mattermost database name. + ''; + }; + + localDatabaseUser = mkOption { + type = str; + default = "mattermost"; + description = '' + Local Mattermost database username. + ''; + }; + + localDatabasePassword = mkOption { + type = str; + default = "mmpgsecret"; + description = '' + Password for local Mattermost database user. + ''; + }; + + user = mkOption { + type = str; + default = "mattermost"; + description = '' + User which runs the Mattermost service. + ''; + }; + + group = mkOption { + type = str; + default = "mattermost"; + description = '' + Group which runs the Mattermost service. + ''; + }; + + matterircd = { + enable = mkEnableOption "Mattermost IRC bridge"; + package = mkPackageOption pkgs "matterircd" { }; + parameters = mkOption { + type = listOf str; + default = [ ]; + example = [ + "-mmserver chat.example.com" + "-bind [::]:6667" + ]; + description = '' + Set commandline parameters to pass to matterircd. See + https://github.com/42wim/matterircd#usage for more information. + ''; + }; + }; + }; + }; + + config = mkMerge [ + (mkIf cfg.enable { + users.users = optionalAttrs (cfg.user == "mattermost") { + mattermost = { + inherit (cfg) group; + uid = config.ids.uids.mattermost; + home = cfg.statePath; + }; + }; + + users.groups = optionalAttrs (cfg.group == "mattermost") { + mattermost.gid = config.ids.gids.mattermost; + }; + + systemd.services.mattermost = { + description = "Mattermost chat service"; + wantedBy = [ "multi-user.target" ]; + after = [ + "network.target" + "postgresql.service" + ]; + + preStart = + '' + mkdir -p "${cfg.statePath}"/{data,config,logs,plugins} + mkdir -p "${cfg.statePath}/plugins"/{client,server} + ln -sf ${cfg.package}/{bin,fonts,i18n,templates,client} "${cfg.statePath}" + '' + + lib.optionalString (mattermostPlugins != null) '' + rm -rf "${cfg.statePath}/data/plugins" + ln -sf ${mattermostPlugins}/data/plugins "${cfg.statePath}/data" + '' + + lib.optionalString (!cfg.mutableConfig) '' + rm -f "${cfg.statePath}/config/config.json" + ${pkgs.jq}/bin/jq -s '.[0] * .[1]' ${cfg.package}/config/config.json ${mattermostConfJSON} > "${cfg.statePath}/config/config.json" + '' + + lib.optionalString cfg.mutableConfig '' + if ! test -e "${cfg.statePath}/config/.initial-created"; then + rm -f ${cfg.statePath}/config/config.json + ${pkgs.jq}/bin/jq -s '.[0] * .[1]' ${cfg.package}/config/config.json ${mattermostConfJSON} > "${cfg.statePath}/config/config.json" + touch "${cfg.statePath}/config/.initial-created" + fi + '' + + lib.optionalString (cfg.mutableConfig && cfg.preferNixConfig) '' + new_config="$(${pkgs.jq}/bin/jq -s '.[0] * .[1]' "${cfg.statePath}/config/config.json" ${mattermostConfJSON})" + + rm -f "${cfg.statePath}/config/config.json" + echo "$new_config" > "${cfg.statePath}/config/config.json" + + # Don't change permissions recursively on the data, current, and symlinked directories (see ln -sf command above). + # This dramatically decreases startup times for installations with a lot of files. + find . -maxdepth 1 -not -name data -not -name client -not -name templates -not -name i18n -not -name fonts -not -name bin -not -name . \ + -exec chown "${cfg.user}:${cfg.group}" -R {} \; -exec chmod u+rw,g+r,o-rwx -R {} \; + + chown "${cfg.user}:${cfg.group}" "${cfg.statePath}/data" . + chmod u+rw,g+r,o-rwx "${cfg.statePath}/data" . + ''; + + serviceConfig = { + PermissionsStartOnly = true; + User = cfg.user; + Group = cfg.group; + ExecStart = "${cfg.package}/bin/mattermost"; + StateDirectory = "mattermost"; + WorkingDirectory = "/var/lib/mattermost"; + Restart = "always"; + RestartSec = "10"; + LimitNOFILE = "49152"; + EnvironmentFile = cfg.environmentFile; + }; + }; + }) + + (mkIf cfg.matterircd.enable { + systemd.services.matterircd = { + description = "Mattermost IRC bridge service"; + wantedBy = [ "multi-user.target" ]; + serviceConfig = { + User = "nobody"; + Group = "nogroup"; + ExecStart = "${cfg.matterircd.package}/bin/matterircd ${escapeShellArgs cfg.matterircd.parameters}"; + WorkingDirectory = "/tmp"; + PrivateTmp = true; + Restart = "always"; + RestartSec = "5"; + }; + }; + }) + ]; +}