Adds guideslines for contrib and improves README of a few base-repos

Author: coco98

README.md

@@ -86,4 +86,12 @@ issues where active help is required:
 Specifically,
 
 1. Add support for more frameworks
-1. Optimise ``Dockerfile``s for faster builds, or for production (esp. for compiled languages)
+2. Optimise ``Dockerfile``s for faster builds, or for production (esp. for compiled languages)
+
+Some important things to keep in mind when contributing:
+
+1. Expose only one port, and one data volume to help keep things simple
+2. Annotate the ``Dockerfile`` with comments where you expect users to modify
+3. Try to document the following major use cases when writing your README: ``docker build``, ``git push`` based automated docker build, ``docker run``
+
+

elasticsearch/docker-config.yaml

@@ -1,6 +1,4 @@
 image: "elasticsearch:latest"
 port: 9200
-volume_mounts: 
-  - config: /usr/share/elasticsearch/config
-  - data: /usr/share/elasticsearch/data
+volume_mounts: /usr/share/elasticsearch/data
 env_variables: []

go-raw/docker-config.yaml

@@ -1,5 +1,4 @@
 image: "go-server:<tag>"
-port: [8080]
-volume_mounts: []
+port: 8080
+volume_mounts: null
 env_variables: []
-hasura_allowed_roles: ["admin","user","anonymous"]

joomla/docker-config.yaml

@@ -1,7 +1,4 @@
 image: "joomla:latest"
-port: [80]
-volume_mounts:
-    - config: "/var/www/html/installation/configuration.php-dist"
-    - data: "/var/www/html"
+port: 80
+volume_mounts: "/var/www/html"
 env_variables: ["JOOMLA_DB_HOST","JOOMLA_DB_USER","JOOMLA_DB_PASSWORD","JOOMLA_DB_NAME"]
-hasura_allowed_roles: ["admin","user","anonymous"]

mysql/docker-config.yaml

@@ -1,6 +1,4 @@
-image: "hasura-mysql:<tag>"
-port: [3306]
-volume_mounts:
-  - data: /var/lib/mysql
+image: "my-mysql:<tag>"
+port: 3306
+volume_mounts: /var/lib/mysql
 env_variables: ["MYSQL_ROOT_PASSWORD","MYSQL_DATABASE","MYSQL_USER","MYSQL_PASSWORD"]
-hasura_allowed_roles: ["admin"]

nginx/Dockerfile

@@ -1,4 +1,7 @@
 FROM nginx:latest
 
-COPY app/src/ /usr/share/nginx/html
+#Copy the configuration
 COPY app/conf/nginx.conf /etc/nginx
+
+#Copy the static files to be served
+COPY app/src/ /usr/share/nginx/html

nginx/docker-config.yaml

@@ -1,6 +1,4 @@
 image: "nginx:latest"
-port: [80]
-volume_mounts:
-    - config: "/etc/nginx/nginx.conf"
+port: 80
+volume_mounts: null
 env_variables: ["NGINX_HOST", "NGINX_PORT"]
-hasura_allowed_roles: ["admin","user","anonymous"]

nodejs-express/app/src/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "hasura-express-example",
+  "name": "quickstart-docker-express-example",
   "version": "1.0.0",
   "description": "Demo to show git push build and deploy",
   "scripts": {

nodejs-express/docker-config.yaml

@@ -1,5 +1,4 @@
 image: "nodejs-express:<tag>"
-port: [8080]
-volume_mounts: []
+port: 8080
+volume_mounts: null
 env_variables: []
-hasura_allowed_roles: ["admin","user","anonymous"]

php-apache/docker-config.yaml

@@ -1,5 +1,4 @@
 image: "php-apache:0.1"
-port: [8080]
-volume_mounts: []
+port: 8080
+volume_mounts: null
 env_variables: []
-hasura_allowed_roles: ["admin","user","anonymous"]

python-django/docker-config.yaml

@@ -1,5 +1,4 @@
 image: "python-djano:0.1"
-port: [8080]
-volume_mounts: []
+port: 8080
+volume_mounts: null
 env_variables: []
-hasura_allowed_roles: ["admin","user","anonymous"]

python-flask/README.md

@@ -40,7 +40,7 @@ Default Port for application is `8080` .
 Application port can be changed by modifying the variable `bind` in  `app/conf/gunicorn_config.py` or setting Environment Variable
 
 ```python
-bind = "0.0.0.0:" + os.environ.get("APP_PORTS", "<NEW_PORT>")
+bind = "0.0.0.0:" + os.environ.get("APP_PORT", "<NEW_PORT>")
 ```
 
 ```bash
@@ -49,8 +49,8 @@ $ docker run -d -p 8080:<NEW_PORT> python-flask:<tag>
 
 ### **Environment Variables**
 
-* `APP_PORTS` - Application port can also be specified by setting APP_PORTS ENV
+* `APP_PORT` - Application port can also be specified by setting APP_PORT ENV
 
   ```bash
-  $ docker run -d -p 8080:<NEW_PORT> -e APP_PORTS='<NEW_PORT>' python-flask:<tag>
+  $ docker run -d -p 8080:<NEW_PORT> -e APP_PORT='<NEW_PORT>' python-flask:<tag>
   ```

python-flask/app/conf/gunicorn_config.py

@@ -1,7 +1,7 @@
 import os
 import multiprocessing
 
-bind = "0.0.0.0:" + os.environ.get("APP_PORTS", "8080")
+bind = "0.0.0.0:" + os.environ.get("APP_PORT", "8080")
 workers = (multiprocessing.cpu_count() * 2) + 1
 accesslog = "-"
 access_log_format = '%(h)s %(l)s %(u)s %(t)s "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s"'

python-flask/docker-config.yaml

@@ -1,5 +1,4 @@
 image: "python-flask:<tag>"
-port: [8080]
-volume_mounts: []
-env_variables: ["APP_PORTS"]
-hasura_allowed_roles: ["admin","user","anonymous"]
+port: 8080
+volume_mounts: null
+env_variables: ["APP_PORT"]

ruby-rails/docker-config.yaml

@@ -1,5 +1,4 @@
 image: "ruby-rails:0.1"
-port: [8080]
-volume_mounts: []
+port: 8080
+volume_mounts: null
 env_variables: ["SECRET_KEY_BASE"]
-hasura_allowed_roles: ["admin","user","anonymous"]

wordpress/docker-config.yaml

@@ -1,5 +1,4 @@
 image: "php-wordpress:<tag>"
-port: [80]
-volume_mounts:
-  - data: /var/www/html
+port: 80
+volume_mounts: /var/www/html
 env_variables: ["WORDPRESS_DB_HOST","WORDPRESS_DB_USER", "WORDPRESS_DB_PASSWORD"]