From 902ec30d2dc28895a209058bc8bb0129cffbf45b Mon Sep 17 00:00:00 2001 From: ibizaman Date: Sun, 19 Feb 2023 20:50:39 -0800 Subject: [PATCH] reformat a bit the readme --- README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7bc0250..dc1e1e1 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,25 @@ # Self Host Blocks -*Building blocks for self-hosting with best practices.* +*Building blocks for self-hosting with battery included.* SHB's (Self Host Blocks) goal is to provide a lower entry-bar for self-hosting. I intend to achieve this by providing building blocks promoting best practices to self-host a wide range of services. Also, -the design will be extendable to allow user defined services. +the design will be extendable to allow users to add services not +provided by SHB. As far as features and best practices go, I intend to provide, for all services: -- protection and single sign-on using [Keycloak](https://www.keycloak.org/), where possible -- automated backing up of data and databases with [Borgmatic](https://torsion.org/borgmatic/) -- encrypted external backup with [Rclone](https://rclone.org/) -- central logging, monitoring and dashboards with [Prometheus](prometheus.io/) and [Grafana](https://grafana.com/) -- integration with external services that are hard to self-host, like email sending -- deployment of services on the same or different machines -- home dashboard with [Dashy](https://github.com/lissy93/dashy) -- vault to store passwords and api keys using [Password Store](https://www.passwordstore.org/), those shouldn't be stored in config or on disk -- test changes using local virtual machines to avoid botching prod -- automated CI tests +- Protection and single sign-on using [Keycloak](https://www.keycloak.org/), where sensible. +- Automated backup of data and databases with [Borgmatic](https://torsion.org/borgmatic/). +- Encrypted external backup with [Rclone](https://rclone.org/). +- Central logging, monitoring and dashboards with [Prometheus](prometheus.io/) and [Grafana](https://grafana.com/). +- Integration with external services that are hard to self-host, like email sending. +- Deployment of every services on the same or different machines. +- Home dashboard with [Dashy](https://github.com/lissy93/dashy). +- Vault to store passwords and api keys using [Password Store](https://www.passwordstore.org/), those shouldn't be stored in config or on disk. +- Test changes using local virtual machines to avoid botching prod. +- Automated CI tests that can be run locally using virtual machines. Implementation is made with the disnix suite - [Disnix](https://github.com/svanderburg/disnix), @@ -32,5 +33,5 @@ Currently, this repo is WIP and the first two services I intend to provide are [Tiny Tiny RSS](https://tt-rss.org/) and [Vaultwarden](https://github.com/dani-garcia/vaultwarden). Vaultwarden was chosen as it's IMO the first stepping stone to enable -self-hosting. Tiny Tiny RSS was chosen because it requires quite a lot -of moving parts and also will allow me to test single sign-on. +self-hosting. Tiny Tiny RSS was chosen because it is somewhat +lightweight.