https://github.com/danie1k/rsync-backup

A simple bash script wrapper for the rsync command
https://github.com/danie1k/rsync-backup

bash bash-script cli rsync rsync-backup rsync-backup-script rsync-backups rsync-wrapper

Last synced: 22 days ago
JSON representation

A simple bash script wrapper for the rsync command

• Host: GitHub
• URL: https://github.com/danie1k/rsync-backup
• Owner: danie1k
• License: mit
• Created: 2022-04-12T16:03:48.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-04-18T10:45:04.000Z (over 2 years ago)
• Last Synced: 2024-10-03T11:41:47.328Z (about 1 month ago)
• Topics: bash, bash-script, cli, rsync, rsync-backup, rsync-backup-script, rsync-backups, rsync-wrapper
• Language: Shell
• Homepage:
• Size: 62.5 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Lint](https://github.com/danie1k/rsync-backup/actions/workflows/lint.yml/badge.svg)](https://github.com/danie1k/rsync-backup/actions/workflows/lint.yml)

[![Test](https://github.com/danie1k/rsync-backup/actions/workflows/test.yml/badge.svg)](https://github.com/danie1k/rsync-backup/actions/workflows/test.yml)

[![MIT License](https://img.shields.io/github/license/danie1k/rsync-backup)](https://github.com/danie1k/rsync-backup/blob/master/LICENSE)

# rsync-backup

A simple bash script wrapper for the rsync command

## Requirements

- `bash` (or any other bash-compatible shell; `sh`, `dash`, etc. are not supported)

- `dasel` (https://github.com/TomWright/dasel)

- `jq` (https://github.com/stedolan/jq)

- `rsync`

- `screen`

- `envsubst` (optional, a part of `gettext` package)

## Usage

```shell

$ ./rsync_offsite_backup.sh [OPTIONS]

```

### Options

| Argument    | Description                                         |

|-------------|-----------------------------------------------------|

| `-c string` | Path to config file for this job                    |

| `-d`        | Dry run                                             |

| `-l`        | Show list of the currently running jobs and exit    |

| `-n string` | Custom name of the job                              |

| `-h`        | Shows help                                          |

## Use case scenarios

### Starting new rsync job

```shell

$ ./rsync_offsite_backup.sh -c path/to/config.yml [-d] [-n]

```

### Getting list of currently active jobs

```shell

$ ./rsync_offsite_backup.sh -l

```

### Attaching to the screen of the active job

```shell

$ ./rsync_offsite_backup.sh -r

```

## License

[MIT](./LICENSE)