summaryrefslogtreecommitdiffstats
path: root/lass/3modules/bitlbee.nix
blob: 8ce56014616c00c8e06f0552e6e04dd0ab2f3aa8 (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
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
{ config, lib, pkgs, ... }:


let

  inherit (lib)
    mkIf
    mkOption
    types
    singleton
  ;

  authModeCheck = v:
    v == "Open" ||
    v == "Closed" ||
    v == "Registered"
  ;

  bitlbeeConfig = pkgs.writeText "bitlbee.conf" ''
    [settings]
    RunMode = Daemon
    User = bitlbee
    ConfigDir = ${cfg.configDir}
    DaemonInterface = ${cfg.interface}
    DaemonPort = ${toString cfg.portNumber}
    AuthMode = ${cfg.authMode}
    ${lib.optionalString (cfg.hostName != "") "HostName = ${cfg.hostName}"}
    ${lib.optionalString (cfg.protocols != "") "Protocols = ${cfg.protocols}"}
    ${cfg.extraSettings}

    [defaults]
    ${cfg.extraDefaults}
  '';

  cfg = config.lass.bitlbee;

  out = {
    options.lass.bitlbee = api;
    config = mkIf cfg.enable imp;
  };

  api = {
    enable = mkOption {
      default = false;
      description = ''
        Whether to run the BitlBee IRC to other chat network gateway.
        Running it allows you to access the MSN, Jabber, Yahoo! and ICQ chat
        networks via an IRC client.
      '';
    };

    interface = mkOption {
      default = "127.0.0.1";
      description = ''
        The interface the BitlBee deamon will be listening to.  If `127.0.0.1',
        only clients on the local host can connect to it; if `0.0.0.0', clients
        can access it from any network interface.
      '';
    };

    portNumber = mkOption {
      default = 6667;
      description = ''
        Number of the port BitlBee will be listening to.
      '';
    };

    authMode = mkOption {
      default = "Open";
      type = types.addCheck types.str authModeCheck;
      description = ''
        The following authentication modes are available:
          Open -- Accept connections from anyone, use NickServ for user authentication.
          Closed -- Require authorization (using the PASS command during login) before allowing the user to connect at all.
          Registered -- Only allow registered users to use this server; this disables the register- and the account command until the user identifies himself.
      '';
    };

    hostName = mkOption {
      default = "";
      type = types.str;
      description = ''
        Normally, BitlBee gets a hostname using getsockname(). If you have a nicer
        alias for your BitlBee daemon, you can set it here and BitlBee will identify
        itself with that name instead.
      '';
    };

    configDir = mkOption {
      default = "/var/lib/bitlbee";
      type = types.path;
      description = ''
        Specify an alternative directory to store all the per-user configuration
        files.
      '';
    };

    protocols = mkOption {
      default = "";
      type = types.str;
      description = ''
        This option allows to remove the support of protocol, even if compiled
        in. If nothing is given, there are no restrictions.
      '';
    };

    extraSettings = mkOption {
      default = "";
      description = ''
        Will be inserted in the Settings section of the config file.
      '';
    };

    extraDefaults = mkOption {
      default = "";
      description = ''
        Will be inserted in the Default section of the config file.
      '';
    };

    bitlbeePkg = mkOption {
      default = pkgs.bitlbee;
      description = ''
        the bitlbee pkg to use.
      '';
    };
  };

  imp = {
    users.extraUsers = singleton {
      name = "bitlbee";
      uid = config.ids.uids.bitlbee;
      description = "BitlBee user";
      home = "/var/lib/bitlbee";
      createHome = true;
    };

    users.extraGroups = singleton {
      name = "bitlbee";
      gid = config.ids.gids.bitlbee;
    };

    systemd.services.bitlbee = {
      description = "BitlBee IRC to other chat networks gateway";
      after = [ "network.target" ];
      wantedBy = [ "multi-user.target" ];
      serviceConfig.User = "bitlbee";
      serviceConfig.ExecStart = "${cfg.bitlbeePkg}/sbin/bitlbee -F -n -c ${bitlbeeConfig}";
    };
  };

in
out