Skip to content

Commit 666eb81

Browse files
committed
Add blobxfer documentation in readme file.
1 parent 4572ab6 commit 666eb81

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@ Images are built primarily for `amd64` architecture, and may also include builds
104104
* Set various [environment variables](#environment-variables) to understand the capabilities of this image.
105105
* Map [persistent storage](#data-volumes) for access to configuration and data files for backup.
106106
* Make [networking ports](#networking) available for public access if necessary
107+
107108
### Persistent Storage
108109

109110
The following directories are used for configuration and can be mapped for persistent storage.
@@ -204,6 +205,22 @@ If `BACKUP_LOCATION` = `S3` then the following options are used.
204205
| _*OR*_ | | |
205206
| `S3_CERT_SKIP_VERIFY` | Skip verifying self signed certificates when connecting | `TRUE` |
206207

208+
#### Upload to a Azure storage account by `blobxfer`
209+
210+
Support to upload backup files with [blobxfer](https://github.com/Azure/blobxfer) to the Azure fileshare storage.
211+
212+
213+
If `BACKUP_LOCATION` = `blobxfer` then the following options are used.
214+
215+
| Parameter | Description | Default |
216+
| ------------------------------- | ------------------------------------------------------------------------ | -------------------- |
217+
| `BLOBXFER_STORAGE_ACCOUNT` | Microsoft Azure Cloud storage account name. | |
218+
| `BLOBXFER_STORAGE_ACCOUNT_KEY` | Microsoft Azure Cloud storage account key. | |
219+
| `BLOBXFER_REMOTE_PATH` | Remote Azure path | `/docker-db-backup` |
220+
221+
> This service uploads files from backup targed directory `DB_DUMP_TARGET`.
222+
> If the a cleanup configuration in `DB_CLEANUP_TIME` is defined, the remote directory on Azure storage will also be cleaned automatically.
223+
207224
## Maintenance
208225

209226
### Shell Access

0 commit comments

Comments
 (0)