From fdc88e6064b07b5684827ca1777813147abbebf2 Mon Sep 17 00:00:00 2001
From: Jonas Kaninda <me@jonaskaninda.com>
Date: Sun, 29 Sep 2024 07:00:55 +0200
Subject: [PATCH] docs: add docker recurring backup examples

---
 README.md                                    |  15 ++++++++++++++-
 docs/favicon.ico                             | Bin 0 -> 4286 bytes
 docs/index.md                                |  12 ++++++++++++
 examples/docker-compose.scheduled.local.yaml |   3 ++-
 examples/docker-compose.scheduled.s3.yaml    |   3 ++-
 5 files changed, 30 insertions(+), 3 deletions(-)
 create mode 100644 docs/favicon.ico

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 0000000000000000000000000000000000000000..6b94078dcb02e8f649c6089be509f4e268c17e70
GIT binary patch
literal 4286
zcmb_gS!|S582u3wUo>iBOz=U7#+8_uDBznI6E!Br7xhVFG#Xsc7g3Bc?lIsNM3A_F
zC}5$qfXLF8ZnU=0jV^R=rz`DDJJadRKTBslo^z+u4%FHOOHTjWyL{){?sxCSvX=1Q
ziWQcATUpmx){T~B-AS;^T1%+k{BW%GniNtUbN}}H{T6X0aVPOQkxjG_J|aE|wcCk<
zgyv|j*33;X%M7h0mJ+Lp?};8FMqmzTj^=8O)=I`KEHk?`cM{9^-9)&Exj1JVAK}`~
zgk%}HGa09Q(sTH|pC~1g#B8$X+b<cCwThTkhx8b~YYD}7zVhcgPckKYh7RdIex>6@
z+&1+H+9{~b@ymf^&+r5Lq?2M)LQKgQU%$u3=7tIU)Eb7%Yhy7w*meN6ZKvfb7B>+l
z@cI&05Ss$zldWtUgxDS&v$3-+j7Lw!@Lo*><G$%}BR3$~1i$HZ;<5ul)9+_{psNXe
zoeh)of(Qgdn*dx9jU`MhxNc3r_B$&EgV@^<f|nd4UO#@O&9%b;#Djk9q7FA4OyWdO
z(CFwJ_rlRqg{u7DaOU_g=%_!9arTMZIoN~x(j1&Q@eBU`a|e$7{4QFm^D*4tg}Tyg
zt#O^$_5K4zS(`2Ec`R*k26jmI7s{i!IX8h8mko#8#vOkqu#-AO1AcsZZUR^DPvY6K
zD8_s?+#^G%ByY{By{O9Djhrp(aQ@73j12V|zP#NZqNZ>kj{UR|<bu~TiniJ!WPS0R
z(W&w8BRk{+YY$fb&=T$y-#vdNaD8?Xzqg0bIcnoJ@@I91$mho+^uM^*oQR`xFo1yH
z2cOSp{45{m|MoHRfBzVD#ru)F^;P48Kq!n0J*`H!j`~ux*A?UNw)JqkE+`fb+I+XQ
z7jM$GcurRcD~~3yt|Ee$iF5S(Ek_c@-_;k`KAgbe?hqa?jA0Y=QMn;sk9)_AZ})%s
zys@kJz*i{P`<c;AKJ|`yj6cqv+=VvsA0q##a{$y?b#nc+*~y#@)e*c_8Nt&fQIrh?
z@o+&5(&tw4SJ2jP8pF8vSONpw3vYAolf^N3{Wjy-3C0lF-@JtK!`m@3+>cZHK8JJ=
zx1c=9+x-E`k8C&o&*0bi!N&??ZBLQ+zT<IhZw{N>d!{ss*Qw9#^ncY*08bRf@JdA#
zVdjDM!adZbW5|sH`dhK>>!_!_<0ijP=YEU)J)fAr{nXJr=4KAO!(7~Xsr}+_f2%6u
zyD2w`+h}VYeLg{sElpu8r@vP+A6l7<M;$>hM@`;$F)wnu!*KNXBKO;MXstPgU?^g2
z)jn*lI%(oR)YqYXhW^e*WPkl4xr<EvFR|ahtvMWDvJb|m9_E?$e+_NEF(-*t%(Y?e
zf5lq0LH<<z(cg-DY0ehLcB9Gviobp|@fdTDpm_h6IKJ~esPE_x8%#{p-&R|g8Gp%(
zH#r0Gt>?oi>1Vx|<nWC9v4?x$0CQipK)f@+-1CeM8~f{u4;b6Tp`7%LI!%9VQ5L@i
z+^fSTHqJo@+Rv4koK$R>gK={DjeWE!lOtX8Gy7(?C+nPQ9WgzAaldpjWBjJ-WGXKh
zE79xTlCk#xYLkokpxPk&$K0+dj#Q0wXrFYDTX&|ZvHz!?ih=fp_M~dF*W;e%kUv<v
z+^!+r<<=APxmQiEpNGDRbJ?Nqpd4@xbep^|wvpS#8eLzO8>=qZ^9K9wCR7U-B>%tW
ztJb$v<)iuRNplWO#ouuFP+Ry1TB{2jJS*;^9G$)9{P{1L3mF?DKjky#BL*hd$t^up
z7sSu~yItoG<?0MxLtM^1^CI7=7OF0JMwxSp^^|XIG?X9Fx$O)`VyiipKL4eM?x`7b
z7vEORZK^y55A%N7_5cQX7M{)f6&|<C+&{>dc?Z&+NOz;l(m{K!ul*dl&sV1Q-=yDF
zlXOq$YN{xSCb5k3rY_#nV-k8VTy+0jj6Tg(d2n9n!BB6zv1Qabn98}Df;OHBtGr&1
zmB}wfGIV%|?M2lj<ySxNd8WoP2m8Ak(cOFo+-K-)C~ITwTie&sXhjp4vOTkrp@Z(o
zr-=o<KXle}U!$|J9CalJ&`@?rx+GcmOGDwv{e!&@E1vv!?zA2mIw&8MlX^qVJ12Tt
zYq<CGFvPnFpQtX~bwd-eWx>#d6^SL&G;@9@_0Zc<dsFqHhnTxg@?OQ*ItaZ#<;MlR
zKQC2`>y;aNORH9?R_nY_e&{Db=nby-xAIo?d_nJTe6$4g%7<~wdT_$BmXBN3wY`>g
fRf%OS{fPf{AXtn1Nv|)VtX|5LY;lN7oZ|im=HJ;>

literal 0
HcmV?d00001

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