From 9f25a20a2865b4beacafb894243a0aaf6c566c03 Mon Sep 17 00:00:00 2001 From: Jonas Kaninda Date: Fri, 6 Dec 2024 03:11:49 +0100 Subject: [PATCH] docs: update core features --- README.md | 44 +++++++++++++++++++++++++++++++++----------- docs/index.md | 42 +++++++++++++++++++++++++++++++----------- 2 files changed, 64 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index bb701d9..490690b 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,7 @@ -# PostgreSQL Backup -PostgreSQL Backup is a Docker container image that can be used to backup, restore and migrate Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, FTP and SSH compatible storage. -It also supports __encrypting__ your backups using GPG. - -The [jkaninda/pg-bkup](https://hub.docker.com/r/jkaninda/pg-bkup) Docker image can be deployed on Docker, Docker Swarm and Kubernetes. -It handles __recurring__ backups of postgres database on Docker and can be deployed as __Job or CronJob on Kubernetes__ using local, AWS S3 or SSH compatible storage. - -It also supports __encrypting__ your backups using GPG. - -Telegram and Email notifications on successful and failed backups. +# PG-BKUP +**PG-BKUP** is a Docker container image designed to **backup, restore, and migrate PostgreSQL databases**. +It supports a variety of storage options and ensures data security through GPG encryption. [![Build](https://github.com/jkaninda/pg-bkup/actions/workflows/release.yml/badge.svg)](https://github.com/jkaninda/pg-bkup/actions/workflows/release.yml) [![Go Report](https://goreportcard.com/badge/github.com/jkaninda/mysql-bkup)](https://goreportcard.com/report/github.com/jkaninda/pg-bkup) @@ -16,6 +9,35 @@ Telegram and Email notifications on successful and failed backups. ![Docker Pulls](https://img.shields.io/docker/pulls/jkaninda/pg-bkup?style=flat-square) buy ma a coffee +## Features + +- **Storage Options:** + - Local storage + - AWS S3 or any S3-compatible object storage + - FTP + - SSH-compatible storage + +- **Data Security:** + - Backups can be encrypted using **GPG** to ensure confidentiality. + +- **Deployment Flexibility:** + - Available as the [jkaninda/pg-bkup](https://hub.docker.com/r/jkaninda/pg-bkup) Docker image. + - Deployable on **Docker**, **Docker Swarm**, and **Kubernetes**. + - Supports recurring backups of PostgreSQL databases when deployed: + - On Docker for automated backup schedules. + - As a **Job** or **CronJob** on Kubernetes. + +- **Notifications:** + - Get real-time updates on backup success or failure via: + - **Telegram** + - **Email** + +## Use Cases + +- **Automated Recurring Backups:** Schedule regular backups for PostgreSQL databases. +- **Cross-Environment Migration:** Easily migrate your PostgreSQL databases across different environments using supported storage options. +- **Secure Backup Management:** Protect your data with GPG encryption. + Successfully tested on: - Docker @@ -88,7 +110,7 @@ services: - TZ=Europe/Paris # pg-bkup container must be connected to the same network with your database networks: - - web + - web networks: web: ``` diff --git a/docs/index.md b/docs/index.md index f6a4665..9a2e11c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,13 +4,40 @@ layout: home nav_order: 1 --- -# About pg-bkup +# About PG-BKUP {:.no_toc} -PostreSQL Backup is a Docker container image that can be used to backup, restore and migrate Postgres database. It supports local storage, AWS S3 or any S3 Alternatives for Object Storage, ftp and SSH compatible storage. -It also supports database __encryption__ using GPG. -Telegram and Email notifications on successful and failed backups. +**PG-BKUP** is a Docker container image designed to **backup, restore, and migrate PostgreSQL databases**. +It supports a variety of storage options and ensures data security through GPG encryption. +## Features + +- **Storage Options:** + - Local storage + - AWS S3 or any S3-compatible object storage + - FTP + - SSH-compatible storage + +- **Data Security:** + - Backups can be encrypted using **GPG** to ensure confidentiality. + +- **Deployment Flexibility:** + - Available as the [jkaninda/pg-bkup](https://hub.docker.com/r/jkaninda/pg-bkup) Docker image. + - Deployable on **Docker**, **Docker Swarm**, and **Kubernetes**. + - Supports recurring backups of PostgreSQL databases when deployed: + - On Docker for automated backup schedules. + - As a **Job** or **CronJob** on Kubernetes. + +- **Notifications:** + - Get real-time updates on backup success or failure via: + - **Telegram** + - **Email** + +## Use Cases + +- **Automated Recurring Backups:** Schedule regular backups for PostgreSQL databases. +- **Cross-Environment Migration:** Easily migrate your PostgreSQL databases across different environments using supported storage options. +- **Secure Backup Management:** Protect your data with GPG encryption. We are open to receiving stars, PRs, and issues! @@ -20,13 +47,6 @@ We are open to receiving stars, PRs, and issues! --- -The [jkaninda/pg-bkup](https://hub.docker.com/r/jkaninda/pg-bkup) Docker image can be deployed on Docker, Docker Swarm and Kubernetes. -It handles __recurring__ backups of postgres database on Docker and can be deployed as __CronJob on Kubernetes__ using local, AWS S3 or SSH compatible storage. - -It also supports database __encryption__ using GPG. - - - {: .note } Code and documentation for `v1` version on [this branch][v1-branch].