Skip to content

Commit 635411b

Browse files
tiredofittiredofit
committed
Update README.md
1 parent 39776a9 commit 635411b

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

‎README.md‎

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -212,6 +212,8 @@ If these are set and no other defaults or variables are set explicitly, they wil
212212

213213
##### Encryption Options
214214

215+
Encryption occurs after compression and the encrypted filename will have a `.gpg` suffix
216+
215217
| Variable | Description | Default |
216218
| ---------------------------- | ------------------------------------------- | ------- |
217219
| `DEFAULT_ENCRYPT` | Encrypt file after backing up with GPG | `FALSE` |
@@ -229,7 +231,7 @@ If these are set and no other defaults or variables are set explicitly, they wil
229231
| | Absolute HHMM, e.g. `2330` or `0415` | |
230232
| | 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 | |
231233
| | Full datestamp e.g. `2023-12-21 23:30:00` | |
232-
| | Cron expression e.g. `30 23 * * *` - [Understand the format](https://en.wikipedia.org/wiki/ Cron) - *BACKUP_INTERVAL is ignored* | |
234+
| | Cron expression e.g. `30 23 * * *` [Understand the format](https://en.wikipedia.org/wiki/Cron) - *BACKUP_INTERVAL is ignored* | |
233235
| `DEFAULT_CLEANUP_TIME` | Value in minutes to delete old backups (only fired when backup interval executes) | `FALSE` |
234236
| | 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. | |
235237
| `DEFAULT_ARCHIVE_TIME` | Value in minutes to move all files files older than (x) from | |
@@ -390,11 +392,11 @@ echo "${1} Backup Starting on ${2} for ${3} at ${4}. Filename: ${5}"
390392
```
391393

392394
## script DBXX_TYPE DBXX_HOST DBXX_NAME STARTEPOCH BACKUP_FILENAME
393-
${f} "${backup_job_db_type}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${target}"
395+
${f} "${backup_job_db_type}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${backup_job_file}"
394396

395397
Outputs the following on the console:
396398

397-
`mysql Backup Starting on example-db for example at 1647370800. Filename: mysql_example_example-db_202200315-000000.sql.bz2
399+
`mysql Backup Starting on example-db for example at 1647370800. Filename: mysql_example_example-db_202200315-000000.sql.bz2`
398400

399401
###### Post backup
400402

@@ -421,7 +423,7 @@ echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ending ${6} for a dura
421423
```
422424

423425
## script EXIT_CODE DB_TYPE DB_HOST DB_NAME STARTEPOCH FINISHEPOCH DURATIONEPOCH BACKUP_FILENAME FILESIZE CHECKSUMVALUE
424-
${f} "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${backup_routines_finish_time}" "${backup_routines_total_time}" "${target}" "${FILESIZE}" "${checksum_value}" "${move_exit_code}
426+
${f} "${exit_code}" "${dbtype}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${backup_routines_finish_time}" "${backup_routines_total_time}" "${backup_job_file}" "${filesize}" "${checksum_value}" "${move_exit_code}
425427

426428
Outputs the following on the console:
427429

@@ -471,6 +473,8 @@ Otherwise, override them per backup job. Additional backup jobs can be scheduled
471473

472474
##### Encryption Options
473475

476+
Encryption will occur after compression and the resulting filename will have a `.gpg` suffix
477+
474478
| Variable | Description | Default |
475479
| ------------------------- | ------------------------------------------- | ------- |
476480
| `DB01_ENCRYPT` | Encrypt file after backing up with GPG | `FALSE` |
@@ -488,7 +492,7 @@ Otherwise, override them per backup job. Additional backup jobs can be scheduled
488492
| | Absolute HHMM, e.g. `2330` or `0415` | |
489493
| | 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 | |
490494
| | Full datestamp e.g. `2023-12-21 23:30:00` | |
491-
| | Cron expression e.g. `30 23 * * *` - [Understand the format](https://en.wikipedia.org/wiki/ Cron) - *BACKUP_INTERVAL is ignored* | |
495+
| | Cron expression e.g. `30 23 * * *` [Understand the format](https://en.wikipedia.org/wiki/Cron) - *BACKUP_INTERVAL is ignored* | |
492496
| `DB01_CLEANUP_TIME` | Value in minutes to delete old backups (only fired when backup interval executes) | `FALSE` |
493497
| | 1440 would delete anything above 1 day old. You don't need to set this variable if you want to hold onto everything. | |
494498
| `DB01_ARCHIVE_TIME` | Value in minutes to move all files files older than (x) from `DB01_BACKUP_FILESYSTEM_PATH` | |
@@ -630,7 +634,7 @@ If `DB01_BACKUP_LOCATION` = `blobxfer` then the following options are used:.
630634
| `DB01_BLOBXFER_STORAGE_ACCOUNT_KEY` | Microsoft Azure Cloud storage account key. | | x |
631635
| `DB01_BLOBXFER_REMOTE_PATH` | Remote Azure path | `/docker-db-backup` | x |
632636

633-
> This service uploads files from backup target directory `DB01_BACKUP_FILESYSTEM_PATH`.
637+
> This service uploads files from backup directory `DB01_BACKUP_FILESYSTEM_PATH`.
634638
> If the a cleanup configuration in `DB01_CLEANUP_TIME` is defined, the remote directory on Azure storage will also be cleaned automatically.
635639
636640
##### Hooks
@@ -663,11 +667,11 @@ echo "${1} Backup Starting on ${2} for ${3} at ${4}. Filename: ${5}"
663667
```
664668

665669
## script DB01_TYPE DB01_HOST DB01_NAME STARTEPOCH BACKUP_FILENAME
666-
${f} "${backup_job_db_type}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${target}"
670+
${f} "${backup_job_db_type}" "${backup_job_db_host}" "${backup_job_db_name}" "${backup_routines_start_time}" "${backup_job_filename}"
667671

668672
Outputs the following on the console:
669673

670-
`mysql Backup Starting on example-db for example at 1647370800. Filename: mysql_example_example-db_202200315-000000.sql.bz2
674+
`mysql Backup Starting on example-db for example at 1647370800. Filename: mysql_example_example-db_202200315-000000.sql.bz2`
671675

672676
###### Post backup
673677

@@ -694,7 +698,7 @@ echo "${1} ${2} Backup Completed on ${3} for ${4} on ${5} ending ${6} for a dura
694698
```
695699

696700
## script EXIT_CODE DB_TYPE DB_HOST DB_NAME STARTEPOCH FINISHEPOCH DURATIONEPOCH BACKUP_FILENAME FILESIZE CHECKSUMVALUE
697-
${f} "${exit_code}" "${dbtype}" "${dbhost}" "${dbname}" "${backup_routines_start_time}" "${backup_routines_finish_time}" "${backup_routines_total_time}" "${target}" "${FILESIZE}" "${checksum_value}" "${move_exit_code}
701+
${f} "${exit_code}" "${dbtype}" "${dbhost}" "${dbname}" "${backup_routines_start_time}" "${backup_routines_finish_time}" "${backup_routines_total_time}" "${backup_job_filename}" "${filesize}" "${checksum_value}" "${move_exit_code}
698702

699703
Outputs the following on the console:
700704

0 commit comments

Comments
 (0)