nixpkgs/nixos/modules/services/networking/bitlbee.nix

193 lines
5.2 KiB
Nix
Raw Normal View History

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.bitlbee;
bitlbeeUid = config.ids.uids.bitlbee;
2018-09-22 10:27:49 +01:00
bitlbeePkg = pkgs.bitlbee.override {
enableLibPurple = cfg.libpurple_plugins != [];
enablePam = cfg.authBackend == "pam";
};
bitlbeeConfig = pkgs.writeText "bitlbee.conf"
''
[settings]
RunMode = Daemon
2015-09-08 20:15:41 +01:00
User = bitlbee
ConfigDir = ${cfg.configDir}
DaemonInterface = ${cfg.interface}
DaemonPort = ${toString cfg.portNumber}
AuthMode = ${cfg.authMode}
2018-09-22 10:27:49 +01:00
AuthBackend = ${cfg.authBackend}
2015-09-08 20:15:41 +01:00
Plugindir = ${pkgs.bitlbee-plugins cfg.plugins}/lib/bitlbee
2015-07-16 01:43:27 +01:00
${lib.optionalString (cfg.hostName != "") "HostName = ${cfg.hostName}"}
2015-07-08 18:30:20 +01:00
${lib.optionalString (cfg.protocols != "") "Protocols = ${cfg.protocols}"}
${cfg.extraSettings}
[defaults]
${cfg.extraDefaults}
'';
purple_plugin_path =
lib.concatMapStringsSep ":"
(plugin: "${plugin}/lib/pidgin/:${plugin}/lib/purple-2/")
cfg.libpurple_plugins
;
in
{
###### interface
options = {
services.bitlbee = {
enable = mkOption {
2013-03-29 11:51:47 +00:00
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 {
2013-03-29 11:51:47 +00:00
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 {
2013-03-29 11:51:47 +00:00
default = 6667;
description = ''
Number of the port BitlBee will be listening to.
'';
};
2018-09-22 10:27:49 +01:00
authBackend = mkOption {
default = "storage";
type = types.enum [ "storage" "pam" ];
description = ''
How users are authenticated
storage -- save passwords internally
pam -- Linux PAM authentication
'';
};
authMode = mkOption {
2013-03-29 11:51:47 +00:00
default = "Open";
2016-11-04 04:03:53 +00:00
type = types.enum [ "Open" "Closed" "Registered" ];
2013-03-29 11:51:47 +00:00
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.
2015-09-08 20:15:41 +01:00
'';
};
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.
'';
};
2015-09-08 20:15:41 +01:00
plugins = mkOption {
type = types.listOf types.package;
default = [];
example = literalExample "[ pkgs.bitlbee-facebook ]";
description = ''
The list of bitlbee plugins to install.
'';
};
libpurple_plugins = mkOption {
type = types.listOf types.package;
default = [];
example = literalExample "[ pkgs.purple-matrix ]";
description = ''
The list of libpurple plugins to install.
'';
};
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 {
2013-03-29 11:51:47 +00:00
default = "";
description = ''
Will be inserted in the Settings section of the config file.
2015-09-08 20:15:41 +01:00
'';
};
extraDefaults = mkOption {
2013-03-29 11:51:47 +00:00
default = "";
description = ''
Will be inserted in the Default section of the config file.
2015-09-08 20:15:41 +01:00
'';
};
};
};
###### implementation
2018-09-22 10:27:49 +01:00
config = mkMerge [
(mkIf config.services.bitlbee.enable {
users.users.bitlbee = {
2013-03-29 11:51:47 +00:00
uid = bitlbeeUid;
description = "BitlBee user";
home = "/var/lib/bitlbee";
createHome = true;
};
users.groups.bitlbee = {
2013-03-29 11:51:47 +00:00
gid = config.ids.gids.bitlbee;
};
2018-09-22 10:27:49 +01:00
systemd.services.bitlbee = {
environment.PURPLE_PLUGIN_PATH = purple_plugin_path;
description = "BitlBee IRC to other chat networks gateway";
after = [ "network.target" ];
wantedBy = [ "multi-user.target" ];
serviceConfig.User = "bitlbee";
serviceConfig.ExecStart = "${bitlbeePkg}/sbin/bitlbee -F -n -c ${bitlbeeConfig}";
};
2018-09-22 10:27:49 +01:00
environment.systemPackages = [ bitlbeePkg ];
2018-09-22 10:27:49 +01:00
})
(mkIf (config.services.bitlbee.authBackend == "pam") {
security.pam.services.bitlbee = {};
})
];
}