Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/denismurphy/rclone-photo-sync
Syncing photos to an S3 bucket using Rclone
https://github.com/denismurphy/rclone-photo-sync
backup bash linux macos photolibrary photos powershell rclone s3 sync windows zsh
Last synced: about 1 month ago
JSON representation
Syncing photos to an S3 bucket using Rclone
- Host: GitHub
- URL: https://github.com/denismurphy/rclone-photo-sync
- Owner: denismurphy
- License: mit
- Created: 2024-10-16T08:46:49.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-10-21T10:10:15.000Z (3 months ago)
- Last Synced: 2024-11-30T18:47:30.284Z (about 2 months ago)
- Topics: backup, bash, linux, macos, photolibrary, photos, powershell, rclone, s3, sync, windows, zsh
- Language: PowerShell
- Homepage:
- Size: 22.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Rclone Photo Sync
Syncing photos to an S3 bucket using Rclone.
## Prerequisites
- Rclone installed and configured with your S3 bucket
- - https://rclone.org/install/
- Bash (for Unix) or PowerShell (for Windows)
- Appropriate permissions to access the source directory and create/modify files in the script directory
## Setup
1. Choose the appropriate script based on your operating system:
- `photo_sync.sh` for Unix (Linux, macOS)
- `photo_sync.ps1` for Windows
2. Edit the script to set the correct values for:
- `SOURCE_DIR`: The directory containing your photos
- `S3_BUCKET`: Your rclone remote configuration and S3 bucket path
3. Ensure the script has executable permissions (for Unix):
```
chmod +x photo_sync.sh
```
## Usage
Both scripts support the following commands:
- `start`: Begin the sync process
- `stop`: Stop the running sync process
- `restart`: Restart the sync process
- `status`: Check if a sync process is currently running
### Bash Script (Unix)
```bash
./photo_sync.sh {start|stop|restart|status}
```
### PowerShell Script (Windows)
```powershell
.\photo_sync.ps1 {start|stop|restart|status}
```
## Script Details
### photo_sync.sh (Bash)
Key features:
- Uses Rclone to sync photos to an S3 bucket
- Manages the sync process with start, stop, restart, and status functions
- Logs sync activities
- Handles graceful termination and force killing if necessary
### photo_sync.ps1 (PowerShell)
This script is designed for Windows systems. It uses PowerShell to manage the sync process.
Key features:
- Uses Rclone to sync photos to an S3 bucket
- Manages the sync process with start, stop, restart, and status functions
- Logs sync activities
- Handles graceful termination and force killing if necessary
## Customisation
You can customise the following variables in both scripts:
- `SOURCE_DIR`: Set this to the directory containing your photos
- `S3_BUCKET`: Set this to your rclone remote configuration and S3 bucket path
- Adjust rclone parameters in the `start_sync` function to fine-tune the sync process
## Troubleshooting
- If the sync doesn't start, check the log file (`photo_sync.log`) for error messages
- Ensure rclone is properly configured with your S3 bucket
- Verify that the source directory exists and is accessible
- Check that you have the necessary IAM permissions to run the script and access the required S3 bucket