diff --git a/README.md b/README.md index 24fbdf5..6272f01 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,19 @@ services: networks: web: ``` + +### Docker recurring backup + +```shell + docker run --rm --network network_name \ + -v $PWD/backup:/backup/ \ + -e "DB_HOST=hostname" \ + -e "DB_USERNAME=user" \ + -e "DB_PASSWORD=password" \ + jkaninda/mysql-bkup backup -d dbName --cron-expression "@every 1m" +``` +See: https://jkaninda.github.io/mysql-bkup/reference/#predefined-schedules + ## Deploy on Kubernetes For Kubernetes, you don't need to run it in scheduled mode. You can deploy it as Job or CronJob. @@ -102,7 +115,7 @@ spec: template: spec: containers: - - name: pg-bkup + - name: mysql-bkup # In production, it is advised to lock your image tag to a proper # release version instead of using `latest`. # Check https://github.com/jkaninda/mysql-bkup/releases diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000..6b94078 Binary files /dev/null and b/docs/favicon.ico differ diff --git a/docs/index.md b/docs/index.md index 7760b27..bc6e945 100644 --- a/docs/index.md +++ b/docs/index.md @@ -79,6 +79,18 @@ services: networks: web: ``` +### Docker recurring backup + +```shell + docker run --rm --network network_name \ + -v $PWD/backup:/backup/ \ + -e "DB_HOST=hostname" \ + -e "DB_USERNAME=user" \ + -e "DB_PASSWORD=password" \ + jkaninda/mysql-bkup backup -d dbName --cron-expression "@every 1m" +``` +See: https://jkaninda.github.io/mysql-bkup/reference/#predefined-schedules + ## Kubernetes ```yaml diff --git a/examples/docker-compose.scheduled.local.yaml b/examples/docker-compose.scheduled.local.yaml index 8e69f64..a7f6b42 100644 --- a/examples/docker-compose.scheduled.local.yaml +++ b/examples/docker-compose.scheduled.local.yaml @@ -13,4 +13,5 @@ services: - DB_HOST=mysql - DB_USERNAME=userName - DB_PASSWORD=${DB_PASSWORD} - - BACKUP_CRON_EXPRESSION=0 1 * * * # Optional + # See: https://jkaninda.github.io/mysql-bkup/reference/#predefined-schedules + - BACKUP_CRON_EXPRESSION=@daily #@every 5m|@weekly | @monthly |0 1 * * * \ No newline at end of file diff --git a/examples/docker-compose.scheduled.s3.yaml b/examples/docker-compose.scheduled.s3.yaml index 8ce3b1b..d9d2449 100644 --- a/examples/docker-compose.scheduled.s3.yaml +++ b/examples/docker-compose.scheduled.s3.yaml @@ -21,7 +21,8 @@ services: - 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 - AWS_DISABLE_SSL="false" - - BACKUP_CRON_EXPRESSION=0 1 * * * # Optional + # See: https://jkaninda.github.io/mysql-bkup/reference/#predefined-schedules + - BACKUP_CRON_EXPRESSION=@daily #@every 5m|@weekly | @monthly |0 1 * * * # mysql-bkup container must be connected to the same network with your database networks: - web