Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/totekuh/ssh-sync
SSH Sync Folders is a simple and Bash script for syncing a local directory with a remote directory over SSH using rsync and inotifywait. The script monitors the local directory for changes and automatically syncs the updated files to the remote directory.
https://github.com/totekuh/ssh-sync
bash makefile rsync ssh sshpass sync syncronization
Last synced: 20 days ago
JSON representation
SSH Sync Folders is a simple and Bash script for syncing a local directory with a remote directory over SSH using rsync and inotifywait. The script monitors the local directory for changes and automatically syncs the updated files to the remote directory.
- Host: GitHub
- URL: https://github.com/totekuh/ssh-sync
- Owner: totekuh
- Created: 2023-04-27T10:40:55.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-07-03T23:50:07.000Z (over 1 year ago)
- Last Synced: 2024-11-05T09:26:01.729Z (2 months ago)
- Topics: bash, makefile, rsync, ssh, sshpass, sync, syncronization
- Language: Shell
- Homepage:
- Size: 5.86 KB
- Stars: 3
- Watchers: 1
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Description
A simple Bash script to sync a local directory with a remote directory over SSH using rsync and inotifywait.
The script sets up file watches on the local directory and automatically syncs any changes to the remote directory.
If the initial sync fails due to permission issues or other errors, the script will not set up watches and will exit.
## Usage
```bash
ssh-sync-folders [OPTIONS]
```
### Options
- `-l`, --local-dir=DIR: Local directory to be synced (default: current directory)
- `-u`, --remote-user=USER: Remote SSH user
- `-p`, --remote-pass=PASSWORD: Remote SSH password (optional)
- `-h`, --remote-host=HOST: Remote SSH host
- `-d`, --remote-dir=DIR: Remote directory to sync to (default: /shared)
- `-e`, --exclude=PATTERNS: Comma-separated list of file/folder patterns to exclude
To display the help message, run the script with the `--help` option:
```bash
ssh-sync-folders --help
```
You can configure the script using environment variables or command-line options. Command-line options take precedence over environment variables.
Configure the following environment variables before running the script, unless you provide the options via command-line arguments:
- `SSH_SYNC_LOCAL_DIR`: Local directory to be synced
- `SSH_SYNC_REMOTE_USER`: Remote SSH user
- `SSH_SYNC_REMOTE_PASS`: Remote SSH password (optional if using RSA keys)
- `SSH_SYNC_REMOTE_HOST`: Remote SSH host
- `SSH_SYNC_REMOTE_DIR`: Remote directory to sync to
- `SSH_SYNC_EXCLUDE_PATTERNS`: Comma-separated list of file/folder patterns to exclude
## Dependencies
- `rsync`
- `inotify-tools`
- `sshpass` (optional, required if using a remote password)
## Installation
A Makefile is included for easy installation and uninstallation.
To install the script, simply run:
```bash
make install
```
This will copy the script to `/usr/bin` and make it executable.
To uninstall the script, run:
```bash
make uninstall
```
To configure environment variables, run:
```bash
make configure
```
## Example
```bash
ssh-sync-folders -l /path/to/local/dir -u remote_user -h remote_host -d /path/to/remote/dir -e ".git,*.log"
```
This command will sync `/path/to/local/dir` to `/path/to/remote/dir` on the remote host, excluding any `.git` directories and `*.log` files.
The local directory will be watched for changes, and any modifications will be synced to the remote directory automatically.