From b47b02170662cbba29a617f77fe325c63ac6d299 Mon Sep 17 00:00:00 2001
From: Valor Naram <valinora@gmx.net>
Date: Thu, 28 Apr 2022 11:08:49 +0200
Subject: [PATCH] document module 'nginx-dynamic'

---
 module-descr-template.md |  3 +++
 nginx-dynamic/README.md  | 26 ++++++++++++++++++++++++++
 2 files changed, 29 insertions(+)
 create mode 100644 nginx-dynamic/README.md

diff --git a/module-descr-template.md b/module-descr-template.md
index c4ee765..97a84ca 100644
--- a/module-descr-template.md
+++ b/module-descr-template.md
@@ -6,3 +6,6 @@
 
 ## Description
 
+
+
+## How to use
diff --git a/nginx-dynamic/README.md b/nginx-dynamic/README.md
new file mode 100644
index 0000000..ad3f4ec
--- /dev/null
+++ b/nginx-dynamic/README.md
@@ -0,0 +1,26 @@
+# Module `nginx-dynamic`
+
+|                                         |      |
+| --------------------------------------- | ---- |
+| This depends on the following builders: |      |
+
+## Description
+
+A module which is using `nginx` under the hood to offer a reverse proxy for all other modules. This allows a client to access all started modules and their resources they expose through their web API under **one** domain and port. It handles HTTP(S) communication and deals as a woman-in-the-middle.
+
+## How to use
+
+For testing or in cases where this is also a behind another reverse proxy you can run it in development mode. That needs to initialized by executing `./init.dev`.
+
+For cases this module can be directly accessed from the web (no woman-in-the-middle handling HTTPS for it) you need to initialize production mode by executing `./init.prod` . This will activate HTTPS and will get you a certificate from Let’s Encrypt so hackers have a harder way.
+
+If you are using this under Windows (for whatever good reason) you need to go into the code of the initialization script and manually perform the steps the script would do for you.
+
+No other configuration necessary.
+
+Finally start it using
+
+```bash
+sudo docker-compose up
+```
+