audrey/mysql-backup-agent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update readme.md
All checks were successful
Build Container Image & push to Packages / Build package (push) Successful in 38s
Details

Browse Source 
add tips for use
This commit is contained in:
audrey 2025-04-07 20:24:24 +00:00
parent a32151f89f
commit 566f2b9780
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
readme.md
View File

@ -23,6 +23,8 @@ The service needs to have network access to the target server on a network that
## Install ## Install
It's recommended to set up this container by adding it to the target service's docker compose. It's recommended to set up this container by adding it to the target service's docker compose.
> [!NOTE]
> Only 1 MySQL container can be targeted by `MYSQL_HOST`. You will need a dedicated backup sidecar for each unclustered MySQL instance you want backed up.
### Examples ### Examples
#### Simple Setup #### Simple Setup
``` yaml ``` yaml
@ -60,8 +62,8 @@ networks:
#### Backup to NAS #### Backup to NAS
For increased data security, it's recommended to store database backups on the NAS where they can take advantage of increased storage, automatic snapshots, & further backups. For increased data security, it's recommended to store database backups on the NAS where they can take advantage of increased storage, automatic snapshots, & further backups.
The below example is identical to the one above, except `APPEND_DATE` has been set to `false` & the volume definition for `backup` has been modified. The below example is identical to the one above, except `APPEND_DATE` has been set to `false` & the volume definition for `backup` has been modified.
> [!IMPORTANT] > [!TIP]
> If you intend to keep regular snapshots of this backup on the file server, you should set APPEND_DATE to false > If you intend to keep regular snapshots of this backup on the file server, you should set `APPEND_DATE` to false
``` yaml ``` yaml
version: "3" version: "3"
services: services: