2e751c0772
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
135 lines
3.4 KiB
Nix
135 lines
3.4 KiB
Nix
{ config, lib, pkgs, ... }:
|
|
|
|
with lib;
|
|
|
|
let
|
|
cfg = config.services.rss2email;
|
|
in {
|
|
|
|
###### interface
|
|
|
|
options = {
|
|
|
|
services.rss2email = {
|
|
|
|
enable = mkOption {
|
|
type = types.bool;
|
|
default = false;
|
|
description = lib.mdDoc "Whether to enable rss2email.";
|
|
};
|
|
|
|
to = mkOption {
|
|
type = types.str;
|
|
description = lib.mdDoc "Mail address to which to send emails";
|
|
};
|
|
|
|
interval = mkOption {
|
|
type = types.str;
|
|
default = "12h";
|
|
description = lib.mdDoc "How often to check the feeds, in systemd interval format";
|
|
};
|
|
|
|
config = mkOption {
|
|
type = with types; attrsOf (oneOf [ str int bool ]);
|
|
default = {};
|
|
description = lib.mdDoc ''
|
|
The configuration to give rss2email.
|
|
|
|
Default will use system-wide `sendmail` to send the
|
|
email. This is rss2email's default when running
|
|
`r2e new`.
|
|
|
|
This set contains key-value associations that will be set in the
|
|
`[DEFAULT]` block along with the
|
|
`to` parameter.
|
|
|
|
See `man r2e` for more information on which
|
|
parameters are accepted.
|
|
'';
|
|
};
|
|
|
|
feeds = mkOption {
|
|
description = lib.mdDoc "The feeds to watch.";
|
|
type = types.attrsOf (types.submodule {
|
|
options = {
|
|
url = mkOption {
|
|
type = types.str;
|
|
description = lib.mdDoc "The URL at which to fetch the feed.";
|
|
};
|
|
|
|
to = mkOption {
|
|
type = with types; nullOr str;
|
|
default = null;
|
|
description = lib.mdDoc ''
|
|
Email address to which to send feed items.
|
|
|
|
If `null`, this will not be set in the
|
|
configuration file, and rss2email will make it default to
|
|
`rss2email.to`.
|
|
'';
|
|
};
|
|
};
|
|
});
|
|
};
|
|
};
|
|
|
|
};
|
|
|
|
|
|
###### implementation
|
|
|
|
config = mkIf cfg.enable {
|
|
users.groups = {
|
|
rss2email.gid = config.ids.gids.rss2email;
|
|
};
|
|
|
|
users.users = {
|
|
rss2email = {
|
|
description = "rss2email user";
|
|
uid = config.ids.uids.rss2email;
|
|
group = "rss2email";
|
|
};
|
|
};
|
|
|
|
environment.systemPackages = with pkgs; [ rss2email ];
|
|
|
|
services.rss2email.config.to = cfg.to;
|
|
|
|
systemd.tmpfiles.rules = [
|
|
"d /var/rss2email 0700 rss2email rss2email - -"
|
|
];
|
|
|
|
systemd.services.rss2email = let
|
|
conf = pkgs.writeText "rss2email.cfg" (lib.generators.toINI {} ({
|
|
DEFAULT = cfg.config;
|
|
} // lib.mapAttrs' (name: feed: nameValuePair "feed.${name}" (
|
|
{ inherit (feed) url; } //
|
|
lib.optionalAttrs (feed.to != null) { inherit (feed) to; }
|
|
)) cfg.feeds
|
|
));
|
|
in
|
|
{
|
|
preStart = ''
|
|
cp ${conf} /var/rss2email/conf.cfg
|
|
if [ ! -f /var/rss2email/db.json ]; then
|
|
echo '{"version":2,"feeds":[]}' > /var/rss2email/db.json
|
|
fi
|
|
'';
|
|
path = [ pkgs.system-sendmail ];
|
|
serviceConfig = {
|
|
ExecStart =
|
|
"${pkgs.rss2email}/bin/r2e -c /var/rss2email/conf.cfg -d /var/rss2email/db.json run";
|
|
User = "rss2email";
|
|
};
|
|
};
|
|
|
|
systemd.timers.rss2email = {
|
|
partOf = [ "rss2email.service" ];
|
|
wantedBy = [ "timers.target" ];
|
|
timerConfig.OnBootSec = "0";
|
|
timerConfig.OnUnitActiveSec = cfg.interval;
|
|
};
|
|
};
|
|
|
|
meta.maintainers = with lib.maintainers; [ ekleog ];
|
|
}
|