From 3b8737011751b87391dbd0c26b0f3d0d64a274b0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9o=20Bori?= Date: Tue, 30 Apr 2024 19:23:31 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20(readme):=20Updated=20the=20READ?= =?UTF-8?q?ME?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 762d23d..2c41159 100644 --- a/README.md +++ b/README.md @@ -57,10 +57,12 @@ And then add a rule for `ufw` that allow you SSH connections. - **`profile`**: Setup some default configuration for new users - **`security`**: Setup system security tools/services like ssh, knockd, etc. - **`shell`**: Setup a shell environment with fish + tmux -- **`services`**: Setup the Systemd services +- **`service`**: Meta role to setup a service - **`nginx`**: Setup NGINX for the differents services created from the **`services`** role - **`tor`**: Setup a tor hidden service for every services - **`magic`**: Setup the magic stuff, including shell scripts, cron jobs, etc. for backup and web server statistics reporting. +- **service roles**: Each service role like **`gitea`** is based on the **`service`** role. + ### Variables @@ -92,7 +94,6 @@ And then add a rule for `ufw` that allow you SSH connections. - **`ldap_auth_services_bindpw`**: OpenLDAP bind password (should be encrypted) - **`ldap_auth_services_login_attrib`**: OpenLDAP login attribute cn - #### Nextcloud - **`nextcloud_db_user`**: Nextcloud database user (should be encrypted) - **`nextcloud_db_password`**: Nextcloud database password (should be encrypted) @@ -117,6 +118,12 @@ And then add a rule for `ufw` that allow you SSH connections. #### Self Service Password - **`ssp_secretkey`**: SSP secret key use to encrypt/decrypt the token (should be encrypted) +#### Certbot +- **`certbot_email`**: Email address used for certbot certificates (letsencrypt). + +#### Directory +- **`base_dir`**: Base directory for each service. + ## 🎉 Tasks - [x] Tor HTTP response security (with NGINX) - [x] Backup and web server statistics