add a bit of text

8gears · Apr 6, 2017 · 17654ce · 17654ce
1 parent c439961
commit 17654ce
Showing 1 changed file with 50 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1 +1,50 @@
-# keycloak-auth-proxy
+# Keycloak Auth Proxy
+
+The Keycloak Auth Proxy makes it possible to protect web resources that have no build in authentication.
+
+## How is it working
+```
++------------+ 
+| | 
+| Internet | 
+| | 
++------|-----+ 
+ | 
+ | 
+ | 
++------|-----+ +------------+ 
+| | | | 
+| Auth Proxy ----------------- Keycloak | 
+| | | | 
++------|-----+ +------------+ 
+ | 
+ | 
+ | 
++------|-----+ 
+| Secured | 
+| Content | 
+| | 
++------------+ 
+```
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+  
+
+
+## Usecases
+
+There are two very common usecases why you would like to use Keycloak Auth Proxy
+
+- Protect static website and allow only authenticated users to see the content
+- Outsource the authentication to Keycloak Auth Proxy on just relay on the header parameter about the user then Keycloak Auth Proxy forward to you.