Merge branch 'master' of github.com:experius/SeoSnap into release/0.2.0

README.md

@@ -30,6 +30,27 @@ Make sure you have created a website via dashboard http://127.0.0.1:8080/seosnap
 docker-compose run cachewarmer cache <website id>
 ```
 
+## Nginx
+
+Check the nginx.conf in the example folder
+
+
+# How it works
+
+![diagram](https://github.com/experius/SeoSnap/raw/master/assets/diagram.png)
+
+### Dashboard
+In the dashboard you add the website url along with the website sitemap that you want to make 'SeoSnaps' off.
+
+### Crawler
+When the crawler is started it connects with the dashboard api. It uses scrapy to crawl the sitemap. The scrapy results are send to the administration/dashboard. Scrapy requests are send to the cache server. In a similar way that you would do a request to rendertron. 
+
+### Cache Server
+The cache server is a simple file caching server. If a file exist with the content of the page it serves the html from the file. If not, it renders the requested url with rendertron and saves the html output in a file. To refresh the cache the cache-warmer uses PUT requests instead of GET. This will force update from the cache file.
+
+# Build with
+![diagram](https://github.com/experius/SeoSnap/raw/master/assets/software.png)
+
 ## Usage cache warmer [See](https://github.com/experius/SeoSnap-Cache-Warmer/blob/master/README.md)
 ### Commands
 #### Cache

docker-compose.yml

@@ -73,22 +73,6 @@ services:
     networks:
       - seosnap
 
-  pma:
-    image: phpmyadmin/phpmyadmin
-    depends_on:
-      - db
-    environment:
-      PMA_HOST: db
-      PMA_USER: ${DB_USER}
-      PMA_PASSWORD: ${DB_PASS}
-    restart: "unless-stopped"
-    ports:
-      - 8081:80
-    volumes:
-      - ./dev/instance/mariadb:/var/lib/mysql
-    networks:
-      - seosnap
-
 networks:
   seosnap:
     driver: bridge