From 63adb41f1a060c21a68143eb9e86c2790ef66f36 Mon Sep 17 00:00:00 2001
From: Gregor Kleen <gkleen@yggdrasil.li>
Date: Thu, 8 Aug 2024 10:45:09 +0200
Subject: ...

---
 modules/borgcopy/default.nix | 9 +++++++++
 1 file changed, 9 insertions(+)

(limited to 'modules/borgcopy/default.nix')

diff --git a/modules/borgcopy/default.nix b/modules/borgcopy/default.nix
index afc6c37b..475edbd9 100644
--- a/modules/borgcopy/default.nix
+++ b/modules/borgcopy/default.nix
@@ -61,33 +61,40 @@ in {
         options = {
           from = mkOption {
             type = types.str;
+            description = "Copy from this repository";
           };
           to = mkOption {
             type = types.str;
+            description = "Copy to this repository";
           };
 
           verbosity = mkOption {
             type = types.int;
             default = 3;
+            description = "Set verbosity";
           };
 
           sshConfig = mkOption {
             type = with types; nullOr str;
             default = null;
+            description = "SSH client configuration";
           };
 
           keyfile = mkOption {
             type = with types; nullOr str;
             default = null;
+            description = "Keyfile to pass to borg";
           };
 
           unknownUnencryptedRepoAccessOk = mkOption {
             type = types.bool;
             default = false;
+            description = "Set `BORG_UNKNOWN_UNENCRYPTED_REPO_ACCESS_IS_OK`?";
           };
           hostnameIsUnique = mkOption {
             type = types.bool;
             default = true;
+            description = "Set `BORG_HOSTNAME_IS_UNIQUE`?";
           };
 
           timerOptions = mkOption {
@@ -96,10 +103,12 @@ in {
             default = {
               wantedBy = ["timers.target"];
             };
+            description = "Systemd timer options";
           };
         };
       });
       default = {};
+      description = "Copy borg archives from one repository to another";
     };
   };
 
-- 
cgit v1.2.3