mirrors/docker-db-backup
1
0
Fork 0
mirror of https://github.com/tiredofit/docker-db-backup.git synced 2025-12-23 14:13:43 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

#42 Update README

Browse Source
This commit is contained in:
Yao (Alwyn) Pan
2020-09-18 14:34:06 +10:00
parent b38ad7a5cc
commit 1bc357866f
1 changed files with 23 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@@ -32,28 +32,29 @@ Currently backs up CouchDB, InfluxDB, MySQL, MongoDB, Postgres, Redis servers.
## Table of Contents ## Table of Contents
- [Introduction](#introduction) - [hub.docker.com/r/tiredofit/db-backup](#hubdockercomrtiredofitdb-backup)
- [Authors](#authors) - [Introduction](#introduction)
- [Table of Contents](#table-of-contents) - [Authors](#authors)
- [Prerequisites](#prerequisites) - [Table of Contents](#table-of-contents)
- [Installation](#installation) - [Prerequisites](#prerequisites)
- [Quick Start](#quick-start) - [Installation](#installation)
- [Configuration](#configuration) - [Quick Start](#quick-start)
- [Data-Volumes](#data-volumes) - [Configuration](#configuration)
- [Environment Variables](#environment-variables) - [Data-Volumes](#data-volumes)
- [Maintenance](#maintenance) - [Environment Variables](#environment-variables)
- [Shell Access](#shell-access) - [Maintenance](#maintenance)
- [Custom Scripts](#custom-scripts) - [Shell Access](#shell-access)
- [Example Post Script](#example-post-script) - [Custom Scripts](#custom-scripts)
- [$1=EXIT_CODE (After running backup routine)](#1exit_code-after-running-backup-routine) - [Example Post Script](#example-post-script)
- [$2=DB_TYPE (Type of Backup)](#2db_type-type-of-backup) - [$1=EXIT_CODE (After running backup routine)](#1exit_code-after-running-backup-routine)
- [$3=DB_HOST (Backup Host)](#3db_host-backup-host) - [$2=DB_TYPE (Type of Backup)](#2db_type-type-of-backup)
- [#4=DB_NAME (Name of Database backed up](#4db_name-name-of-database-backed-up) - [$3=DB_HOST (Backup Host)](#3db_host-backup-host)
- [$5=DATE (Date of Backup)](#5date-date-of-backup) - [#4=DB_NAME (Name of Database backed up](#4db_name-name-of-database-backed-up)
- [$6=TIME (Time of Backup)](#6time-time-of-backup) - [$5=DATE (Date of Backup)](#5date-date-of-backup)
- [$7=BACKUP_FILENAME (Filename of Backup)](#7backup_filename-filename-of-backup) - [$6=TIME (Time of Backup)](#6time-time-of-backup)
- [$8=FILESIZE (Filesize of backup)](#8filesize-filesize-of-backup) - [$7=BACKUP_FILENAME (Filename of Backup)](#7backup_filename-filename-of-backup)
- [$9=MD5_RESULT (MD5Sum if enabled)](#9md5_result-md5sum-if-enabled) - [$8=FILESIZE (Filesize of backup)](#8filesize-filesize-of-backup)
- [$9=MD5_RESULT (MD5Sum if enabled)](#9md5_result-md5sum-if-enabled)
## Prerequisites ## Prerequisites
@@ -90,8 +91,6 @@ The following directories are used for configuration and can be mapped for persi
### Environment Variables ### Environment Variables
*If you are trying to backup a database that doesn't have a user or a password (you should!) make sure you set `CONTAINER_ENABLE_DOCKER_SECRETS=FALSE`*
Along with the Environment Variables from the [Base image](https://hub.docker.com/r/tiredofit/alpine), below is the complete list of available options that can be used to customize your installation. Along with the Environment Variables from the [Base image](https://hub.docker.com/r/tiredofit/alpine), below is the complete list of available options that can be used to customize your installation.
| Parameter | Description | | Parameter | Description |