summaryrefslogtreecommitdiffstats
path: root/nixos/modules/services/misc/mx-puppet-discord.nix
diff options
context:
space:
mode:
Diffstat (limited to 'nixos/modules/services/misc/mx-puppet-discord.nix')
-rw-r--r--nixos/modules/services/misc/mx-puppet-discord.nix120
1 files changed, 120 insertions, 0 deletions
diff --git a/nixos/modules/services/misc/mx-puppet-discord.nix b/nixos/modules/services/misc/mx-puppet-discord.nix
new file mode 100644
index 000000000000..11116f7c3489
--- /dev/null
+++ b/nixos/modules/services/misc/mx-puppet-discord.nix
@@ -0,0 +1,120 @@
+{ config, pkgs, lib, ... }:
+
+with lib;
+
+let
+ dataDir = "/var/lib/mx-puppet-discord";
+ registrationFile = "${dataDir}/discord-registration.yaml";
+ cfg = config.services.mx-puppet-discord;
+ settingsFormat = pkgs.formats.json {};
+ settingsFile = settingsFormat.generate "mx-puppet-discord-config.json" cfg.settings;
+
+in {
+ options = {
+ services.mx-puppet-discord = {
+ enable = mkEnableOption ''
+ mx-puppet-discord is a discord puppeting bridge for matrix.
+ It handles bridging private and group DMs, as well as Guilds (servers)
+ '';
+
+ settings = mkOption rec {
+ apply = recursiveUpdate default;
+ inherit (settingsFormat) type;
+ default = {
+ bridge.port = 8434;
+ presence = {
+ enabled = true;
+ interval = 500;
+ };
+ provisioning.whitelist = [ ];
+ relay.whitelist = [ ];
+
+ # variables are preceded by a colon.
+ namePatterns = {
+ user = ":name";
+ userOverride = ":displayname";
+ room = ":name";
+ group = ":name";
+ };
+
+ #defaults to sqlite but can be configured to use postgresql with
+ #connstring
+ database.filename = "${dataDir}/mx-puppet-discord/database.db";
+ logging = {
+ console = "info";
+ lineDateFormat = "MMM-D HH:mm:ss.SSS";
+ };
+ };
+ example = literalExample ''
+ {
+ bridge = {
+ bindAddress = "localhost";
+ domain = "example.com";
+ homeserverUrl = "https://example.com";
+ };
+
+ provisioning.whitelist = [ "@admin:example.com" ];
+ relay.whitelist = [ "@.*:example.com" ];
+ }
+ '';
+ description = ''
+ <filename>config.yaml</filename> configuration as a Nix attribute set.
+ Configuration options should match those described in
+ <link xlink:href="https://github.com/matrix-discord/mx-puppet-discord/blob/master/sample.config.yaml">
+ sample.config.yaml</link>.
+ '';
+ };
+ serviceDependencies = mkOption {
+ type = with types; listOf str;
+ default = optional config.services.matrix-synapse.enable "matrix-synapse.service";
+ description = ''
+ List of Systemd services to require and wait for when starting the application service.
+ '';
+ };
+ };
+ };
+
+ config = mkIf cfg.enable {
+ systemd.services.mx-puppet-discord = {
+ description = ''
+ mx-puppet-discord is a discord puppeting bridge for matrix.
+ It handles bridging private and group DMs, as well as Guilds (servers).
+ '';
+
+ wantedBy = [ "multi-user.target" ];
+ wants = [ "network-online.target" ] ++ cfg.serviceDependencies;
+ after = [ "network-online.target" ] ++ cfg.serviceDependencies;
+
+ preStart = ''
+ # generate the appservice's registration file if absent
+ if [ ! -f '${registrationFile}' ]; then
+ ${pkgs.mx-puppet-discord}/bin/mx-puppet-discord -r -c ${settingsFile} \
+ -f ${registrationFile}
+ fi
+ '';
+
+ serviceConfig = {
+ Type = "simple";
+ Restart = "always";
+
+ ProtectSystem = "strict";
+ ProtectHome = true;
+ ProtectKernelTunables = true;
+ ProtectKernelModules = true;
+ ProtectControlGroups = true;
+
+ DynamicUser = true;
+ PrivateTmp = true;
+ WorkingDirectory = pkgs.mx-puppet-discord;
+ StateDirectory = baseNameOf dataDir;
+ UMask = 0027;
+
+ ExecStart = ''
+ ${pkgs.mx-puppet-discord}/bin/mx-puppet-discord -c ${settingsFile}
+ '';
+ };
+ };
+ };
+
+ meta.maintainers = with maintainers; [ govanify ];
+}