diff --git a/README.md b/README.md index 689d71c..8911d90 100644 --- a/README.md +++ b/README.md @@ -1,50 +1,91 @@ # Standard Backups -> [!WARNING] -> This repository and project is very early in development. It's currently in the prototyping stages and doesn't fully function. It's **not ready for production use at all**. +Standard Backups is a generic backup orchestration tool with a plugin +architecture that lets it work with existing backup tools that you love and +trust. It handles all the boring logic (preparing backups, performing backups, +cleanup, secret management, etc.) and lets you focus on what you want to backup +and where you want those backups to go. -Standard backups is currently merely an idea trying to take shape. I'm actively working on building a first proof of concept and I'll see how things move out from there. +## Getting Started -## The Idea +Standard Backups uses backends to integrate with existing backup tools which +perform the backups. So you first need to choose which backend you'll be using. +Note that you can use more than one backend and you can change backends if you +change your mind. -If you've ever wanted to setup backups on linux, you've probably quickly realized that there's a lot of great tools out there but as an admin you have to figure out two things: +The following backends are currently distributed along side Standard Backups: -1. When and how do you run those backup tools to produce correct backups. -1. How do you backup all the apps and services you run on your servers. +- [Restic](https://restic.net/): A fully featured backend that integrates with + restic, a popular, fast, and secure backup program. +- Rsync: An example backend that uses rsync to backup files. -### Standard Orchestration and Pluggable Backup Tools +### Install -In practice, this leads you to build sketchy one-off scripts for your backups. The quality of those script will vary with your programming know-how and how much time and effort you put into them. This should be easier. +You'll need to install `standard-backups` itself as well as a backend. Backends +are plugins that integrate with existing backup tools. You can use more than one +backend, but you'll need at least one. -There are tools out there that handle this backup orchestration for you but they're bound to specific backup tools. That means that if you want to use `restic` for your backups you need to use one orchestration tool and if you want to use `borg` you need to use another. That's better but not ideal. +1. Open the latest + [release](https://github.com/dotboris/standard-backups/releases/latest) page. +1. Download the `standard-backups` package for your package manager and + architecture. +1. Download at least one backend (`standard-backups-*-backend`) package for your + package manager and architecture. +1. Install those packages with the instructions below. Must be run as `root`. -This ends up being a lot of programs that all pretty much do the same thing. Some are in-house private scripts while others are open source tools. The level of quality and maintenance across those can vary quite a bit depending on much time and effort maintainers have to give. This seems like a lot of duplicate work. +
+DEB based Linux distributions (e.g. Ubuntu, Debian) -The idea behind `standard-backups` is to implement a standardized backup orchestration process once and then integrate backup tools in a pluggable way. We save on all the custom scripts and different orchestration tools. This addresses point 1 above. +Go to the directory where you downloaded the `.deb` files for Standard Backups +and at least one backend. Then, run the following commands: -### Pluggable and Pre-defined Backup Recipes +```sh +apt update +apt install ./standard-backups-*.deb +``` -As a general rule of thumb, backing up an app or service usually involves a few simple steps: +
-1. Run some commands to prepare for the backup (optional) -1. Backup one or many directories -1. Run some commands to clean up after the backup (optional) +
+RPM based Linux distributions (e.g. Fedora) -This varies from one app to the next. Some apps are nice enough to provide guides and instructions in their documentation while others leave you to reverse engineer things. In a classic scenario, it's the system administrator who's stuck with this task. Problem is that they might be not be well equipped to do that. After all, running and operating an app doesn't mean that you know enough inner plumbing to extract its data for backups. +Go to the directory where you downloaded the `.rpm` files for Standard Backups +and at least one backend. Then, run the following commands: -Wouldn't it be nice if the people who know the most about the app were able to provide all of that for you? +```sh +dnf install --refresh ./standard-backups-*.rpm +``` -With `standard-backups` the rules on how to backup a given app are defined in a separate manifest that can be provided by the app developer or maintainer. If that doesn't work, it can be provided by package maintainers or even the community. Separating things this way allows you to pull use recipes from trusted sources instead of having to figure out things on your own. +
-### Simple Backups for Admins +
+Alpine Linux -So what's left for system administrators? Simple high level configuration. Using `standard-backups`' config, admins can: +Go to the directory where you downloaded the `.apk` files for Standard Backups +and at least one backend. Then, run the following commands: -- choose which backup tools to use, -- define destinations which are different instances of those backup tools (ex: local vs remote), -- define jobs which connect recipes with one or more targets. +```sh +apk update +apk add --allow-untrusted ./standard-backups-*.apk +``` -From there, they run `standard-backups` on a schedule and leave it to do all the hard work. +
+ +
+Arch Linux + +Go to the directory where you downloaded the `.pkg.tar.zst` files for Standard +Backups and at least one backend. Then, run the following commands: + +```sh +pacman -Sy +pacman -U ./standard-backups-*.pkg.tar.zst +``` + +
+ +To validate your installation, simply run `standard-backups list-backends`. This +should show you the backends that you have installed. ## License