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

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

191 lines
5.3 KiB
Nix
Raw Normal View History

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.bitlbee;
bitlbeeUid = config.ids.uids.bitlbee;
2018-09-22 09:27:49 +00:00
bitlbeePkg = pkgs.bitlbee.override {
enableLibPurple = cfg.libpurple_plugins != [];
enablePam = cfg.authBackend == "pam";
};
bitlbeeConfig = pkgs.writeText "bitlbee.conf"
''
[settings]
RunMode = Daemon
ConfigDir = ${cfg.configDir}
DaemonInterface = ${cfg.interface}
DaemonPort = ${toString cfg.portNumber}
AuthMode = ${cfg.authMode}
2018-09-22 09:27:49 +00:00
AuthBackend = ${cfg.authBackend}
2015-09-08 19:15:41 +00:00
Plugindir = ${pkgs.bitlbee-plugins cfg.plugins}/lib/bitlbee
2015-07-16 00:43:27 +00:00
${lib.optionalString (cfg.hostName != "") "HostName = ${cfg.hostName}"}
2015-07-08 17:30:20 +00: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 {
type = types.bool;
2013-03-29 11:51:47 +00:00
default = false;
description = lib.mdDoc ''
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 {
type = types.str;
2013-03-29 11:51:47 +00:00
default = "127.0.0.1";
description = lib.mdDoc ''
2022-12-18 00:31:14 +00:00
The interface the BitlBee daemon 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
2013-03-29 11:51:47 +00:00
can access it from any network interface.
'';
};
portNumber = mkOption {
2013-03-29 11:51:47 +00:00
default = 6667;
type = types.port;
2013-03-29 11:51:47 +00:00
description = lib.mdDoc ''
Number of the port BitlBee will be listening to.
'';
};
2018-09-22 09:27:49 +00:00
authBackend = mkOption {
default = "storage";
type = types.enum [ "storage" "pam" ];
description = lib.mdDoc ''
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 = lib.mdDoc ''
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 19:15:41 +00:00
'';
};
hostName = mkOption {
default = "";
type = types.str;
description = lib.mdDoc ''
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 19:15:41 +00:00
plugins = mkOption {
type = types.listOf types.package;
default = [];
example = literalExpression "[ pkgs.bitlbee-facebook ]";
2015-09-08 19:15:41 +00:00
description = lib.mdDoc ''
The list of bitlbee plugins to install.
'';
};
libpurple_plugins = mkOption {
type = types.listOf types.package;
default = [];
example = literalExpression "[ pkgs.purple-matrix ]";
description = lib.mdDoc ''
The list of libpurple plugins to install.
'';
};
configDir = mkOption {
default = "/var/lib/bitlbee";
type = types.path;
description = lib.mdDoc ''
Specify an alternative directory to store all the per-user configuration
files.
'';
};
protocols = mkOption {
default = "";
type = types.str;
description = lib.mdDoc ''
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 = "";
type = types.lines;
2013-03-29 11:51:47 +00:00
description = lib.mdDoc ''
Will be inserted in the Settings section of the config file.
2015-09-08 19:15:41 +00:00
'';
};
extraDefaults = mkOption {
2013-03-29 11:51:47 +00:00
default = "";
type = types.lines;
2013-03-29 11:51:47 +00:00
description = lib.mdDoc ''
Will be inserted in the Default section of the config file.
2015-09-08 19:15:41 +00:00
'';
};
};
};
###### implementation
2018-09-22 09:27:49 +00:00
config = mkMerge [
(mkIf config.services.bitlbee.enable {
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 = {
DynamicUser = true;
StateDirectory = "bitlbee";
ReadWritePaths = [ cfg.configDir ];
ExecStart = "${bitlbeePkg}/sbin/bitlbee -F -n -c ${bitlbeeConfig}";
};
};
2018-09-22 09:27:49 +00:00
environment.systemPackages = [ bitlbeePkg ];
2018-09-22 09:27:49 +00:00
})
(mkIf (config.services.bitlbee.authBackend == "pam") {
security.pam.services.bitlbee = {};
})
];
}