diff --git a/modules/services/backup/sitecopy-backup.nix b/modules/services/backup/sitecopy-backup.nix
index 292c7b11311..527a5e5b69d 100644
--- a/modules/services/backup/sitecopy-backup.nix
+++ b/modules/services/backup/sitecopy-backup.nix
@@ -36,20 +36,24 @@ in
};
backups = mkOption {
+ example = [
+ { name = "test";
+ local = "/tmp/backup";
+ remote = "/staff-groups/ewi/st/strategoxt/backup/test";
+ server = "webdata.tudelft.nl";
+ protocol = "webdav";
+ https = true ;
+ }
+ ];
default = [];
description = ''
List of attributesets describing the backups.
- E.g. { name = "test";
- local = "/tmp/backup";
- remote = "/staff-groups/ewi/st/strategoxt/backup/test";
- server = "webdata.tudelft.nl";
- protocol = "webdav";
- https = true ;
- };
- Username/password are extracted from ${stateDir}/sitecopy.secrets at activation
+
+ Username/password are extracted from ${stateDir}/sitecopy.secrets at activation
time. The secrets file lines should have the following structure:
+
server username password
-
+
'';
};