jkaninda/mysql-bkup
1
1
Fork 0
mirror of https://github.com/jkaninda/mysql-bkup.git synced 2025-12-07 14:09:41 +01:00
Code Issues Actions Projects Releases Wiki Activity

docs: update deployment example

Browse Source
This commit is contained in:
Jonas Kaninda
2024-09-28 21:17:34 +02:00
parent f383f5559d
commit 2f06bd1c3a
3 changed files with 35 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/reference/index.md
View File

@@ -35,7 +35,7 @@ Backup, restore and migrate targets, schedule and retention are configured using
## Environment variables ## Environment variables
| Name | Requirement | Description | | Name | Requirement | Description |
|------------------------|--------------------------------------------------------------|------------------------------------------------------| |------------------------|-------------------------------------------------------------|------------------------------------------------------|
| DB_PORT | Optional, default 3306 | Database port number | | DB_PORT | Optional, default 3306 | Database port number |
| DB_HOST | Required | Database host | | DB_HOST | Required | Database host |
| DB_NAME | Optional if it was provided from the -d flag | Database name | | DB_NAME | Optional if it was provided from the -d flag | Database name |
@@ -63,6 +63,7 @@ Backup, restore and migrate targets, schedule and retention are configured using
| TARGET_DB_PASSWORD | Optional, required for database migration | Target database password | | TARGET_DB_PASSWORD | Optional, required for database migration | Target database password |
| TG_TOKEN | Optional, required for Telegram notification | Telegram token | | TG_TOKEN | Optional, required for Telegram notification | Telegram token |
| TG_CHAT_ID | Optional, required for Telegram notification | Telegram Chat ID | | TG_CHAT_ID | Optional, required for Telegram notification | Telegram Chat ID |
--- ---
## Run in Scheduled mode ## Run in Scheduled mode

3
examples/docker-compose.scheduled.local.yaml
View File

@@ -5,7 +5,7 @@ services:
# release version instead of using `latest`. # release version instead of using `latest`.
image: jkaninda/mysql-bkup image: jkaninda/mysql-bkup
container_name: mysql-bkup container_name: mysql-bkup
command: backup --dbname database_name --mode scheduled --period "0 1 * * *" command: backup --dbname database_name
volumes: volumes:
- ./backup:/backup - ./backup:/backup
environment: environment:
@@ -13,3 +13,4 @@ services:
- DB_HOST=mysql - DB_HOST=mysql
- DB_USERNAME=userName - DB_USERNAME=userName
- DB_PASSWORD=${DB_PASSWORD} - DB_PASSWORD=${DB_PASSWORD}
- BACKUP_CRON_EXPRESSION=0 1 * * * # Optional

3
examples/docker-compose.scheduled.s3.yaml
View File

@@ -6,7 +6,7 @@ services:
# for a list of available releases. # for a list of available releases.
image: jkaninda/mysql-bkup image: jkaninda/mysql-bkup
container_name: mysql-bkup container_name: mysql-bkup
command: backup --storage s3 -d my-database --mode scheduled --period "0 1 * * *" command: backup --storage s3 -d my-database
environment: environment:
- DB_PORT=3306 - DB_PORT=3306
- DB_HOST=mysql - DB_HOST=mysql
@@ -21,6 +21,7 @@ services:
- AWS_SECRET_KEY=xxxxx - AWS_SECRET_KEY=xxxxx
## In case you are using S3 alternative such as Minio and your Minio instance is not secured, you change it to true ## In case you are using S3 alternative such as Minio and your Minio instance is not secured, you change it to true
- AWS_DISABLE_SSL="false" - AWS_DISABLE_SSL="false"
- BACKUP_CRON_EXPRESSION=0 1 * * * # Optional
# mysql-bkup container must be connected to the same network with your database # mysql-bkup container must be connected to the same network with your database
networks: networks:
- web - web