initial commit

docs/modules/home/nextcloud-sync.md

@@ -0,0 +1,75 @@
+# Nextcloud sync client
+
+Because every other client sucks.
+
+View the [*synix* Home Manager module on Forgejo](https://git.sid.ovh/sid/synix/tree/master/modules/home/nextcloud-sync).
+
+## Setup
+
+This is an example home config:
+
+```nix
+{ inputs, config, ... }:
+
+{
+  imports = [
+    inputs.synix.homeModules.nextcloud-sync
+  ];
+
+  services.nextcloud-sync = {
+    enable = true;
+    remote = "cloud.sid.ovh"; # just the URL without `https://`
+    passwordFile = config.sops.secrets.nextcloud.path;
+    connections = [ # absolute paths without trailing /
+      {
+        local = "/home/sid/aud";
+        remote = "/aud";
+      }
+      {
+        local = "/home/sid/doc";
+        remote = "/doc";
+      }
+      {
+        local = "/home/sid/img";
+        remote = "/img";
+      }
+      {
+        local = "/home/sid/vid";
+        remote = "/vid";
+      }
+    ];
+  };
+}
+```
+
+## Usage
+
+You can manually sync by running:
+
+```bash
+nextcloud-sync-all
+```
+
+This will synchronize all defined connections.
+
+## Troubleshooting
+
+Each listed connection spawns a systemd user service and timer. Using the example above, we get:
+
+```plaintext
+nextcloud-sync-aud.service
+nextcloud-sync-aud.timer
+nextcloud-sync-doc.service
+nextcloud-sync-doc.timer
+nextcloud-sync-img.service
+nextcloud-sync-img.timer
+nextcloud-sync-vid.service
+nextcloud-sync-vid.timer
+```
+
+Check their status to know what might go wrong:
+
+```bash
+systemctl --user status nextcloud-sync-doc.service
+journalctl --user -xeu nextcloud-sync-doc.service
+```