hosting/selfhostblocks
1
0
Fork 0
Code Issues Activity

reformat a bit the readme

Browse source
This commit is contained in:
ibizaman 2023-02-19 20:50:39 -08:00
parent d90baececc
commit 902ec30d2d
1 changed files with 15 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

29
README.md
View file

@ -1,24 +1,25 @@
# Self Host Blocks # 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 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 self-hosting. I intend to achieve this by providing building blocks
promoting best practices to self-host a wide range of services. Also, 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 As far as features and best practices go, I intend to provide, for all
services: services:
- protection and single sign-on using [Keycloak](https://www.keycloak.org/), where possible - Protection and single sign-on using [Keycloak](https://www.keycloak.org/), where sensible.
- automated backing up of data and databases with [Borgmatic](https://torsion.org/borgmatic/) - Automated backup of data and databases with [Borgmatic](https://torsion.org/borgmatic/).
- encrypted external backup with [Rclone](https://rclone.org/) - Encrypted external backup with [Rclone](https://rclone.org/).
- central logging, monitoring and dashboards with [Prometheus](prometheus.io/) and [Grafana](https://grafana.com/) - 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 - Integration with external services that are hard to self-host, like email sending.
- deployment of services on the same or different machines - Deployment of every services on the same or different machines.
- home dashboard with [Dashy](https://github.com/lissy93/dashy) - 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 - 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 - Test changes using local virtual machines to avoid botching prod.
- automated CI tests - Automated CI tests that can be run locally using virtual machines.
Implementation is made with the disnix suite - Implementation is made with the disnix suite -
[Disnix](https://github.com/svanderburg/disnix), [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 provide are [Tiny Tiny RSS](https://tt-rss.org/) and
[Vaultwarden](https://github.com/dani-garcia/vaultwarden). Vaultwarden [Vaultwarden](https://github.com/dani-garcia/vaultwarden). Vaultwarden
was chosen as it's IMO the first stepping stone to enable 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 self-hosting. Tiny Tiny RSS was chosen because it is somewhat
of moving parts and also will allow me to test single sign-on. lightweight.