nixpkgs/nixos/modules/services/system/automatic-timezoned.nix
Sebastián Zavala Villagómez 8a277a6abf nixos/automatic-timezoned: set time.timeZone to null to avoid silent overriding
Currently if a timezone was selected explicitly, the service will
silently override the value, essentially ignoring what is meant to be a
a deliberate choice of option. This may cause confusion as to why the
option is not doing anything when this service is enabled, particularly
in more complex set-ups after some time.

This will simply make the choice deliberate from the user's part, either
by having to remove the option or lowering its priority as a recognition
that it may be ignored.

This change was inspired by the `services.tzupdate` module, which does
the same.

[1]: <https://github.com/NixOS/nixpkgs/blob/master/nixos/modules/services/misc/tzupdate.nix#L24>
2024-10-10 14:33:12 -04:00

95 lines
2.8 KiB
Nix

{ config, lib, pkgs, ... }:
with lib;
let
cfg = config.services.automatic-timezoned;
in
{
options = {
services.automatic-timezoned = {
enable = mkOption {
type = types.bool;
default = false;
description = ''
Enable `automatic-timezoned`, simple daemon for keeping the system
timezone up-to-date based on the current location. It uses geoclue2 to
determine the current location and systemd-timedated to actually set
the timezone.
To avoid silent overriding by the service, if you have explicitly set a
timezone, either remove it or ensure that it is set with a lower priority
than the default value using `lib.mkDefault` or `lib.mkOverride`. This is
to make the choice deliberate. An error will be presented otherwise.
'';
};
package = mkPackageOption pkgs "automatic-timezoned" { };
};
};
config = mkIf cfg.enable {
# This will give users an error if they have set an explicit time
# zone, rather than having the service silently override it.
time.timeZone = null;
security.polkit.extraConfig = ''
polkit.addRule(function(action, subject) {
if (action.id == "org.freedesktop.timedate1.set-timezone"
&& subject.user == "automatic-timezoned") {
return polkit.Result.YES;
}
});
'';
services.geoclue2 = {
enable = true;
appConfig.automatic-timezoned = {
isAllowed = true;
isSystem = true;
users = [ (toString config.ids.uids.automatic-timezoned) ];
};
};
systemd.services = {
automatic-timezoned = {
description = "Automatically update system timezone based on location";
requires = [ "automatic-timezoned-geoclue-agent.service" ];
after = [ "automatic-timezoned-geoclue-agent.service" ];
serviceConfig = {
Type = "exec";
User = "automatic-timezoned";
ExecStart = "${cfg.package}/bin/automatic-timezoned";
};
wantedBy = [ "default.target" ];
};
automatic-timezoned-geoclue-agent = {
description = "Geoclue agent for automatic-timezoned";
requires = [ "geoclue.service" ];
after = [ "geoclue.service" ];
serviceConfig = {
Type = "exec";
User = "automatic-timezoned";
ExecStart = "${pkgs.geoclue2-with-demo-agent}/libexec/geoclue-2.0/demos/agent";
Restart = "on-failure";
PrivateTmp = true;
};
wantedBy = [ "default.target" ];
};
};
users = {
users.automatic-timezoned = {
description = "automatic-timezoned";
uid = config.ids.uids.automatic-timezoned;
group = "automatic-timezoned";
};
groups.automatic-timezoned = {
gid = config.ids.gids.automatic-timezoned;
};
};
};
}