diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 |
1 files changed, 20 insertions, 23 deletions
@@ -2,8 +2,9 @@ <img src="logo.png" width="120" markdown="1"> -Sync any two paths with cloud backup. - +Sync any two paths with each other & cloud backup. +Uses `unison` to sync the paths, rclone to sync to a cloud provider. + ## Setup ```bash @@ -17,12 +18,21 @@ just setup ## Use ```bash -just sync-paths # Between paths +just sync-paths # Between paths (SOURCE and TARGET in justfile) just sync-cloud # To cloud just status # Check ``` -## Windows Setup (Linux filesystems) + +## Commands + +- `setup` - Create directories +- `check` - Verify paths +- `sync-paths` - Fast sync (unison) +- `sync-cloud` - Cloud backup (rclone) +- `status` - Show state + +## Windows (WSL) Setup for linux FS external drives ```bash # 1. Identify drive (as Admin) @@ -48,23 +58,10 @@ sudo umount /mnt/ext4drive wsl --unmount \\.\PHYSICALDRIVE1 # (as Admin) ``` -## Structure - -``` -SOURCE/usync/ # Your files -TARGET/usync/ # Copy -cloud:/usync/ # Backup -``` - -## Commands - -- `setup` - Create directories -- `check` - Verify paths -- `sync-paths` - Fast sync (unison) -- `sync-cloud` - Cloud backup (rclone) -- `status` - Show state - -## Files +## Configure -- `justfile` - Set SOURCE and TARGET paths -- `unison-profile.prf` - Sync settings +Edit justfile: +- SOURCE/TARGET - paths to sync +- CLOUD_REMOTE - rclone remote name +- CLOUD_PATH - cloud folder (default: /usync) +- CLOUD_MOUNT_PATH - local mount (default: ~/cloud-mount)
\ No newline at end of file |