diff --git a/README.md b/README.md index 8a2d3aa..7d9d545 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,7 @@ Along with the Environment Variables from the [Base image](https://hub.docker.co | Parameter | Description | |-----------|-------------| +| `COMPRESSION` | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, or none `NONE` - Default `GZ` | `DB_TYPE` | Type of DB Server to backup `couch` `influx` `mysql` `pgsql` `mongo` `redis` `rethink` | `DB_SERVER` | Server Hostname e.g. `mariadb` | `DB_NAME` | Schema Name e.g. `database` @@ -95,14 +96,11 @@ Along with the Environment Variables from the [Base image](https://hub.docker.co | `DB_DUMP_BEGIN` | What time to do the first dump. Defaults to immediate. Must be in one of two formats | | Absolute HHMM, e.g. `2330` or `0415` | | Relative +MM, i.e. how many minutes after starting the container, e.g. `+0` (immediate), `+10` (in 10 minutes), or `+90` in an hour and a half -| `DB_DUMP_DEBUG` | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed. -| `DB_DUMP_TARGET` | Where to put the dump file, should be a directory. Supports three formats | -| | Local If the value of `DB_DUMP_TARGET` starts with a `/` character, will dump to a local path, which should be volume-mounted. | `DB_CLEANUP_TIME` | Value in minutes to delete old backups (only fired when dump freqency fires). 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. -| `COMPRESSION` | Use either Gzip `GZ`, Bzip2 `BZ`, XZip `XZ`, or none `NONE` - Default `GZ` +| `DEBUG_MODE` | If set to `true`, print copious shell script messages to the container log. Otherwise only basic messages are printed. | `MD5` | Generate MD5 Sum in Directory, `TRUE` or `FALSE` - Default `TRUE` -| `SPLIT_DB` | If using root as username and multiple DBs on system, set to TRUE to create Seperate DB Backups instead of all in one. - Default `FALSE` | | `PARALLEL_COMPRESSION` | Use multiple cores when compressing backups `TRUE` or `FALSE` - Default `TRUE` | +| `SPLIT_DB` | If using root as username and multiple DBs on system, set to TRUE to create Seperate DB Backups instead of all in one. - Default `FALSE` | ## Maintenance