https://github.com/rojenzaman/securersyncvpnbackup

Automate secure rsync backups over VPN with Docker, ensuring encrypted data transfer and privacy.
https://github.com/rojenzaman/securersyncvpnbackup

docker-rsync gluetun rsync rsync-backup-script

Last synced: about 1 month ago
JSON representation

Automate secure rsync backups over VPN with Docker, ensuring encrypted data transfer and privacy.

• Host: GitHub
• URL: https://github.com/rojenzaman/securersyncvpnbackup
• Owner: rojenzaman
• License: mit
• Created: 2024-10-18T23:23:13.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2024-10-21T12:50:31.000Z (2 months ago)
• Last Synced: 2024-10-21T18:37:19.001Z (2 months ago)
• Topics: docker-rsync, gluetun, rsync, rsync-backup-script
• Language: Python
• Homepage:
• Size: 30.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SecureRsyncVPNBackup

A Docker-based solution for performing secure `rsync` backups over a VPN network using Gluetun. This setup ensures privacy and security by routing all backup traffic through a VPN connection.

## Features

- **Secure Backups over VPN**: All `rsync` operations are performed over a VPN connection provided by Gluetun.

- **Multiple Server Support**: Backup multiple remote servers, each with its own SSH key and configuration.

- **Per-Server Scheduling**: Configure individual backup intervals for each server directly in `config.json` using hours and minutes.

- **Multiple Paths per Server**: Define multiple files or directories to back up from each remote server.

- **Preserve Directory Hierarchy**: Optionally preserve the full directory hierarchy when backing up.

- **Customizable Backup Directory Structure**: Define custom names for backup directories and choose between date, date-time, or static formats.

- **Automated Retention Policy**: Automatically delete backups older than a specified number of days.

- **Flexible Configuration**: All settings are managed via `config.json`, allowing easy customization without modifying code.

## Configuration

### `config.json`

This file contains all the settings for your backups.

- **`remote_servers`**: An array of servers to back up.

  - **`host`**: The hostname or IP address of the remote server.

  - **`user`**: The SSH username for the remote server.

  - **`paths`**: An array of files or directories on the remote server to back up.

  - **`exclude_paths`**: An optional array of files or directories to exclude from the backup.

  - **`ssh_private_key`**: Path to the SSH private key inside the Docker container.

  - **`backup_name`**: Custom name for the backup directory.

  - **`backup_name_format`**: Format for backup directory names.

  - **`preserve_paths`**: Set to `true` to preserve the full directory hierarchy.

  - **`schedule`**: Scheduling settings for the backup.

    - **`interval_hours`**: Interval in hours between backups.

    - **`interval_minutes`**: Interval in minutes between backups.

**Example with Scheduling:**

```json

{

  "host": "X.X.X.X",

  "user": "root",

  "paths": ["/opt/backup", "/root", "/etc/systemd"],

  "exclude_paths": ["/root/private_data"],

  "ssh_private_key": "/app/ssh/key1",

  "backup_name": "backup1",

  "backup_name_format": "static",

  "preserve_paths": true,

  "schedule": {

    "interval_hours": 2,

    "interval_minutes": 30

  }

}

````

## Usage

1. **Build and Start the Containers**

   ```bash

   docker-compose up -d --build

   ```

2. **Monitor Logs**

   Check the logs to ensure everything is working correctly.

   ```bash

   docker logs ssh-client-container

   ```

3. **Access the Backup Data**

   Your backups will be stored in the `data/sync` directory, organized per your configuration.

## TODO

[Check out the TODO list](TODO.md)

## License

This project is licensed under the MIT License.