Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/brpaz/b2-pg-backup
Docker image for backing up Postgres databases using PG Dump and Backblaze
https://github.com/brpaz/b2-pg-backup
Last synced: 9 days ago
JSON representation
Docker image for backing up Postgres databases using PG Dump and Backblaze
- Host: GitHub
- URL: https://github.com/brpaz/b2-pg-backup
- Owner: brpaz
- License: mit
- Created: 2022-01-23T16:04:32.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-23T16:34:58.000Z (almost 3 years ago)
- Last Synced: 2024-08-13T07:15:51.523Z (4 months ago)
- Language: Shell
- Size: 13.7 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - brpaz/b2-pg-backup - Docker image for backing up Postgres databases using PG Dump and Backblaze (Shell)
README
# b2-pg-backup
> Docker image for backing up Postgres databases using [PG Dump](https://www.postgresql.org/docs/current/app-pgdump.html) and [Backblaze](https://www.b2.com/b2/cloud-storage.html)
## Requirements
* A [Backblaze](https://www.backblaze.com) account.
* A B2 Bucket to store your backup files - Create a new one [here](https://secure.b2.com/b2_buckets.htm).
* An [Application Key](https://secure.b2.com/app_keys.htm) with write access to the previous created backup. This is required to authenticate in your B2 account to upload files.
## Usage
This docker image contains [b2](https://www.b2.com/b2/docs/quick_command_line.html) command line tool as well as postgres client with **pg_dump** tool.
To backup your Postgres Database you can run the following command:
```sh
docker run \
-e PG_HOST= \
-e PG_USER= \
-e PG_PASSWORD= \
-e PG_DUMP_DBS="space separated list of databases to backup" \
-e B2_APPLICATION_KEY_ID= \
-e B2_APPLICATION_KEY= \
-e B2_BUCKET= \
b2-pg-backup
```
The following envrionment variables are available:
| Name | Description | Required |
|----------------------- |-------------------------------------------------------------------------------------------------------- |---------- |
| PG_HOST | The hostname or IP Address of the Postgres instance to bucket.
Must be acessible by the container. | Yes |
| PG_USER | The Postgres user to authenticate | Yes |
| PG_PASSWORD | The Postgres user password | Yes |
| PG_PORT | Postgres Database Port. Defaults to 5432 if not set | No |
| PG_DUMP_DBS | A space separated string with the list of database names to backup. | Yes |
| PG_DUMP_ARGS | Optional List of extra args to pass to the "pg_dump" command. Ex: ("--inserts --no-owner" | No |
| B2_BUCKET | The backbalze Bucket name. Can contain a subfolder.
Ex: my-bucket/subfolder | Yes |
| B2_APPLICATION_KEY_ID | Backblaze Application Key ID credential | Yes |
| B2_APPLICATION_KEY | Backblaze Application Key credential | Yes |
## FAQ
### How to run backups on a schedule?
- This tool doens´t assume how and when do you want to run your backups. If you want to run it on a schedule, you can run the regular tools for running scheduled tasks like Cron or Kubernetes Jobs.
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
### Developing
It is recommended to install `direnv` and `lefthook` to a better development process.
* [direnv](https://direnv.net/)
* [lefthook](https://github.com/evilmartians/lefthook)
```
make setup-env
```
This will install the Git Hooks and create an `.env` file from the `.env.example` template. You will need to add your backblaze keys there.
You can start a test Postgres container as well an application container using: `make dev`.
All the core logic is placed on `backup.sh` script at the root of this repository. This file is mounted as a volume on the docker container, so you can easily change it and see your changes.
## 💛 Support the project
If this project was useful to you in some form, I would be glad to have your support. It will help to keep the project alive and to have more time to work on Open Source.
The sinplest form of support is to give a ⭐️ to this repo.
You can also contribute with [GitHub Sponsors](https://github.com/sponsors/brpaz).
[](https://github.com/sponsors/brpaz)
Or if you prefer a one time donation to the project, you can simple:
## Author
👤 **Bruno Paz**
* Website: [brunopaz.dev](https://brunopaz.net)
* Github: [@brpaz](https://github.com/brpaz)
## 📝 License
Copyright © 2021 [Bruno Paz](https://github.com/brpaz).
This project is [MIT](https://opensource.org/licenses/MIT) licensed.