From 018b74e140ac354820ad7aab991e3ba03b770258 Mon Sep 17 00:00:00 2001
From: Danny Bessems <djpbessems@[...]>
Date: Fri, 6 Dec 2019 14:08:19 +0000
Subject: [PATCH] Update 'README.md'

---
 README.md | 80 ++++++++++++++++++++++++++++++++++---------------------
 1 file changed, 49 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index f6735f4..522cf15 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,50 @@
-# lucidAuth
-[![](https://img.shields.io/badge/status-in%20production-%23003399.svg)](#) [![](https://img.shields.io/badge/contributors-1-green.svg) ](#)  
-
-Forward Authentication for use with proxies (caddy, nginx, traefik, etc)
-
-## Usage
-- Create a new folder, navigate to it in a commandprompt and run the following command:  
-  `git clone https://code.spamasaurus.com/djpbessems/lucidAuth.git`  
-- Edit `include/lucidAuth.config.php.example` to reflect your configuration and save as `include/lucidAuth.config.php`  
-- Create a new website (within any php-capable webserver) and make sure that the documentroot points to the `public` folder  
-- Check if you are able to browse to `https://<fqdn>/lucidAuth.login.php` (where `<fqdn>` is the actual domain -or IP address- your webserver is listening on)  
-- Edit your proxy's configuration to use the new website as forward proxy:  
-  - #### ~~in Caddy/nginx~~    <small>(planned for a later stage)</small>
-
-  - #### in Traefik  
-  Add the following lines (change to reflect your existing configuration):  
-  ```
-  [frontends.server1]
-    entrypoints = ["https"]
-    backend = "server1"
-    [frontends.server1.auth.forward]
-      address = "https://<fqdn>/lucidAuth.validateRequest.php"
-    [frontends.server1.routes]
-      [frontends.server1.routes.ext]
-        rule = "Host:<fqdn>"
-  ```
-
-- #### Important!  
-  The domainname of the website made in step 3, needs to match the domainname (*ignoring subdomains, if any*) of the resource utilizing this authentication proxy.
-
-## Questions or bugs
+# lucidAuth [![](https://img.shields.io/badge/status-in%20production-%23003399.svg)](#) [![](https://img.shields.io/badge/contributors-1-green.svg) ](#)  
+> *Respect* the unexpected, mitigate your risks  
+
+Forward Authentication for use with proxies (caddy, nginx, traefik, etc)
+
+## Usage
+- Create a new folder, navigate to it in a commandprompt and run the following command:  
+  `git clone https://code.spamasaurus.com/djpbessems/lucidAuth.git`  
+- Edit `include/lucidAuth.config.php.example` to reflect your configuration and save as `include/lucidAuth.config.php`  
+- Create a new website (within any php-capable webserver) and make sure that the documentroot points to the `public` folder  
+- Check if you are able to browse to `https://<fqdn>/lucidAuth.login.php` (where `<fqdn>` is the actual domain -or IP address- your webserver is listening on)  
+- Edit your proxy's configuration to use the new website as forward proxy:  
+  - #### ~~in Caddy/nginx~~    <small>(planned for a later stage)</small>
+
+  - #### in Traefik  
+  Add the following lines (change to reflect your existing configuration):  
+#####   1.7  
+  ```
+  [frontends.server1]
+          entrypoints = ["https"]
+          backend = "server1"
+          [frontends.server1.auth.forward]
+            address = "https://<fqdn>/lucidAuth.validateRequest.php"
+          [frontends.server1.routes]
+            [frontends.server1.routes.ext]
+              rule = "Host:<fqdn>"
+  ```
+#####   2.0  
+  In your dynamic file provider:  
+  ```
+  https:
+          middlewares:
+            ldap-authentication:
+              forwardAuth:
+                address: "https://<fqdn>/lucidAuth.validateRequest.php"
+                trustForwardHeader: true
+  ```
+  In your static configuration:  
+  ```
+  entryPoints:
+          https:
+            address: :443
+            insecure: true
+  ```
+
+- #### Important!  
+  The domainname of the website made in step 3, needs to match the domainname (*ignoring subdomains, if any*) of the resource utilizing this authentication proxy.
+
+## Questions or bugs
 Feel free to open issues in this repository.
\ No newline at end of file