From 3e8970e5cc7c6287db5bb46f0209fb072a21e283 Mon Sep 17 00:00:00 2001 From: ibizaman Date: Sat, 17 Dec 2022 15:43:42 -0800 Subject: [PATCH] add repo goal and status --- README.md | 32 ++++++++++++++++++++++++++++++-- 1 file changed, 30 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 51f3250..c8da427 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,30 @@ -# selfhostblocks -Building blocks for self-hosting with best practices +# Self Host Blocks + +*Building blocks for self-hosting with best practices.* + +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. + +As far as 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/) +- home dashboard with [Dashy](https://github.com/lissy93/dashy) + +Implementation is made with the disnix suite - +[Disnix](https://github.com/svanderburg/disnix), +[Dysnomia](https://github.com/svanderburg/dysnomia), +[NixOps](https://github.com/NixOS/nixops) - built on top of the nix +ecosystem. + +## Progress Status + +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.