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

Merge pull request #164 from jkaninda/nightly
Some checks failed
Deploy Documenation site to GitHub Pages / build (push) Failing after 9m27s
Details
Deploy Documenation site to GitHub Pages / deploy (push) Has been skipped
Details

Browse Source 
doc: reviewed docs
This commit is contained in:
Jonas Kaninda
2025-01-13 15:34:50 +01:00
committed by GitHub
parent b7b09ad6fd 3a1bfc512d
commit e5ba397bb4
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/how-tos/backup.md
View File

@@ -30,12 +30,12 @@ Below is an example `docker-compose.yml` configuration for backing up a database
```yaml ```yaml
services: services:
pg-bkup: mysql-bkup:
# In production, lock your image tag to a specific release version # In production, lock your image tag to a specific release version
# instead of using `latest`. Check https://github.com/jkaninda/pg-bkup/releases # instead of using `latest`. Check https://github.com/jkaninda/mysql-bkup/releases
# for available releases. # for available releases.
image: jkaninda/pg-bkup image: jkaninda/mysql-bkup
container_name: pg-bkup container_name: mysql-bkup
command: backup -d database command: backup -d database
volumes: volumes:
- ./backup:/backup - ./backup:/backup
@@ -46,7 +46,7 @@ services:
- DB_USERNAME=username - DB_USERNAME=username
- DB_PASSWORD=password - DB_PASSWORD=password
# Ensure the pg-bkup container is connected to the same network as your database # Ensure the mysql-bkup container is connected to the same network as your database
networks: networks:
- web - web
@@ -73,7 +73,7 @@ docker run --rm --network your_network_name \
## Recurring Backups ## Recurring Backups
To schedule recurring backups, use the `--cron-expression` flag or the `BACKUP_CRON_EXPRESSION` environment variable. This allows you to define a cron schedule for automated backups. To schedule recurring backups, use the `--cron-expression (-e)` flag or the `BACKUP_CRON_EXPRESSION` environment variable. This allows you to define a cron schedule for automated backups.
### Example: Recurring Backup Configuration ### Example: Recurring Backup Configuration
@@ -111,7 +111,7 @@ networks:
## Key Notes ## Key Notes
- **Cron Expression**: Use the `--cron-expression` flag or `BACKUP_CRON_EXPRESSION` environment variable to define the backup schedule. For example: - **Cron Expression**: Use the `--cron-expression (-e)` flag or `BACKUP_CRON_EXPRESSION` environment variable to define the backup schedule. For example:
- `@midnight`: Runs the backup daily at midnight. - `@midnight`: Runs the backup daily at midnight.
- `0 1 * * *`: Runs the backup daily at 1:00 AM. - `0 1 * * *`: Runs the backup daily at 1:00 AM.
- **Backup Retention**: Optionally, use the `BACKUP_RETENTION_DAYS` environment variable to automatically delete backups older than a specified number of days. - **Backup Retention**: Optionally, use the `BACKUP_RETENTION_DAYS` environment variable to automatically delete backups older than a specified number of days.