Skip to content

Simple backup tool for your self-hosted service with the power of Rclone

License

Notifications You must be signed in to change notification settings

koro33e/s-backup

Repository files navigation

S-Backup

Release License Stars


S-Backup is a simple, efficient backup tool for self-hosted service configurations and data, using powerful Rclone as backend. It is designed for automation, reliability, and ease of use.


Features

  • 📦 Backup to Rclone supported storage
  • 🕒 Schedule backups with cron
  • 🔧 Easy and powerful TOML configuration
  • 🐳 Docker & CLI support

Configuration

Copy and edit s-backup-cfg.example.toml

Usage

Docker (Recommended)

docker run -d \
  -v /path/to/s-backup.toml:/app/s-backup.toml \
  -v /path/to/rclone/config/dir:/app/rclone/ \
  -v /path/to/backup:/app/data/backup_path_in_config:ro \
  ghcr.io/koro33/s-backup:latest \
  run --config /app/s-backup.toml --rclone-config /app/rclone/rclone.conf

Or with Docker Compose, see docker-compose.example.yml for example.

Attention: You need to mount the host rclone config dir at /config/rclone into the Docker container. Due to the fact that rclone updates tokens inside its config file, and that the update process involves a file rename, you need to mount the whole host rclone config dir, not just the single host rclone config file.

Details see rclone doc

CLI

# Run backup
s-backup run --config /path/to/s-backup.toml --rclone-config /path/to/rclone.conf

Contributing

Contributions, issues, and feature requests are welcome! Feel free to open an issue or pull request.

License

This project is licensed under the MIT License.

About

Simple backup tool for your self-hosted service with the power of Rclone

Topics

Resources

License

Stars

Watchers

Forks

Packages