felix/nixos
1
0
Fork 0
mirror of https://github.com/Stunkymonkey/nixos.git synced 2025-05-24 09:54:40 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

service/backup: add doInit option

Browse source
This commit is contained in:
Felix Buehler 2023-02-11 21:44:10 +01:00
parent fee07c3a1c
commit 5bd3f8de0a
1 changed files with 23 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

34
modules/services/backup/default.nix
View file

@ -4,53 +4,53 @@ let
in
{
options.my.services.backup = with lib; {
enable = mkEnableOption "Borgbackup Service";
enable = mkEnableOption (lib.mdDoc "Borgbackup Service");
passwordFile = mkOption {
type = types.path;
description = "Password for the backup";
description = lib.mdDoc "Password for the backup";
example = "/run/secrets/password";
};
sshHost = mkOption {
type = types.str;
description = "ssh-hostname for remote access";
description = lib.mdDoc "ssh-hostname for remote access";
default = "u181505-sub1.your-storagebox.de";
example = "test.domain.com";
};
sshUser = mkOption {
type = types.str;
description = "ssh-user for remote access";
description = lib.mdDoc "ssh-user for remote access";
default = "u181505-sub1";
example = "max";
};
sshPort = mkOption {
type = types.port;
description = "ssh-port for remote access";
description = lib.mdDoc "ssh-port for remote access";
default = 23;
example = 22;
};
sshKeyFile = mkOption {
type = types.path;
description = "ssh-key for remote access";
description = lib.mdDoc "ssh-key for remote access";
example = "/run/secrets/ssh_key";
};
OnFailureNotification = mkOption {
type = types.bool;
description = "whether to show a warning to all users or not";
description = lib.mdDoc "whether to show a warning to all users or not";
default = false;
};
OnFailureMail = mkOption {
type = types.nullOr (types.str);
description = "Mail adress where to send the error report";
description = lib.mdDoc "Mail adress where to send the error report";
default = null;
example = "alarm@mail.com";
};
paths = mkOption {
type = with types; listOf str;
description = "additional path(s) to back up";
description = lib.mdDoc "additional path(s) to back up";
default = [ "/" ];
example = [
"/home/user"
@ -58,13 +58,25 @@ in
};
exclude = mkOption {
type = with types; listOf str;
description = "Exclude paths matching any of the given patterns. See `borg help patterns`";
description = lib.mdDoc "Exclude paths matching any of the given patterns. See `borg help patterns`";
default = [ ];
example = [
"/home/*/.cache"
"/tmp"
];
};
doInit = mkOption {
type = types.bool;
description = lib.mdDoc ''
Run {command}`borg init` if the
specified {option}`repo` does not exist.
You should set this to `false`
if the repository is located on an external drive
that might not always be mounted.
'';
default = false;
};
};
config = lib.mkIf cfg.enable {
@ -110,7 +122,7 @@ in
environment.BORG_RSH = "ssh -o 'StrictHostKeyChecking=no' -i ${cfg.sshKeyFile} -p ${toString cfg.sshPort}";
repo = "${cfg.sshUser}@${cfg.sshHost}:${config.networking.hostName}/";
doInit = false;
doInit = cfg.doInit;
compression = "auto,zstd";
postHook = ''