From 9e67c463c27e32b6e27e22972ca6e9db1c2fdc70 Mon Sep 17 00:00:00 2001 From: Felix Stupp Date: Fri, 16 Aug 2019 05:09:10 +0200 Subject: [PATCH] README: Added missing descriptions --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.md b/README.md index a155ca0..6dfb5ba 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,35 @@ Following roles have been defined to make creating a server configuration easy: - **certificate** issues a given certificate - **bootstrap** defines a way to connect to a server which has not been configured yet - **common** defines the installation of common packages and common configurations like firewall +- **dns** defines roles for handling dns authorities and slaves, uses *bind9* + - **application** installs main application + - **master** configures a dns authority with support of DNSSEC for a domain + - **slave** configures an automatic cloning slave for a domain - **hostname** configures the hostname for a given host +- **misc** contains some required but small roles + - **handlers** contains some handlers used by other roles + - **system_user** creates a system user - **mysql** defines roles for handling mysql databases and users, uses *MariaDB* - **application** installs the main application with automatic backup - **database** configures a database for an external application with its own user - **nginx** defines roles to set up virtual servers, certificates will be requested by default - **application** installs and configures the main requirements - **forward** sets up a forwarding from one domain to another + - **php-fpm** installs php-fpm and requirements + - **php-pool** sets up a php-fpm pool running its own user account - **php** sets up a PHP webpage with files at the given directory - **proxy** sets up a reverse proxy to a local port / proxy + - **server** sets up a nginx server with custom directives + - **static** sets up a static web root + - **upstream** sets up an upstream accessible to nginx servers +- **node** defines roles for setting up node applications + - **application** installs the main application - **server** defines roles using different kind of server applications, applications will be configured using separated system users - **gitea** sets up a git repository using *Gitea* as web overlay - **nextcloud** sets up a cloud storage using *NextCloud* - **node** sets up a *Node.js* server from a repository with a database expecting it can be configured by command arguments + - **spotme** sets up a SpotMe server - **static** sets up a static virtual server with files from a repository +- **wireguard** defines roles to handle a *WireGuard* configuration across different servers + - **application** installs and configures the main application + - **special_client** creates a configuration for a device not configurable by Ansible and stores it locally