From 87f96181e78ee13900a0f230dbab1a24e282c8c4 Mon Sep 17 00:00:00 2001
From: 12ww1160 <12ww1160@confdroid.com>
Date: Mon, 2 Feb 2026 21:17:54 +0100
Subject: [PATCH] OP#376 update Readme

---
 README.md | 34 +++++++++++++++++++++++++++++-----
 1 file changed, 29 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index 95c4111..e6e83f4 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,28 @@
 
 [![Build Status](https://jenkins.confdroid.com/buildStatus/icon?job=confdroid_puppet)](https://jenkins.confdroid.com/job/confdroid_puppet/)|
 
+- [Readme](#readme)
+  - [Synopsis](#synopsis)
+  - [WARNING](#warning)
+  - [Features](#features)
+    - [Puppet server and agent](#puppet-server-and-agent)
+    - [Firewall](#firewall)
+    - [Directories, Files and Services,](#directories-files-and-services)
+    - [Optional](#optional)
+      - [R10k service](#r10k-service)
+      - [R10k Web hook](#r10k-web-hook)
+      - [Puppetdb](#puppetdb)
+  - [Support](#support)
+  - [Parameter Inheritance](#parameter-inheritance)
+  - [Module Deployment](#module-deployment)
+    - [native Puppet deployment: via site.pp or nodes.pp](#native-puppet-deployment-via-sitepp-or-nodespp)
+    - [through Foreman](#through-foreman)
+  - [Tests](#tests)
+  - [Contact Us](#contact-us)
+  - [Documentation](#documentation)
+  - [Disclaimer](#disclaimer)
+
+
 ## Synopsis
 
 This Puppet module configures settings a full Puppet environment, i.e. Puppet master, Puppet agents pointed to the master.
@@ -13,7 +35,7 @@ puppet modules
 * PuppetDB for exporting and storing resources.
 
 The syntax is specifically for Puppet Core 8 and Rocky 9, although might work elsewhere as well.
-This module is also designed to work with Foreman  as External Node Classifier (ENC), although it does not install Foreman.
+This module is also designed to work with [Foreman][def]  as External Node Classifier (ENC), although it does not install Foreman.
 
 ## WARNING
 
@@ -23,7 +45,7 @@ This module is also designed to work with Foreman  as External Node Classifier (
 
 ### Puppet server and agent
 
-* if the host FQDN matches your specified Puppet master via `$pt_pm_fqdn`, it installs and configures a puppetmaster ready for serving with Foreman as ENC ( Foreman not yet included).
+* if the host FQDN matches your specified Puppet master via `$pt_pm_fqdn`, it installs and configures a puppetmaster ready for serving with Foreman as ENC (Foreman not yet included). It specifically rewrites the puppet.conf with values taken from parameters.
 * Any other system becomes a puppet agent.
 
 ### Firewall
@@ -48,8 +70,7 @@ This module is also designed to work with Foreman  as External Node Classifier (
   If you set `$pt_use_r10k_webhook`to `true`, it also installs a simple webhook listener to watch for post_hooks from gitlab, and triggers the r10k deployment.
 
 #### Puppetdb
-* to do
-* install node.rb from the foreman for puppetdb
+* installs and configures Puppetdb on the node specified with `pt_puppetdb_fqdn`, which can be the puppetmaster or any other node (recommended for performance reasons)
 
 ## Support
 
@@ -86,10 +107,13 @@ include cd_puppet
 
 ## Contact Us
 
-[contact Us](https://confdroid.com/contact/)
+* [contact form](https://confdroid.com/contact/)
+* [feedback portal](https://feedback.confdroid.com/)
 
 ## Documentation
 
+Additional documentation like FAQ can be found in the [**member wiki**](https://3for.me/x1mar).
+
 ## Disclaimer
 
 ConfDroid as entity is entirely independent from Puppet. We provide custom configuration modules, written for specific purposes and specific environments.