First Commit

2024-10-16 05:44:48 +01:00
commit 21d6ba5733
8 changed files with 632 additions and 0 deletions
@@ -0,0 +1,57 @@
+# Turbo Sync
+
+A no-nonsense file/folder synchronization application
+
+## Requirements
+
+Turbo sync requires **node js** and **rsync**
+
+## Installation
+
+```bash
+npm install --registry="https://git.tben.me/api/packages/Moduletrace/npm/" -g turbo-sync
+```
+
+## Usage
+
+```bash
+turbo-sync ./turbosync.config.json
+```
+
+### Config File
+
+The config file is a json file that contains all the information needed to run turbo-sync. Example:
+
+```json
+[
+    {
+        "title": "Sync Files",
+        "files": [
+            "/home/user/file1.txt",
+            "/home/user/file2.txt",
+            {
+                "path": "/home/user/file3",
+                "user": "root",
+                "host": "5.34.75.236",
+                "ssh_key": "/home/user/.ssh/key"
+            }
+        ]
+    },
+    {
+        "title": "Sync Folders",
+        "options": {
+            "delete": true
+        },
+        "folders": [
+            "/home/user/folder1",
+            "/home/user/folder2",
+            {
+                "path": "/home/user/folder3",
+                "user": "user",
+                "host": "5.39.67.76",
+                "ssh_key": "/home/user/.ssh/key"
+            }
+        ]
+    }
+]
+```