From 38fca5e7a7e15b3351771df814affa61ce04e779 Mon Sep 17 00:00:00 2001 From: Felix Stupp Date: Sat, 20 Jun 2020 13:17:14 +0200 Subject: [PATCH] README: Added usage description --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 22cf04b..2d1a197 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,25 @@ Following roles have been defined for making a server configuration easy: - **handlers** contains special handlers effecting all *WireGuard* backbones and clients - **special_client** creates a configuration for a device not configurable by Ansible and stores it locally +All roles, but especially the server subroles, are built to include everything required. +For example, some server subroles include support for configuring AppArmor or fail2ban. +Also nearly all server subroles will install and configure nginx and set the required dns entries. +The are some exceptions however, which are stated here, for example the **dns/entries** role. + +Some roles require variables to be configured, +look into the roles `defaults/main.yml` file. +All configurable variables are documenteted there with their default values. +Mandatory variables are commented or otherwise stated mandatory. + +All roles will use official resources by default, but some of them let you configure those, e.g. **server/tt-rss**. + +## Usage + +You *may* can apply the whole playbook to your server configuration without changes, +but I would not recommended that. +Some role's defaults are specially defined to work good in the environments of my server. +Please use my playbook and roles to build one yourself suited for your environment. + ## License This repository is licensed under MIT.