From 99eee578ca809c51e7f0a917777e7f7b9eac0956 Mon Sep 17 00:00:00 2001 From: rafsaf Date: Thu, 28 Sep 2023 19:43:01 +0200 Subject: [PATCH] add useful badges to readme, use include in docs index.md --- README.md | 22 +++++++++++++++ docs/index.md | 77 +------------------------------------------------- mkdocs.yml | 1 + pyproject.toml | 2 +- 4 files changed, 25 insertions(+), 77 deletions(-) diff --git a/README.md b/README.md index be0389f..df8f58c 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,25 @@ + + License + + + Python + + + Black + + + Tests + + + Type check + + + Dev build + + + Release build + + # Backuper A tool for performing scheduled database backups and transferring encrypted data to secure public clouds, for home labs, hobby projects, etc., in environments such as k8s, docker, vms. diff --git a/docs/index.md b/docs/index.md index d645bd9..a5c98dd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,76 +1 @@ -# Backuper - -A tool for performing scheduled database backups and transferring encrypted data to secure public clouds, for home labs, hobby projects, etc., in environments such as k8s, docker, vms. - -Backups are in `zip` format using [7-zip](https://www.7-zip.org/), with strong AES-256 encryption under the hood. - -## Documentation -- [https://backuper.rafsaf.pl](https://backuper.rafsaf.pl) - -## Supported backup targets - -- PostgreSQL (tested on 15, 14, 13, 12, 11) -- MySQL (tested on 8.0, 5.7) -- MariaDB (tested on 10.11, 10.6, 10.5, 10.4) -- Single file -- Directory - -## Supported upload providers - -- Google Cloud Storage bucket -- AWS S3 bucket -- Azure Blob Storage -- Debug (local) - -## Notifications - -- Discord -- Email (SMTP) -- Slack - -## Deployment strategies - -Using docker image: `rafsaf/backuper:latest`, see all tags on [dockerhub](https://hub.docker.com/r/rafsaf/backuper/tags) - -- docker (docker compose) container -- kubernetes deployment - -## Architectures - -- linux/amd64 -- linux/arm64 - -## Example - -Everyday 5am backup to Google Cloud Storage of PostgreSQL database defined in the same file and running in docker container. - -```yml -# docker-compose.yml - -services: - db: - image: postgres:15 - environment: - - POSTGRES_PASSWORD=pwd - backuper: - image: rafsaf/backuper:latest - environment: - - POSTGRESQL_PG15=host=db password=pwd cron_rule=0 0 5 * * port=5432 - - ZIP_ARCHIVE_PASSWORD=change_me - - BACKUP_PROVIDER=name=debug - -``` - -(NOTE this will use provider [debug](https://backuper.rafsaf.pl/providers/debug/) that store backups locally in the container). - -## Real world usage - -The author actively uses backuper (with GCS) for one production project [plemiona-planer.pl](https://plemiona-planer.pl) postgres database (both PRD and STG) and for bunch of homelab projects including self hosted Firefly III mariadb, Grafana postgres, KeyCloak postgres, Nextcloud postgres and configuration file, Minecraft server files, and two other postgres dbs for some demo projects. - -See how it looks for ~2GB size database: - - -![](./images/backuper_gcp_example_twp-min.jpg) - -
-
\ No newline at end of file +{!./../README.md!} \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 8bdd018..3ab73ef 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -54,6 +54,7 @@ plugins: watch: - docs - mkdocs.yml + - README.md extra: version: diff --git a/pyproject.toml b/pyproject.toml index ee34a2d..36ec55c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,7 +3,7 @@ authors = ["Rafał Safin "] description = "A tool for performing scheduled database backups and transferring encrypted data to secure clouds, for home labs, hobby projects, etc., in environments such as k8s, docker, vms." license = "GNU GPLv3" name = "backuper" -version = "5.0" +version = "5.1" [tool.poetry.dependencies] croniter = "^1.3.7"