From b0fe97f79361161a78f7432e700270549665bdd4 Mon Sep 17 00:00:00 2001 From: Baptiste Bouchereau Date: Mon, 29 Aug 2022 23:30:31 -0700 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 1ec36e9..376d1df 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,23 @@ Borg backup cron A docker image to backup periodically a folder using borg. Additionnally this image can: -- dump a mysql database in the same folder beforehand -- dump a mongo database -- create an elasticsearch snapshot -- send an email on failure +* dump a mysql database in the same folder beforehand +* dump a mongo database +* create an elasticsearch snapshot +* end an email on failure + You can also run the cron job directly by overriding the command with `/var/backup_script.sh` -- [Borg backup cron](#borg-backup-cron) - - [Build](#build) - - [Usage](#usage) - - [With mysql dump](#with-mysql-dump) - - [With mongo dump](#with-mongo-dump) - - [With elasticsearch snapshot](#with-elasticsearch-snapshot) - - [Sending an email on failure](#sending-an-email-on-failure) +Table of contents +----------------- + +- [Build](#build) +- [Usage](#usage) + - [With mysql dump](#with-mysql-dump) + - [With mongo dump](#with-mongo-dump) + - [With elasticsearch snapshot](#with-elasticsearch-snapshot) + - [Sending an email on failure](#sending-an-email-on-failure) + - [Use secrets instead of env variables](#use-secrets-instead-of-env-variables) Build ----- @@ -97,6 +101,8 @@ docker run \ ovski/borgbackup-cron ``` +### Use secrets instead of env variables + You can also use secrets in a stack to store sensitive information. Instead of specifiying environment variables, create the following secrets in /var/secrets (default location):