jkaninda/mysql-bkup
1
1
Fork 0
mirror of https://github.com/jkaninda/mysql-bkup.git synced 2025-12-06 21:49:40 +01:00
Code Issues Actions Projects Releases Wiki Activity

docs: update docs

Browse Source
This commit is contained in:
Jonas Kaninda
2024-01-20 14:33:58 +01:00
parent 99ea4e18e5
commit c87201d08d
6 changed files with 19 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -83,20 +83,20 @@ FLUSH PRIVILEGES;
Simple backup usage Simple backup usage
```sh ```sh
bkup backup --dbname database_name mysql-bkup backup --dbname database_name
``` ```
```sh ```sh
bkup backup -d database_name mysql-bkup backup -d database_name
``` ```
### S3 ### S3
```sh ```sh
bkup backup --storage s3 --dbname database_name mysql-bkup backup --storage s3 --dbname database_name
``` ```
## Docker run: ## Docker run:
```sh ```sh
docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup:latest bkup backup -d database_name docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup:latest mysql-bkup backup -d database_name
``` ```
## Docker compose file: ## Docker compose file:
@@ -117,7 +117,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup -d database_name - mysql-bkup backup -d database_name
volumes: volumes:
- ./backup:/backup - ./backup:/backup
environment: environment:
@@ -131,22 +131,22 @@ services:
Simple database restore operation usage Simple database restore operation usage
```sh ```sh
bkup restore --dbname database_name --file database_20231217_115621.sql mysql-bkup restore --dbname database_name --file database_20231217_115621.sql
``` ```
```sh ```sh
bkup restore -f database_20231217_115621.sql mysql-bkup restore -f database_20231217_115621.sql
``` ```
### S3 ### S3
```sh ```sh
bkup restore --storage s3 --file database_20231217_115621.sql mysql-bkup restore --storage s3 --file database_20231217_115621.sql
``` ```
## Docker run: ## Docker run:
```sh ```sh
docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup bkup backup -d database_name -f db_20231219_022941.sql.gz docker run --rm --network your_network_name --name mysql-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/mysql-bkup mysql-bkup backup -d database_name -f db_20231219_022941.sql.gz
``` ```
## Docker compose file: ## Docker compose file:
@@ -168,7 +168,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup restore --file database_20231217_115621.sql --dbname database_name - mysql-bkup restore --file database_20231217_115621.sql --dbname database_name
volumes: volumes:
- ./backup:/backup - ./backup:/backup
environment: environment:
@@ -187,7 +187,7 @@ docker-compose up -d
## Backup to S3 ## Backup to S3
```sh ```sh
docker run --rm --privileged --device /dev/fuse --name mysql-bkup -e "DB_HOST=db_hostname" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" -e "ACCESS_KEY=your_access_key" -e "SECRET_KEY=your_secret_key" -e "BUCKETNAME=your_bucket_name" -e "S3_ENDPOINT=https://s3.us-west-2.amazonaws.com" jkaninda/mysql-bkup bkup backup -s s3 -d database_name docker run --rm --privileged --device /dev/fuse --name mysql-bkup -e "DB_HOST=db_hostname" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" -e "ACCESS_KEY=your_access_key" -e "SECRET_KEY=your_secret_key" -e "BUCKETNAME=your_bucket_name" -e "S3_ENDPOINT=https://s3.us-west-2.amazonaws.com" jkaninda/mysql-bkup mysql-bkup backup -s s3 -d database_name
``` ```
> To change s3 backup path add this flag : --path /myPath . default path is /mysql_bkup > To change s3 backup path add this flag : --path /myPath . default path is /mysql_bkup
@@ -275,7 +275,7 @@ Easy to remember format:
> Docker run : > Docker run :
```sh ```sh
docker run --rm --name mysql-bkup -v $BACKUP_DIR:/backup/ -e "DB_HOST=$DB_HOST" -e "DB_USERNAME=$DB_USERNAME" -e "DB_PASSWORD=$DB_PASSWORD" jkaninda/mysql-bkup bkup backup --dbname $DB_NAME --mode scheduled --period "0 1 * * *" docker run --rm --name mysql-bkup -v $BACKUP_DIR:/backup/ -e "DB_HOST=$DB_HOST" -e "DB_USERNAME=$DB_USERNAME" -e "DB_PASSWORD=$DB_PASSWORD" jkaninda/mysql-bkup mysql-bkup backup --dbname $DB_NAME --mode scheduled --period "0 1 * * *"
``` ```
> With Docker compose > With Docker compose
@@ -292,7 +292,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup --storage s3 --path /mys3_custome_path --dbname database_name --mode scheduled --period "*/30 * * * *" - mysql-bkup backup --storage s3 --path /mys3_custome_path --dbname database_name --mode scheduled --period "*/30 * * * *"
environment: environment:
- DB_PORT=3306 - DB_PORT=3306
- DB_HOST=mysqlhost - DB_HOST=mysqlhost
@@ -329,7 +329,7 @@ spec:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup -s s3 --path /custom_path - mysql-bkup backup -s s3 --path /custom_path
env: env:
- name: DB_PORT - name: DB_PORT
value: "3306" value: "3306"

2
examples/docker-compose.s3.yaml
View File

@@ -9,7 +9,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup --storage s3 --path /mys3_custom_path --dbname database_name - mysql-bkup backup --storage s3 --path /mys3_custom_path --dbname database_name
environment: environment:
- DB_PORT=3306 - DB_PORT=3306
- DB_HOST=mysqlhost - DB_HOST=mysqlhost

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

@@ -6,7 +6,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup --dbname database_name --mode scheduled --period "0 1 * * *" - mysql-bkup backup --dbname database_name --mode scheduled --period "0 1 * * *"
volumes: volumes:
- ./backup:/backup - ./backup:/backup
environment: environment:

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

@@ -9,7 +9,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup --storage s3 --path /mys3_custom_path --dbname database_name --mode scheduled --period "0 1 * * *" - mysql-bkup backup --storage s3 --path /mys3_custom_path --dbname database_name --mode scheduled --period "0 1 * * *"
environment: environment:
- DB_PORT=3306 - DB_PORT=3306
- DB_HOST=mysqlhost - DB_HOST=mysqlhost

2
examples/docker-compose.yaml
View File

@@ -6,7 +6,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup --dbname database_name - mysql-bkup backup --dbname database_name
volumes: volumes:
- ./backup:/backup - ./backup:/backup
environment: environment:

2
examples/k8s-job.yaml
View File

@@ -16,7 +16,7 @@ spec:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup --storage s3 --path /custom_path - mysql-bkup backup --storage s3 --path /custom_path
env: env:
- name: DB_PORT - name: DB_PORT
value: "3306" value: "3306"