aboutsummaryrefslogtreecommitdiff
path: root/modules/matrix/mx-puppet-slack.nix
blob: 5737319b426da6b3d0d568cd6167812f841d146e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
{ config, pkgs, lib, ... }:

with lib;

let
  dataDir = "/var/lib/mx-puppet-slack";
  registrationFile = "${dataDir}/slack-registration.yaml";
  cfg = config.services.mx-puppet-slack;
  settingsFormat = pkgs.formats.json {};
  settingsFile = settingsFormat.generate "mx-puppet-slack-config.json" cfg.settings;

in {
  options = {
    services.mx-puppet-slack = {
      enable = mkEnableOption (lib.mdDoc ''
        mx-puppet-slack is a slack puppeting bridge for matrix.
        It handles bridging private and group DMs
      '');

      package = mkOption {
        type = types.package;
        default = pkgs.callPackage ./pkgs/mx-puppet-slack.nix {};
        defaultText = "pkgs.mx-puppet-slack";
        example = "pkgs.mx-puppet-slack.override { … = …; }";
        description = lib.mdDoc ''
          Package of the application to run, exposed for overriding purposes.
        '';
      };

      settings = mkOption rec {
        apply = recursiveUpdate default;
        inherit (settingsFormat) type;
        default = {
          bridge = {
            port = 8432;
          };
          presence = {
            enabled = true;
            interval = 500;
          };
          provisioning.whitelist = [ ];

          # variables are preceded by a colon.
          namePatterns = {
            user = ":name";
            room = ":name[:team? - :team,]";
            group = ":name";
          };

          #defaults to sqlite but can be configured to use postgresql with
          #connstring
          database.filename = "${dataDir}/database.db";
          logging = {
            console = "info";
            lineDateFormat = "MMM-D HH:mm:ss.SSS";
          };
        };
        example = literalExpression ''
          {
            bridge = {
              bindAddress = "localhost";
              domain = "example.com";
              homeserverUrl = "https://example.com";
            };
            provisioning.whitelist = [ "@admin:example.com" ];
            relay.whitelist = [ "@.*:example.com" ];
          }
        '';
        description = lib.mdDoc ''
          {file}`config.yaml` configuration as a Nix attribute set.
          Configuration options should match those described in
          [
          sample.config.yaml](https://github.com/matrix-slack/mx-puppet-slack/blob/master/sample.config.yaml).
        '';
      };
      serviceDependencies = mkOption {
        type = with types; listOf str;
        default = optional config.services.matrix-synapse.enable "matrix-synapse.service";
        defaultText = literalExpression ''
          optional config.services.matrix-synapse.enable "matrix-synapse.service"
        '';
        description = lib.mdDoc ''
          List of Systemd services to require and wait for when starting the application service.
        '';
      };
    };
  };

  config = mkIf cfg.enable {
    systemd.services.mx-puppet-slack = {
      description = "Matrix to Slack puppeting bridge";

      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
          ${cfg.package}/bin/mx-puppet-slack -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 = cfg.package;
        StateDirectory = baseNameOf dataDir;

        UMask = "0027";

        ExecStart = ''
          ${cfg.package}/bin/mx-puppet-slack \
            -c ${settingsFile} \
            -f ${registrationFile}
        '';
      };
    };
  };

  meta.maintainers = with maintainers; [ govanify ];
}