Merge pull request #109 from rafsaf/release-4-0-update-docs

Update readme and docs index before release 4.0
rafsaf · Aug 27, 2023 · f9607cb · f9607cb
2 parents eac4d72 + bb56469
commit f9607cb
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,8 @@
 # Backuper
 
-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.
+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.
 
-| WARNING                                                                                                                                                                                                                                                    |
-| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| While this project aims to be a reliable backup tool and can help protect your hobby 5GB Postgres database from evaporation, it is **NOT** suitable for enterprise production systems with huge databases and application workloads. You have been warned. |
+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)
@@ -30,7 +28,7 @@ A tool for performing scheduled database backups and transferring encrypted data
 
 ## Deployment strategies
 
-Dockerhub: [https://hub.docker.com/r/rafsaf/backuper](https://hub.docker.com/r/rafsaf/backuper)
+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
@@ -63,6 +61,14 @@ services:
 
 (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:
+
+
+![](docs/images/backuper_gcp_example_twp-min.jpg)
 
 <br>
 <br>
diff --git a/docs/images/backuper_gcp_example_twp-min.jpg b/docs/images/backuper_gcp_example_twp-min.jpg
diff --git a/docs/index.md b/docs/index.md
@@ -1,10 +1,8 @@
 # Backuper
 
-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.
+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.
 
-| WARNING                                                                                                                                                                                                                                                    |
-| :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| While this project aims to be a reliable backup tool and can help protect your hobby 5GB Postgres database from evaporation, it is **NOT** suitable for enterprise production systems with huge databases and application workloads. You have been warned. |
+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)
@@ -30,7 +28,7 @@ A tool for performing scheduled database backups and transferring encrypted data
 
 ## Deployment strategies
 
-Dockerhub: [https://hub.docker.com/r/rafsaf/backuper](https://hub.docker.com/r/rafsaf/backuper)
+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
@@ -63,6 +61,14 @@ services:
 
 (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)
 
 <br>
 <br>
diff --git a/pyproject.toml b/pyproject.toml
@@ -3,7 +3,7 @@ authors = ["Rafał Safin <[email protected]>"]
 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 = "3.3"
+version = "4.0"
 
 [tool.poetry.dependencies]
 croniter = "^1.3.7"