From 4a076f9f9e2a33233c83384429dc8d1aa9f8f08b Mon Sep 17 00:00:00 2001 From: Peter Schiffer Date: Fri, 12 Jan 2024 17:24:42 +0100 Subject: [PATCH] Update README --- .github/FUNDING.yml | 2 ++ README.md | 5 +++++ 2 files changed, 7 insertions(+) create mode 100644 .github/FUNDING.yml diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..a4dc6af --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +github: pschiffe +custom: "https://www.paypal.com/paypalme/pschiffe" diff --git a/README.md b/README.md index c9c4181..c48aff9 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,11 @@ Docker Hub: https://hub.docker.com/r/pschiffe/borg Source GitHub repository: https://github.com/pschiffe/docker-borg +--- +[![Static Badge](https://img.shields.io/badge/GitHub_Sponsors-grey?logo=github)](https://github.com/sponsors/pschiffe) [![Static Badge](https://img.shields.io/badge/paypal.me-grey?logo=paypal)](https://www.paypal.com/paypalme/pschiffe) + +If this project is useful to you, please consider sponsoring me to support maintenance and further development. Thank you! + ## Quick start First, pull the image to keep it up to date. Then create and run the borg backup container. In this quick start, the `/etc` and `/home` directories from the host are bind mounted to the container as read only. These are the directories which will be backed up. The backed up data will be stored in the `borg-repo` Docker volume, and the data will be protected with the `my-secret-pw` password. If the host is using SELinux, use the `--security-opt label:disable` flag. This is because we don't want to relabel the `/etc` and `/home` directories, but we do want the container to have access to them. After the backup is done, data will be pruned according to the default policy and checked for errors. Borg runs in verbose mode within the container, which means it will print detailed output from the backup. At the end, the container is deleted. This is done using a separate `docker rm` command. We do this because the `--rm` option in `docker run` would also remove the Docker volumes, which we don't want. By deleting the container and pulling the image from the registry each time, we ensure the container is fresh for each backup run.