update readme

enhavo · Aug 11, 2019 · 11beb07 · 11beb07
1 parent f2cb18a
commit 11beb07
Show file tree

Hide file tree

Showing 3 changed files with 178 additions and 0 deletions.
diff --git a/.phplint.yml b/.phplint.yml
@@ -0,0 +1,7 @@
+path: ./src
+jobs: 10
+cache: build/phplint/phplint.cache
+extensions:
+    - php
+exclude:
+    - vendor
diff --git a/README.md b/README.md
@@ -1,3 +1,7 @@
+![alt text](assets/enhavo/images/enhavo.svg "enhavo")
+<br/>
+<br/>
+
 Enhavo Proxy
 ------------
 
@@ -10,6 +14,15 @@ Enhavo proxy is made for docker, so it's easy to install on docker hosts.
 Please don't use it for production unless we release version 1.0. We can't guarantee backward compatibility and we may
 have still miss configuration.
 
+Architecture
+------------
+
+We use varnish as proxy server. Varnish can't handle ssl request by default, so we use nginx to resolve https request.
+We use apache only for the web interface, which is based on [enhavo](https://github.com/enhavo/enhavo). With the
+application you can also handle the network configuration and firewall settings.
+
+![alt text](assets/enhavo/images/enhavo.svg "enhavo-proxy")
+
 Contribution
 ------------
 

diff --git a/assets/enhavo/images/enhavo-proxy.svg b/assets/enhavo/images/enhavo-proxy.svg