modules/matrix/options.nix


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

{ config, lib, pkgs, ... }:

with lib;
{
  options = {
    services.matrix = {
      server_name = mkOption {
        type = types.str;
        example = "example.com";
        description = lib.mdDoc ''
          The hostname that will appear in your user and room IDs
        '';
      };

      matrix_hostname = mkOption {
        type = types.str;
        default = "matrix.${config.services.matrix.server_name}";
        example = "matrix.example.com";
        description = lib.mdDoc ''
          The hostname that Conduit actually runs on

          This can be the same as `server_name` if you want. This is only necessary
          when Conduit is running on a different machine than the one hosting your
          root domain. This configuration also assumes this is all running on a single
          machine, some tweaks will need to be made if this is not the case.
        '';
      };

      admin_email = mkOption {
        type = types.str;
        example = "admin@example.com";
        description = lib.mdDoc ''
          An admin email for TLS certificate notifications
        '';
      };
    };
  };
}