Files
home-manager/modules/programs/keepassxc.nix
Austin Horstman 355734d876 treewide: remove literalExpression where unneeded
`literalExpression` is intended just to signify code that needs to stay
a string that gets represented exactly as-is for docs. It has been
misused heavily and people get confused repeatedly on when or not to use
it because of the rampant misuse.
2026-05-17 21:43:25 -05:00

119 lines
3.3 KiB
Nix

{
config,
lib,
pkgs,
...
}:
let
cfg = config.programs.keepassxc;
iniFormat = pkgs.formats.ini { };
in
{
meta.maintainers = with lib.maintainers; [
bmrips
d-brasher
];
options.programs.keepassxc = {
enable = lib.mkEnableOption "keepassxc" // {
description = ''
Whether to enable KeePassXC.
::: {.note}
When this flag is set, KeePassXC' builtin native messaging manifest for
communication with its browser extension is automatically installed.
This conflicts with KeePassXC' builtin installation mechanism. To
prevent error messages, either set
{option}`programs.keepassxc.settings.Browser.UpdateBinaryPath` to
`false`, or untick the checkbox
Application Settings/
Browser Integration/
Advanced/
Update native messaging manifest files at startup
in the GUI.
:::
'';
};
package = lib.mkPackageOption pkgs "keepassxc" { nullable = true; };
settings = lib.mkOption {
inherit (iniFormat) type;
default = { };
example = {
Browser.Enabled = true;
GUI = {
AdvancedSettings = true;
ApplicationTheme = "dark";
CompactMode = true;
HidePasswords = true;
};
SSHAgent.Enabled = true;
};
description = ''
Configuration written to
{file}`$XDG_CONFIG_HOME/keepassxc/keepassxc.ini`.
See <https://github.com/keepassxreboot/keepassxc/blob/develop/src/core/Config.cpp>
for the full list of options.
::: {.note}
When the settings are non-empty, the configuration file will be linked
into the Nix store and KeePassXC will report an access error for its
configuration file. This is expected and can not be fixed in a way that
aligns with Home Manager's principles. See [#8257](https://github.com/nix-community/home-manager/issues/8257) for more details.
:::
'';
};
autostart = lib.mkOption {
type = lib.types.bool;
default = false;
example = true;
description = ''
Whether to start KeePassXC automatically on login through the XDG autostart mechanism.
'';
};
};
config = lib.mkIf cfg.enable (
lib.mkMerge [
{
assertions = [
{
assertion = cfg.autostart -> config.xdg.autostart.enable;
message = ''
{option}`xdg.autostart.enable` has to be enabled in order for
{option}`programs.keepassxc.autostart` to be effective.
'';
}
];
xdg.autostart.entries = lib.mkIf cfg.autostart [
"${cfg.package}/share/applications/org.keepassxc.KeePassXC.desktop"
];
xdg.configFile."keepassxc/keepassxc.ini" = lib.mkIf (cfg.settings != { }) {
source = iniFormat.generate "keepassxc-settings" cfg.settings;
};
}
(lib.mkIf (cfg.package != null) {
home.packages = [ cfg.package ];
programs.brave.nativeMessagingHosts = [ cfg.package ];
programs.chromium.nativeMessagingHosts = [ cfg.package ];
programs.firefox.nativeMessagingHosts = [ cfg.package ];
programs.floorp.nativeMessagingHosts = [ cfg.package ];
programs.vivaldi.nativeMessagingHosts = [ cfg.package ];
})
]
);
}