Update documentation

business-agile · Jan 29, 2014 · c3ca617 · c3ca617
1 parent c7e1883
commit c3ca617
Showing 1 changed file with 84 additions and 46 deletions.
diff --git a/README.md b/README.md
@@ -20,35 +20,59 @@ them are as follows.
     # The max clients allowed
     nginx_max_clients: 512                                
 
-    # A hash of the http paramters. Note that any
+    # A list of the http paramters. Note that any
     # valid nginx http paramters can be added here.
     # (see the nginx documentation for details.)
     nginx_http_params:                                    
-      sendfile: "on"                                      
-      tcp_nopush: "on"
-      tcp_nodelay: "on"
-      keepalive_timeout: "65"
-      access_log: "/var/log/nginx/access.log"
-      error_log: "/var/log/nginx/error.log"
+      - sendfile: "on"                                      
+      - tcp_nopush: "on"
+      - tcp_nodelay: "on"
+      - keepalive_timeout: "65"
+      - access_log: "/var/log/nginx/access.log"
+      - error_log: "/var/log/nginx/error.log"
 
     # A list of hashs that define the servers for nginx,
     # as with http parameters. Any valid server parameters
     # can be defined here.
     nginx_sites:                                         
-     - server:                                           
-        file_name: foo
-        listen: 8080
-        server_name: localhost
-        root: "/tmp/site1"
-        location1: {name: /, try_files: "$uri $uri/ /index.html"}
-        location2: {name: /images/, try_files: "$uri $uri/ /index.html"}
-     - server:
-        file_name: bar
-        listen: 9090
-        server_name: ansible
-        root: "/tmp/site2"
-        location1: {name: /, try_files: "$uri $uri/ /index.html"}
-        location2: {name: /images/, try_files: "$uri $uri/ /index.html"}
+       - server:
+          file_name: foo
+          vars:
+           - listen 8080
+           - server_name localhost
+           - root "/tmp/site1"
+          location1: 
+             name: /
+             vars: 
+                - try_files $uri $uri/ /index.html
+          location2:
+             name: /images/
+             vars:
+                - try_files $uri $uri/ /index.html
+       - server:
+          file_name: bar
+          vars:
+           - listen 9090
+           - server_name ansible
+           - root "/tmp/site2"
+          location1: 
+             name: /
+             vars: 
+                - try_files $uri $uri/ /index.html
+          location2:
+             name: /images/
+             vars:
+                - try_files $uri $uri/ /index.html
+                - allow 127.0.0.1
+                - deny all
+
+    # A list of hashs that define additional configuration
+    nginx_configs:
+      - config:
+         file_name: proxy
+         vars:
+          - proxy_set_header X-Real-IP  $remote_addr
+          - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
 
 Examples
 ========
@@ -59,9 +83,8 @@ configured:
     - hosts: all
       roles:
       - {role: nginx,
-         nginx_http_params: { sendfile: "on",
-                              access_log: "/var/log/nginx/access.log"},
-                              nginx_sites: none }
+         nginx_http_params: ["sendfile on", "access_log /var/log/nginx/access.log",
+                              nginx_sites: none, nginx_configs: none }
 
 
 2) Install nginx with different HTTP directives than previous example, but no
@@ -70,9 +93,9 @@ sites configured.
     - hosts: all
       roles:
       - {role: nginx,
-         nginx_http_params: { tcp_nodelay: "on",
-                              error_log: "/var/log/nginx/error.log"}, 
-                              nginx_sites: none }
+         nginx_http_params: ["tcp_nodelay on", "error_log /var/log/nginx/error.log",
+                              nginx_sites: none, 
+                              nginx_configs: none }
 
 Note: Please make sure the HTTP directives passed are valid, as this role
 won't check for the validity of the directives. See the nginx documentation
@@ -85,25 +108,32 @@ for details.
       roles:
       - role: nginx,
         nginx_http_params:
-          sendfile: "on"
-          access_log: "/var/log/nginx/access.log"
-          nginx_sites:
+          - sendfile "on"
+          - access_log "/var/log/nginx/access.log"
+        nginx_sites:
           - server:
              file_name: bar
-             listen: 8080
-             location1: {name: "/", try_files: "$uri $uri/ /index.html"}
-             location2: {name: /images/, try_files: "$uri $uri/ /index.html"}
+             vars:
+              - listen 8080
+             location1: {name: "/", vars; ["try_files $uri $uri/ /index.html"]}
+             location2: {name: /images/, vars; ["try_files $uri $uri/ /index.html"]}
+        nginx_configs:
+           - config:
+               file_name: proxy
+               vars:
+                - proxy_set_header X-Real-IP  $remote_addr
+                - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
 
 Note: Each site added is represented by list of hashes, and the configurations
-generated are populated in /etc/nginx/conf.d/
+generated are populated in /etc/nginx/site-available/, a link is from /etc/nginx/site-enable/ to /etc/nginx/site-available
 
 The file name for the specific site configurtaion is specified in the hash
 with the key "file_name", any valid server directives can be added to hash.
 For location directive add the key "location" suffixed by a unique number, the
 value for the location is hash, please make sure they are valid location
-directives.
+directives. Additional configuration are created in /etc/nginx/conf.d/
 
-4) Install Nginx and add 2 sites (different method)
+4) Install Nginx , add 2 sites (different method) and add additional configuration
 
     ---
     - hosts: all
@@ -115,18 +145,26 @@ directives.
           nginx_sites:
            - server:
               file_name: foo
-              listen: 8080
-              server_name: localhost
-              root: "/tmp/site1"
-              location1: {name: /, try_files: "$uri $uri/ /index.html"}
-              location2: {name: /images/, try_files: "$uri $uri/ /index.html"}
+              vars:
+               - listen 8080
+               - server_name localhost
+               - root /tmp/site1
+              location1: {name: "/", vars; ["try_files $uri $uri/ /index.html"]}
+              location2: {name: /images/, vars; ["try_files $uri $uri/ /index.html"]}
            - server:
               file_name: bar
-              listen: 9090
-              server_name: ansible
-              root: "/tmp/site2"
-              location1: {name: /, try_files: "$uri $uri/ /index.html"}
-              location2: {name: /images/, try_files: "$uri $uri/ /index.html"}
+              vars:
+               - listen 9090
+               - server_name ansible
+               - root /tmp/site2
+              location1: {name: "/", vars; ["try_files $uri $uri/ /index.html"]}
+              location2: {name: /images/, vars; ["try_files $uri $uri/ /index.html"]}
+          nginx_configs:
+           - config:
+               file_name: proxy
+               vars:
+                - proxy_set_header X-Real-IP  $remote_addr
+                - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for
 
 Dependencies
 ------------