jkaninda/pg-bkup
1
0
Fork 0
Code Issues Pull Requests Actions Projects Releases Wiki Activity

docs: update docs

Browse Source
This commit is contained in:
Jonas Kaninda
2024-01-20 14:37:21 +01:00
parent 9ed0a1dd41
commit db3c3873c3
6 changed files with 20 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@@ -61,20 +61,20 @@ Creating a user for backup tasks who has read-only access is recommended!
Simple backup usage Simple backup usage
```sh ```sh
bkup --operation backup pg-bkup --operation backup
``` ```
```sh ```sh
bkup -o backup pg-bkup -o backup
``` ```
### S3 ### S3
```sh ```sh
bkup backup --storage s3 pg-bkup backup --storage s3
``` ```
## Docker run: ## Docker run:
```sh ```sh
docker run --rm --network your_network_name --name pg-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/pg-bkup bkup backup -d database_name docker run --rm --network your_network_name --name pg-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/pg-bkup pg-bkup backup -d database_name
``` ```
## Docker compose file: ## Docker compose file:
@@ -99,7 +99,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup -d bkup - pg-bkup backup -d bkup
volumes: volumes:
- ./backup:/backup - ./backup:/backup
environment: environment:
@@ -114,22 +114,22 @@ services:
Simple database restore operation usage Simple database restore operation usage
```sh ```sh
bkup restore --file database_20231217_115621.sql --dbname database_name pg-bkup restore --file database_20231217_115621.sql --dbname database_name
``` ```
```sh ```sh
bkup restore -f database_20231217_115621.sql -d database_name pg-bkup restore -f database_20231217_115621.sql -d database_name
``` ```
### S3 ### S3
```sh ```sh
bkup restore --storage s3 --file database_20231217_115621.sql --dbname database_name pg-bkup restore --storage s3 --file database_20231217_115621.sql --dbname database_name
``` ```
## Docker run: ## Docker run:
```sh ```sh
docker run --rm --network your_network_name --name pg-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/pg-bkup bkup restore -d database_name -f napata_20231219_022941.sql.gz docker run --rm --network your_network_name --name pg-bkup -v $PWD/backup:/backup/ -e "DB_HOST=database_host_name" -e "DB_USERNAME=username" -e "DB_PASSWORD=password" jkaninda/pg-bkup pg-bkup restore -d database_name -f napata_20231219_022941.sql.gz
``` ```
## Docker compose file: ## Docker compose file:
@@ -143,7 +143,7 @@ services:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup restore --file database_20231217_115621.sql -d database_name - pg-bkup restore --file database_20231217_115621.sql -d database_name
volumes: volumes:
- ./backup:/backup - ./backup:/backup
environment: environment:
@@ -161,14 +161,14 @@ docker-compose up -d
## Backup to S3 ## Backup to S3
```sh ```sh
docker run --rm --privileged --device /dev/fuse --name pg-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/pg-bkup bkup backup -s s3 -d database_name docker run --rm --privileged --device /dev/fuse --name pg-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/pg-bkup pg-bkup backup -s s3 -d database_name
``` ```
> To change s3 backup path add this flag : --path /mycustomPath . default path is /pg-bkup > To change s3 backup path add this flag : --path /mycustomPath . default path is /pg-bkup
Simple S3 backup usage Simple S3 backup usage
```sh ```sh
bkup backup --storage s3 --dbname mydatabase pg-bkup backup --storage s3 --dbname mydatabase
``` ```
```yaml ```yaml
pg-bkup: pg-bkup:
@@ -247,7 +247,7 @@ Easy to remember format:
> Docker run : > Docker run :
```sh ```sh
docker run --rm --name pg-bkup -v $BACKUP_DIR:/backup/ -e "DB_HOST=$DB_HOST" -e "DB_USERNAME=$DB_USERNAME" -e "DB_PASSWORD=$DB_PASSWORD" jkaninda/pg-bkup bkup backup --dbname $DB_NAME --mode scheduled --period "0 1 * * *" docker run --rm --name pg-bkup -v $BACKUP_DIR:/backup/ -e "DB_HOST=$DB_HOST" -e "DB_USERNAME=$DB_USERNAME" -e "DB_PASSWORD=$DB_PASSWORD" jkaninda/pg-bkup pg-bkup backup --dbname $DB_NAME --mode scheduled --period "0 1 * * *"
``` ```
> With Docker compose > With Docker compose
@@ -264,7 +264,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 * * * *" - pg-bkup backup --storage s3 --path /mys3_custome_path --dbname database_name --mode scheduled --period "*/30 * * * *"
environment: environment:
- DB_PORT=5432 - DB_PORT=5432
- DB_HOST=postgreshost - DB_HOST=postgreshost
@@ -301,7 +301,7 @@ spec:
command: command:
- /bin/sh - /bin/sh
- -c - -c
- bkup backup -s s3 --path /custom_path - pg-bkup backup -s s3 --path /custom_path
env: env:
- name: DB_PORT - name: DB_PORT
value: "5432" value: "5432"

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 - pg-bkup backup --storage s3 --path /mys3_custom_path --dbname database_name
environment: environment:
- DB_PORT=5432 - DB_PORT=5432
- DB_HOST=postgress - DB_HOST=postgress

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 * * *" - pg-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 * * *" - pg-bkup backup --storage s3 --path /mys3_custom_path --dbname database_name --mode scheduled --period "0 1 * * *"
environment: environment:
- DB_PORT=5432 - DB_PORT=5432
- DB_HOST=postgress - DB_HOST=postgress

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 - pg-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 - pg-bkup backup --storage s3 --path /custom_path
env: env:
- name: DB_PORT - name: DB_PORT
value: "5432" value: "5432"