commit 6974feb92c0ce213a9d4564167fe6f2c3f5946c6 · pyrox.dev/nixpkgs

nixos/doc/manual/release-notes/rl-2411.section.md

···

       87
       87
        
       

     

       88
       88
        
       - [HomeBox](https://github.com/sysadminsmedia/homebox): the inventory and organization system built for the Home User. Available as [services.homebox](#opt-services.homebox.enable).

     

       89
       89
        
       

     

       90
       90
       +
       - [matrix-hookshot](https://matrix-org.github.io/matrix-hookshot), a Matrix bot for connecting to external services. Available as [services.matrix-hookshot](#opt-services.matrix-hookshot.enable).

     

       91
       91
       +
       

     

       90
       92
        
       - [Renovate](https://github.com/renovatebot/renovate), a dependency updating tool for various git forges and language ecosystems. Available as [services.renovate](#opt-services.renovate.enable).

     

       91
       93
        
       

     

       92
       94
        
       - [Music Assistant](https://music-assistant.io/), a music library manager for your offline and online music sources which can easily stream your favourite music to a wide range of supported players. Available as [services.music-assistant](#opt-services.music-assistant.enable).

nixos/modules/module-list.nix

···

       698
       698
        
         ./services/matrix/conduit.nix

     

       699
       699
        
         ./services/matrix/dendrite.nix

     

       700
       700
        
         ./services/matrix/hebbot.nix

     

       701
       701
       +
         ./services/matrix/hookshot.nix

     

       701
       702
        
         ./services/matrix/maubot.nix

     

       702
       703
        
         ./services/matrix/mautrix-facebook.nix

     

       703
       704
        
         ./services/matrix/mautrix-meta.nix

+127

nixos/modules/services/matrix/hookshot.nix

···

       1
       1
       +
       {

     

       2
       2
       +
         config,

     

       3
       3
       +
         pkgs,

     

       4
       4
       +
         lib,

     

       5
       5
       +
         ...

     

       6
       6
       +
       }:

     

       7
       7
       +
       let

     

       8
       8
       +
         cfg = config.services.matrix-hookshot;

     

       9
       9
       +
         settingsFormat = pkgs.formats.yaml { };

     

       10
       10
       +
         configFile = settingsFormat.generate "matrix-hookshot-config.yml" cfg.settings;

     

       11
       11
       +
       in

     

       12
       12
       +
       {

     

       13
       13
       +
         options = {

     

       14
       14
       +
           services.matrix-hookshot = {

     

       15
       15
       +
             enable = lib.mkEnableOption "matrix-hookshot, a bridge between Matrix and project management services";

     

       16
       16
       +
       

     

       17
       17
       +
             package = lib.mkPackageOption pkgs "matrix-hookshot" { };

     

       18
       18
       +
       

     

       19
       19
       +
             registrationFile = lib.mkOption {

     

       20
       20
       +
               type = lib.types.path;

     

       21
       21
       +
               description = ''

     

       22
       22
       +
                 Appservice registration file.

     

       23
       23
       +
                 As it contains secret tokens, you may not want to add this to the publicly readable Nix store.

     

       24
       24
       +
               '';

     

       25
       25
       +
               example = lib.literalExpression ''

     

       26
       26
       +
                 pkgs.writeText "matrix-hookshot-registration" \'\'

     

       27
       27
       +
                   id: matrix-hookshot

     

       28
       28
       +
                   as_token: aaaaaaaaaa

     

       29
       29
       +
                   hs_token: aaaaaaaaaa

     

       30
       30
       +
                   namespaces:

     

       31
       31
       +
                     rooms: []

     

       32
       32
       +
                     users:

     

       33
       33
       +
                       - regex: "@_webhooks_.*:foobar"

     

       34
       34
       +
                         exclusive: true

     

       35
       35
       +
       

     

       36
       36
       +
                   sender_localpart: hookshot

     

       37
       37
       +
                   url: "http://localhost:9993"

     

       38
       38
       +
                   rate_limited: false

     

       39
       39
       +
                   \'\'

     

       40
       40
       +
               '';

     

       41
       41
       +
             };

     

       42
       42
       +
       

     

       43
       43
       +
             settings = lib.mkOption {

     

       44
       44
       +
               description = ''

     

       45
       45
       +
                 {file}`config.yml` configuration as a Nix attribute set.

     

       46
       46
       +
       

     

       47
       47
       +
                 For details please see the [documentation](https://matrix-org.github.io/matrix-hookshot/latest/setup/sample-configuration.html).

     

       48
       48
       +
               '';

     

       49
       49
       +
               example = {

     

       50
       50
       +
                 bridge = {

     

       51
       51
       +
                   domain = "example.com";

     

       52
       52
       +
                   url = "http://localhost:8008";

     

       53
       53
       +
                   mediaUrl = "https://example.com";

     

       54
       54
       +
                   port = 9993;

     

       55
       55
       +
                   bindAddress = "127.0.0.1";

     

       56
       56
       +
                 };

     

       57
       57
       +
                 listeners = [

     

       58
       58
       +
                   {

     

       59
       59
       +
                     port = 9000;

     

       60
       60
       +
                     bindAddress = "0.0.0.0";

     

       61
       61
       +
                     resources = [ "webhooks" ];

     

       62
       62
       +
                   }

     

       63
       63
       +
                   {

     

       64
       64
       +
                     port = 9001;

     

       65
       65
       +
                     bindAddress = "localhost";

     

       66
       66
       +
                     resources = [

     

       67
       67
       +
                       "metrics"

     

       68
       68
       +
                       "provisioning"

     

       69
       69
       +
                     ];

     

       70
       70
       +
                   }

     

       71
       71
       +
                 ];

     

       72
       72
       +
               };

     

       73
       73
       +
               default = { };

     

       74
       74
       +
               type = lib.types.submodule {

     

       75
       75
       +
                 freeformType = settingsFormat.type;

     

       76
       76
       +
                 options = {

     

       77
       77
       +
                   passFile = lib.mkOption {

     

       78
       78
       +
                     type = lib.types.path;

     

       79
       79
       +
                     default = "/var/lib/matrix-hookshot/passkey.pem";

     

       80
       80
       +
                     description = ''

     

       81
       81
       +
                       A passkey used to encrypt tokens stored inside the bridge.

     

       82
       82
       +
                       File will be generated if not found.

     

       83
       83
       +
                     '';

     

       84
       84
       +
                   };

     

       85
       85
       +
                 };

     

       86
       86
       +
               };

     

       87
       87
       +
             };

     

       88
       88
       +
       

     

       89
       89
       +
             serviceDependencies = lib.mkOption {

     

       90
       90
       +
               type = with lib.types; listOf str;

     

       91
       91
       +
               default = lib.optional config.services.matrix-synapse.enable config.services.matrix-synapse.serviceUnit;

     

       92
       92
       +
               defaultText = lib.literalExpression ''

     

       93
       93
       +
                 lib.optional config.services.matrix-synapse.enable config.services.matrix-synapse.serviceUnit

     

       94
       94
       +
               '';

     

       95
       95
       +
               description = ''

     

       96
       96
       +
                 List of Systemd services to require and wait for when starting the application service,

     

       97
       97
       +
                 such as the Matrix homeserver if it's running on the same host.

     

       98
       98
       +
               '';

     

       99
       99
       +
             };

     

       100
       100
       +
           };

     

       101
       101
       +
         };

     

       102
       102
       +
       

     

       103
       103
       +
         config = lib.mkIf cfg.enable {

     

       104
       104
       +
           systemd.services.matrix-hookshot = {

     

       105
       105
       +
             description = "a bridge between Matrix and multiple project management services";

     

       106
       106
       +
       

     

       107
       107
       +
             wantedBy = [ "multi-user.target" ];

     

       108
       108
       +
             wants = [ "network-online.target" ] ++ cfg.serviceDependencies;

     

       109
       109
       +
             after = [ "network-online.target" ] ++ cfg.serviceDependencies;

     

       110
       110
       +
       

     

       111
       111
       +
             preStart = ''

     

       112
       112
       +
               if [ ! -f '${cfg.settings.passFile}' ]; then

     

       113
       113
       +
                 mkdir -p $(dirname '${cfg.settings.passFile}')

     

       114
       114
       +
                 ${pkgs.openssl}/bin/openssl genpkey -out '${cfg.settings.passFile}' -outform PEM -algorithm RSA -pkeyopt rsa_keygen_bits:4096

     

       115
       115
       +
               fi

     

       116
       116
       +
             '';

     

       117
       117
       +
       

     

       118
       118
       +
             serviceConfig = {

     

       119
       119
       +
               Type = "simple";

     

       120
       120
       +
               Restart = "always";

     

       121
       121
       +
               ExecStart = "${cfg.package}/bin/matrix-hookshot ${configFile} ${cfg.registrationFile}";

     

       122
       122
       +
             };

     

       123
       123
       +
           };

     

       124
       124
       +
         };

     

       125
       125
       +
       

     

       126
       126
       +
         meta.maintainers = with lib.maintainers; [ flandweber ];

     

       127
       127
       +
       }