Skip to content

Commit 7befba0

Browse files
tiredofittiredofit
committed
Update README.md
1 parent 583253f commit 7befba0

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

‎README.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -146,18 +146,19 @@ Be sure to view the following repositories to understand all the customizable op
146146
| `SPLIT_DB` | For each backup, create a new archive. `TRUE` or `FALSE` (MySQL and Postgresql Only) | `TRUE` |
147147

148148
### Database Specific Options
149-
| Parameter | Description | Default | `_NAME |
150-
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------ |
151-
| `DB_AUTH` | (Mongo Only - Optional) Authentication Database | | | `DB_TYPE` | Type of DB Server to backup `couch` `influx` `mysql` `pgsql` `mongo` `redis` `sqlite3` | | |
152-
| `DB_HOST` | Server Hostname e.g. `mariadb`. For `sqlite3`, full path to DB file e.g. `/backup/db.sqlite3` | | x |
153-
| `DB_NAME` | Schema Name e.g. `database` or `ALL` to backup all databases the user has access to. Backup multiple by seperating with commas eg `db1,db2` | | x |
154-
| `DB_NAME_EXCLUDE` | If using `ALL` - use this as to exclude databases seperated via commas from being backed up | | x |
155-
| `DB_USER` | username for the database(s) - Can use `root` for MySQL | | x |
156-
| `DB_PASS` | (optional if DB doesn't require it) password for the database | | x |
157-
| `DB_PORT` | (optional) Set port to connect to DB_HOST. Defaults are provided | varies | x |
158-
| `INFLUX_VERSION` | What Version of Influx are you backing up from `1`.x or `2` series - AMD64 and ARM64 only for `2` | | |
159-
| `MONGO_CUSTOM_URI` | If you wish to override the MongoDB Connection string enter it here e.g. `mongodb+srv://username:password@cluster.id.mongodb.net` | | x |
160-
| | This environment variable will be parsed and populate the `DB_NAME` and `DB_HOST` variables to properly build your backup filenames. You can overrde them by making your own entries | | |
149+
| Parameter | Description | Default | `_FILE` |
150+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------- | ------- |
151+
| `DB_AUTH` | (Mongo Only - Optional) Authentication Database | | |
152+
| `DB_TYPE` | Type of DB Server to backup `couch` `influx` `mysql` `pgsql` `mongo` `redis` `sqlite3` | | |
153+
| `DB_HOST` | Server Hostname e.g. `mariadb`. For `sqlite3`, full path to DB file e.g. `/backup/db.sqlite3` | | x |
154+
| `DB_NAME` | Schema Name e.g. `database` or `ALL` to backup all databases the user has access to. Backup multiple by seperating with commas eg `db1,db2` | | x |
155+
| `DB_NAME_EXCLUDE` | If using `ALL` - use this as to exclude databases seperated via commas from being backed up | | x |
156+
| `DB_USER` | username for the database(s) - Can use `root` for MySQL | | x |
157+
| `DB_PASS` | (optional if DB doesn't require it) password for the database | | x |
158+
| `DB_PORT` | (optional) Set port to connect to DB_HOST. Defaults are provided | varies | x |
159+
| `INFLUX_VERSION` | What Version of Influx are you backing up from `1`.x or `2` series - AMD64 and ARM64 only for `2` | | |
160+
| `MONGO_CUSTOM_URI` | If you wish to override the MongoDB Connection string enter it here e.g. `mongodb+srv://username:password@cluster.id.mongodb.net` | | x |
161+
| | This environment variable will be parsed and populate the `DB_NAME` and `DB_HOST` variables to properly build your backup filenames. You can overrde them by making your own entries | | |
161162

162163
#### For Influx DB2:
163164
Your Organization will be mapped to `DB_USER` and your root token will need to be mapped to `DB_PASS`. You may use `DB_NAME=ALL` to backup the entire set of databases. For `DB_HOST` use syntax of `http(s)://db-name`
@@ -225,7 +226,7 @@ Support to upload backup files with [blobxfer](https://github.com/Azure/blobxfer
225226

226227
If `BACKUP_LOCATION` = `blobxfer` then the following options are used.
227228

228-
| Parameter | Description | Default | `_NAME` |
229+
| Parameter | Description | Default | `_FILE` |
229230
| ------------------------------ | ------------------------------------------- | ------------------- | ------- |
230231
| `BLOBXFER_STORAGE_ACCOUNT` | Microsoft Azure Cloud storage account name. | | x |
231232
| `BLOBXFER_STORAGE_ACCOUNT_KEY` | Microsoft Azure Cloud storage account key. | | x |

0 commit comments

Comments
 (0)