openclaw-workspace-sync 2.2.0 → 2.3.0

package/openclaw.plugin.json

@@ -1,6 +1,10 @@
 {
   "id": "openclaw-workspace-sync",
   "uiHints": {
+    "sync": {
+      "label": "Sync Settings",
+      "help": "Nested sync config (preferred). Same fields as flat config: provider, mode, interval, etc."
+    },
     "provider": {
       "label": "Cloud Provider",
       "help": "Cloud storage provider for workspace sync"
@@ -123,12 +127,54 @@
       "label": "rclone Options",
       "help": "Key-value pairs passed directly to rclone config",
       "advanced": true
+    },
+    "backup.enabled": {
+      "label": "Enable Backups",
+      "help": "Encrypted snapshot backups to cloud storage"
+    },
+    "backup.provider": {
+      "label": "Backup Provider",
+      "help": "Cloud provider for backup storage (can differ from sync provider). Defaults to the sync provider."
+    },
+    "backup.bucket": {
+      "label": "Backup Bucket",
+      "help": "S3/R2 bucket name for backup snapshots"
+    },
+    "backup.prefix": {
+      "label": "Backup Prefix",
+      "placeholder": "habibi/",
+      "help": "Path prefix within the bucket for this agent's snapshots"
+    },
+    "backup.interval": {
+      "label": "Backup Interval (seconds)",
+      "placeholder": "86400",
+      "help": "How often to create backups (default: 86400 = daily)"
+    },
+    "backup.encrypt": {
+      "label": "Encrypt Backups",
+      "help": "Encrypt snapshots with AES-256 before upload"
+    },
+    "backup.passphrase": {
+      "label": "Encryption Passphrase",
+      "sensitive": true,
+      "help": "Passphrase for backup encryption. Use env var: ${BACKUP_PASSPHRASE}"
+    },
+    "backup.include": {
+      "label": "Backup Include",
+      "help": "What to include: workspace, config, cron, memory, sessions, credentials, skills, hooks, extensions, env, agents, pages, transcripts"
+    },
+    "backup.retain": {
+      "label": "Retention",
+      "help": "Number of snapshots to keep, or { daily: N, weekly: N, monthly: N }"
     }
   },
   "configSchema": {
     "type": "object",
-    "additionalProperties": false,
     "properties": {
+      "sync": {
+        "type": "object",
+        "description": "Nested sync config (preferred). Contains the same fields as the flat config: provider, mode, interval, remotePath, etc."
+      },
       "provider": {
         "type": "string",
         "enum": [
@@ -196,6 +242,81 @@
       "copySymlinks": {
         "type": "boolean"
       },
+      "backup": {
+        "type": "object",
+        "additionalProperties": false,
+        "properties": {
+          "enabled": { "type": "boolean" },
+          "provider": {
+            "type": "string",
+            "enum": ["dropbox", "gdrive", "onedrive", "s3", "custom"]
+          },
+          "remoteName": { "type": "string" },
+          "configPath": { "type": "string" },
+          "remotePath": { "type": "string" },
+          "bucket": { "type": "string" },
+          "prefix": { "type": "string" },
+          "interval": { "type": "number", "minimum": 0 },
+          "encrypt": { "type": "boolean" },
+          "passphrase": { "type": "string" },
+          "include": {
+            "type": "array",
+            "items": {
+              "type": "string",
+              "enum": ["workspace", "config", "cron", "memory", "sessions", "credentials", "skills", "hooks", "extensions", "env", "agents", "pages", "transcripts"]
+            }
+          },
+          "retain": {
+            "description": "Number of snapshots to keep, or {daily, weekly, monthly} object for tiered retention"
+          },
+          "exclude": {
+            "type": "array",
+            "items": { "type": "string" }
+          },
+          "s3": {
+            "type": "object",
+            "properties": {
+              "endpoint": { "type": "string" },
+              "bucket": { "type": "string" },
+              "region": { "type": "string" },
+              "accessKeyId": { "type": "string" },
+              "secretAccessKey": { "type": "string" }
+            }
+          },
+          "dropbox": {
+            "type": "object",
+            "properties": {
+              "appFolder": { "type": "boolean" },
+              "appKey": { "type": "string" },
+              "appSecret": { "type": "string" },
+              "token": { "type": "string" }
+            }
+          },
+          "gdrive": {
+            "type": "object",
+            "properties": {
+              "token": { "type": "string" },
+              "teamDrive": { "type": "string" },
+              "rootFolderId": { "type": "string" }
+            }
+          },
+          "onedrive": {
+            "type": "object",
+            "properties": {
+              "token": { "type": "string" },
+              "driveId": { "type": "string" },
+              "driveType": { "type": "string", "enum": ["personal", "business", "sharepoint"] }
+            }
+          },
+          "custom": {
+            "type": "object",
+            "properties": {
+              "rcloneType": { "type": "string" },
+              "rcloneOptions": { "type": "object", "additionalProperties": { "type": "string" } }
+            }
+          }
+        }
+      },
       "s3": {
         "type": "object",
         "additionalProperties": false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openclaw-workspace-sync",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Workspace cloud sync via rclone — mailbox (inbox/outbox), mirror, or bisync (Dropbox, Google Drive, S3, OneDrive, 70+ providers)",
   "type": "module",
   "main": "dist/index.js",

package/skills/workspace-sync/SKILL.md

@@ -80,7 +80,7 @@ Lists files in the configured cloud storage path.
 
 ## Configuration
 
-Workspace sync is configured via the plugin entry in `openclaw.json`:
+Workspace sync is configured via the plugin entry in `openclaw.json`. The preferred format uses nested `sync` and `backup` blocks (flat config at root level is also supported):
 
 ```json
 {
@@ -89,15 +89,17 @@ Workspace sync is configured via the plugin entry in `openclaw.json`:
       "openclaw-workspace-sync": {
         "enabled": true,
         "config": {
-          "provider": "dropbox",
-          "mode": "mailbox",
-          "remotePath": "",
-          "localPath": "/",
-          "interval": 60,
-          "timeout": 1800,
-          "onSessionStart": true,
-          "onSessionEnd": true,
-          "exclude": [".git/**", "node_modules/**", "*.log"]
+          "sync": {
+            "provider": "dropbox",
+            "mode": "mailbox",
+            "remotePath": "",
+            "localPath": "/",
+            "interval": 60,
+            "timeout": 1800,
+            "onSessionStart": true,
+            "onSessionEnd": true,
+            "exclude": [".git/**", "node_modules/**", "*.log"]
+          }
         }
       }
     }
@@ -107,6 +109,8 @@ Workspace sync is configured via the plugin entry in `openclaw.json`:
 
 ### Config keys
 
+These keys live under `sync` in the nested format, or at the config root in flat format.
+
 | Key | Default | Description |
 |-----|---------|-------------|
 | `provider` | `"off"` | `dropbox`, `gdrive`, `onedrive`, `s3`, `custom`, or `off` |
@@ -179,3 +183,46 @@ rclone ls cloud:openclaw-share
 - Only `**/.DS_Store` excluded by default — add your own excludes in config
 - Sync operations run in background (no LLM tokens used)
 - All rclone activity is logged at info level for visibility
+
+## Encrypted backups
+
+Add a `backup` block to the plugin config for automated encrypted snapshots to your own cloud storage (S3, R2, B2, etc.). Backups stream directly (`tar | rclone rcat`) — no local temp files, so they work even when disk space is tight.
+
+### Backup commands
+
+```bash
+openclaw workspace-sync backup now        # Create a snapshot immediately
+openclaw workspace-sync backup list       # List available snapshots
+openclaw workspace-sync backup restore    # Restore latest snapshot
+openclaw workspace-sync backup status     # Check backup service status
+```
+
+### Backup config
+
+```json
+{
+  "backup": {
+    "enabled": true,
+    "provider": "s3",
+    "bucket": "my-backups",
+    "prefix": "agent-name/",
+    "interval": 86400,
+    "encrypt": true,
+    "passphrase": "${BACKUP_PASSPHRASE}",
+    "include": ["workspace", "config", "cron", "memory"],
+    "retain": { "daily": 7, "weekly": 4 }
+  }
+}
+```
+
+| Key | Default | Description |
+|-----|---------|-------------|
+| `enabled` | `false` | Enable scheduled backups |
+| `provider` | parent provider | Cloud provider (can differ from sync provider) |
+| `bucket` | — | S3/R2 bucket name |
+| `prefix` | `""` | Path prefix within the bucket |
+| `interval` | `86400` | Backup interval in seconds (clamped to min 300) |
+| `encrypt` | `false` | AES-256 client-side encryption |
+| `passphrase` | — | Encryption passphrase (use env var) |
+| `include` | `["workspace", "config", "cron", "memory"]` | What to back up |
+| `retain` | `7` | Keep N snapshots, or `{ daily: N, weekly: N }` |