From e6efa110105ebea7eb9f37e254908ba2088d76da Mon Sep 17 00:00:00 2001
From: Arne Teuke <arne_teuke@confdroid.com>
Date: Tue, 3 Feb 2026 16:06:43 +0100
Subject: [PATCH] OP#410 update README for GA release

---
 README.md | 48 +++++++++++++++++++++++-------------------------
 1 file changed, 23 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index bc16ef6..fbefbe7 100644
--- a/README.md
+++ b/README.md
@@ -25,35 +25,35 @@
 
 ## WARNING
 
-***Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production***
+---Attention: Never use this puppet module on systems which have been previously configured manually. It is impossible to predict how and what would have been configured, hence previous configurations outside the scope of this module may be overwritten! Automated configurations require a test environment to verify that the module suits the purpose intended by the user, as well as tune the parameters, before deploying into live production---
 
 ## Features
 
 Installation
 
-* install required binaries and dependencies
+- install required binaries and dependencies
 
 Configuration
 
-* manage directory structure (optional)
-* manage configuration files (optional):
-  * file system permissions
-  * selinux context
-* manage firewall settings (optional)
-* manage nagios monitoring (optional)
+- manage directory structure (optional)
+- manage configuration files (optional):
+  - file system permissions
+  - selinux context
+- manage firewall settings (optional)
+- manage nagios monitoring (optional)
 
 Maintenance
 
-* manage the service
+- manage the service
 
 ### vHosts
 
 As stated in the synopsis, this module was written particularly for usage as base module. `Apache httpd` has a great number of use cases where it actually is not used directly as full-blown web server by itself, but instead as platform for other applications. Examples here would be:
 
-* front-end proxy for other applications to avoid having to put the port number into the URL
-* applications like phpMyAdmin, phpPgAdmin
-* WordPress
-* Nagios etc.
+- front-end proxy for other applications to avoid having to put the port number into the URL
+- applications like phpMyAdmin, phpPgAdmin
+- WordPress
+- Nagios etc.
 
 With those use cases, you would provide the vHosts at the Puppet module for the application, not the base module.  Also, if you plan to use this module to run a plain fully fledged web server, you would use a role- or profile class/module on top of `confdroid_apache` to set up your vHost exactly as needed. Examples for regular basic vHost configuration files are included in the examples directory as parameterized .erb files. You would create a define for vHosts, i.e. using the example parameters, and simply add `confdroid_apache` as requirement (i.e. require confdroid_apache) so it gets installed automatically.
 
@@ -61,11 +61,9 @@ With those use cases, you would provide the vHosts at the Puppet module for the
 
 All dependencies must be included in the catalogue.
 
-* [cd_resources](https://gitlab.confdroid.com/puppet/cd_resources) for managing yum repo resources.
-
 ## Deployment
 
-* native Puppet deployment
+- native Puppet deployment
 
 via site.pp or nodes.pp
 
@@ -75,9 +73,9 @@ node 'example.example.net' {
 }
 ```
 
-* through Foreman:
+- through Foreman:
 
-In order to apply parameters through Foreman, **__confdroid_apache::params__** must be added to the host or host group in question.
+In order to apply parameters through Foreman, --__confdroid_apache::params__-- must be added to the host or host group in question.
 
 See [more details about class deployment on Confdroid.com](https://confdroid.com/2017/05/deploying-our-puppet-modules/).
 
@@ -91,16 +89,16 @@ All files and directories are configured with correct selinux context. If selinu
 
 ## Support
 
-* OS: Rocky 9
-* Puppet 8
+- OS: Rocky 9
+- Puppet 8
 
 ## Tests
 
-* Puppet Lint
-* Puppet Parser
-* ERB Template Parser
-* Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
-* Sonar Quality Gate
+- Puppet Lint
+- Puppet Parser
+- ERB Template Parser
+- Test for unwanted UTF8 files in the Puppet code (see tests/UTF_Files)
+- Sonar Quality Gate
 
 ## Contact Us