From d186f83162a38b38a326f0de4a9858c8e0ed8d44 Mon Sep 17 00:00:00 2001 From: khaneliman Date: Wed, 19 Mar 2025 18:50:36 +0000 Subject: [PATCH] deploy: eb5d59dac9d77717135fdec1ef51c14a72e8c9f9 --- options.xhtml | 198 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 198 insertions(+) diff --git a/options.xhtml b/options.xhtml index a2dbf0a2e..be1b25221 100644 --- a/options.xhtml +++ b/options.xhtml @@ -47160,6 +47160,204 @@ null or package

+
+ + programs.rclone.enable + + +
+
+

Whether to enable rclone.

+ +

Type: +boolean

+ +

Default: +false

+ +

Example: +true

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.package + + +
+
+

The rclone package to use.

+ +

Type: +package

+ +

Default: +pkgs.rclone

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.remotes + + +
+
+

An attribute set of remote configurations. Each remote consists of regular +configuration options and optional secrets.

See https://rclone.org/docs/ for more information on configuring specific +remotes.

+ +

Type: +attribute set of (submodule)

+ +

Default: +{ }

+ +

Example:

{
+  b2 = {
+    config = {
+      type = "b2";
+      hard_delete = true;
+    };
+    secrets = {
+      # using sops
+      account = config.sops.secrets.b2-acc-id.path;
+      # using agenix
+      key = config.age.secrets.b2-key.path;
+    };
+  };
+
+  server.config = {
+    type = "sftp";
+    host = "server";
+    user = "backup";
+    key_file = "${home.homeDirectory}/.ssh/id_ed25519";
+  };
+}
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.remotes.<name>.config + + +
+
+

Regular configuration options as described in rclone’s documentation +https://rclone.org/docs/. When specifying options follow the formatting +process outlined here https://rclone.org/docs/#config-config-file, namley:

  • Remove the leading double-dash (–) from the rclone option name

  • Replace hyphens (-) with underscores (_)

  • Convert to lowercase

  • Use the resulting string as your configuration key

For example, the rclone option “–mega-hard-delete” would use “hard_delete” +as the config key.

Security Note: Always use the secrets option for sensitive data +instead of the config option to prevent exposing credentials to +the world-readable Nix store.

+ +

Type: +attribute set of (null or boolean or signed integer or floating point number or string)

+ +

Default: +{ }

+ +

Example:

{
+  type = "mega"; # Required - specifies the remote type
+  user = "you@example.com";
+  hard_delete = true;
+}
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.remotes.<name>.secrets + + +
+
+

Sensitive configuration values such as passwords, API keys, and tokens. These +must be provided as file paths to the secrets, which will be read at activation +time.

Note: If using secret management solutions like agenix or sops-nix with +home-manager, you need to ensure their services are activated before switching +to this home-manager generation. Consider setting +systemd.user.startServices to "sd-switch" for automatic service +startup.

+ +

Type: +attribute set of string

+ +

Default: +{ }

+ +

Example:

{
+  password = "/run/secrets/password";
+  api_key = config.age.secrets.api-key.path;
+}
+
+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
+
+ + programs.rclone.writeAfter + + +
+
+

Controls when the rclone configuration is written during Home Manager activation. +You should not need to change this unless you have very specific activation order +requirements.

+ +

Type: +string

+ +

Default: +"reloadSystemd"

+ +

Declared by:

+ + +
+ +<home-manager/modules/programs/rclone.nix> + +
+
programs.readline.enable