mattly-nginx_config_generator 0.5.1

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2007 Chris Wanstrath, Matthew Lyon
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of 
+this software and associated documentation files (the "Software"), to deal in 
+the Software without restriction, including without limitation the rights to 
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of 
+the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all 
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS 
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR 
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN 
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest

@@ -0,0 +1,8 @@
+LICENSE
+Manifest
+README
+Rakefile
+bin/generate_nginx_config
+lib/config.yml.example
+lib/nginx.erb
+lib/nginx_config_generator.rb

data/README

@@ -0,0 +1,25 @@
+A work in progress.  
+
+The original version: 
+  http://errtheblog.com/post/3908
+
+Use it: 
+  $ generate_nginx_config nginx_config.yml /etc/nginx.conf
+
+See an example config file:
+  $ generate_nginx_config --example
+
+You can set two environment variables:  
+  - NGINX_CONFIG_YAML to specify the YAML config file 
+  - NGINX_CONFIG_FILE to specify the nginx config file
+
+By default, generate_nginx_config won't overwrite your OUT file.  To rock this behavior,
+pass in --overwrite or -o or -y or --force or -f.  Whichever.
+
+original by:
+>> Chris Wanstrath
+=> chris[at]ozmm[dot]org
+
+new template and configuration options by:
+>> Matthew Lyon
+=> matt[at]flowerpowered[dot]com

data/bin/generate_nginx_config

@@ -0,0 +1,2 @@
+#! /usr/bin/env ruby
+load File.dirname(__FILE__) + '/../lib/nginx_config_generator.rb'

data/lib/config.yml.example

@@ -0,0 +1,103 @@
+# These set various options for nginx. more to come.
+user: deploy
+group: deploy
+pid_path: /var/run
+log_path: /var/log/nginx
+workers: 6
+
+# This defines the default roots and alternate roots.
+# The name (or key) of your site will be sprintf'd with the below root.
+root: 
+  rails: /var/apps/%s/current/public
+  default: /var/www/%s/current/web
+
+# All your vhosts.
+sites: 
+  # serves static html from /var/www/placeholders/current/web
+  placeholders:
+    # "host" or "hosts": should be obvious
+    # by default will generate 'www' hosts for each entry
+    # add 'www: no' to override this behaviour
+    hosts: example.com example.org another-example.com example.net yet-another-example.com
+  
+  # serves static html from /var/www/static_site/current/web
+  static_site:
+    hosts: static.com static.net static.org
+
+    # values for the "alias" key:
+    #   'all': redirects all hosts after the first to the first host
+    #   'none': create no redirects for any hostname
+    #   'www': redirect any domain not starting with 'www' to www.domain.etc
+    #   default: redirect 'www' hostnames to the non-'www' version
+    # in this example %w(www.static.com static.net www.static.net static.org www.static.org) will each redirect to static.com
+    alias: all
+    
+    # Specify that files of a certain type should only be served if the referer
+    # is "none", "blocked" (some proxies set this), or among your hostnames
+    # specified in "hosts" (including any auto-generated 'www' hosts)
+    # Just a list of file extensions, 'images' auto-expands to 'jpg jpeg gif png'
+    prevent_hotlinking: images swf
+    
+    # redirect, redirects, 301s:
+    # hash of regex patterns to match and rewrite rules to go with.
+    # will return a '301 Permanent' redirect.
+    301s:
+      '^/old_url.*': '/new_url'
+      '/old_categories/(.*)': '/$1'
+      '^/info/.*': 'info'
+      '^/info.html': 'info'
+    
+    # specify the location of the 404 page. 
+    # This will not be set if this value is not included.
+    404_not_found: /404.html
+  
+  rails_site:
+    hosts: proxy.com proxied.com
+    
+    # two upstream servers to proxy to
+    # you can do single upstream servers with "upstream: 127.0.0.1:8000"
+    upstream:
+      - 127.0.0.1:8000
+      - 127.0.0.1:8001
+    
+    # like before, aliases everything to 'proxy.com'
+    alias: all
+    
+    # serve out of the 'rails' root
+    root: rails
+    
+    # normal rewrites, specified as a hash.
+    rewrites:
+      '^foo': bar
+    
+    # redirects all except for feedburner to feeds.feedburner.com/foo
+    feedburner:
+      '^/articles.atom': my_rails_site
+    
+    # location of the error page for 500-class errors
+    50x_error_page: /50x.html
+  
+  # other options:
+  # specifies the path to an htpasswd-style authorization file
+  #   auth_file: /path/to/an/htpasswd
+  # setting this will not generate 'www' hostnames for your hosts  
+  #   www: no
+
+# You may also specify https hosts
+ssl_sites:
+  secure_rails_site:
+    # ssl configuration
+    ssl:
+      key: /path/to/ssl.key
+      cert: /path/to/ssl.crt	
+    # SSL only allows one vhost per IP this can be solved if you have multiple IPs.
+    listen: 10.10.10.1:443
+    # This proxies to our same upstream servers as the 'rails_site' entry above.
+    upstream:
+      - 127.0.0.1:8000
+      - 127.0.0.1:8001
+    alias: all
+    host: proxy.com
+    root: rails
+    www: no
+

data/lib/nginx.erb

@@ -0,0 +1,225 @@
+user <%= config['user'] || 'nginx' %> <%= config['group'] || 'nginx' %>;
+
+worker_processes  <%= config['workers'] || 2 %>;
+
+pid               <%= config['pid_path'] || 'logs' %>/nginx.pid;
+
+
+events {
+  worker_connections  1024;
+}
+
+
+http {
+  include       mime.types;
+  default_type  application/octet-stream;
+  
+  log_format    main  '$remote_addr - $remote_user [$time_local] $request '
+                      '"$status" $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+  
+  access_log    <%= config['log_path'] || 'logs' %>/access.log  main;
+  error_log     <%= config['log_path'] || 'logs' %>/error.log   debug;
+  
+  # no sendfile on OS X
+  sendfile      on;
+  
+  # These are good default values.
+  tcp_nopush    on;
+  tcp_nodelay   off;
+  
+  # output compression saves bandwidth 
+  gzip              on;
+  gzip_http_version 1.0;
+  gzip_comp_level   2;
+  gzip_proxied      any;
+  gzip_types        text/plain text/html text/css application/x-javascript text/xml application/xml application/xml+rss text/javascript;
+  
+  server_names_hash_bucket_size 128;
+  
+  # upstream mongrels
+  <% Array(config['sites']).each do |name, site| %>
+    <% next unless site['upstream'] %>
+    upstream <%= name %> {
+    <% Array(site['upstream'] || site['upstreams']).each do |server| %>
+      server <%= server %>;
+    <% end %>
+    }
+  <% end %>
+  
+  # Sites
+  <% %w(sites ssl_sites).each do |site_type| %>
+  
+  <% Array(config[site_type]).each do |name, site| %>
+  # the server directive is nginx's virtual host directive.
+  server {
+      
+    <% if site['ssl'] %>
+    listen <%= site['listen'] || '443' %>
+    ssl on;
+    
+    # path to your certificate
+    ssl_certificate <%= site['ssl']['cert'] %>;
+    
+    # path to your ssl key
+    ssl_certificate_key <%= site['ssl']['key'] %>;
+    <% else %>
+    # port to listen on. Can also be set to an IP:PORT
+    listen       80;
+    <% end %>
+    
+    # sets the domain[s] that this vhost server requests for
+    <%  unless site['www'] == 'no'
+          hosts = (site['host'] || site['hosts']).split
+          server_names = hosts.inject([]) do |memo, host|
+            memo << host
+            memo << "www.#{host}" unless host.match(/\Awww\./) or hosts.include?("www.#{host}")
+            memo
+          end
+        else
+          server_names = hosts.split
+        end
+    %>
+    server_name  <%= server_names.join(' ') %>;
+    
+    # doc root
+    root <%= (config['root'][ site['root'] || 'default' ] || site['root']) % name %>;
+    
+    # vhost specific access log
+    access_log  <%= config['log_path'] || 'logs' %>/<%= name %>.access.log  main;
+    
+    #Set the max size for file uploads to 50Mb
+    client_max_body_size  50M;
+    
+    # this rewrites all the requests to the maintenance.html
+    # page if it exists in the doc root. This is for capistrano's
+    # disable web task
+    if (-f $document_root/maintenance.html){
+      rewrite  ^(.*)$  /maintenance.html last;
+      break;
+    }
+    
+    # Site Aliases
+    <% if site['alias'] == 'all' %>
+    if ($host != "<%= site['host'].split.first %>") {
+      rewrite ^(.*)$ http://<%= site['host'].split.first %>$1 permanent;
+      break;
+    }
+    <% elsif site['alias'] == 'none' %>
+    # no redirects for this domain
+    <% elsif site['alias'] == 'www' %>
+    if ($host !~* "^www") {
+      rewrite ^(.*)$ http://www.<%= site['host'].split.first.sub(/^\./, '') %>$1 permanent;
+      break;
+    }
+    <% else # redirect www only %>
+    if ($host ~* "^www") {
+      rewrite ^(.*)$ http://<%= site['host'].split.first.sub(/^\./, '') %>$1 permanent;
+      break;
+    }
+    <% end %>
+    
+    location / {
+      <% Array(site['rewrite'] || site['rewrites']).each do |rewrite, rule| %>
+      rewrite <%= rewrite %> <%= rule %> break;
+      <% end %>
+      
+      # Redirects
+      <% Array(site['redirect'] || site['redirects'] || site['301s']).each do |regex, destination| %>
+      rewrite <%= regex %> /<%= destination %> permanent;
+      <% end %>
+      
+      <% Array(site['feedburner']).each do |feed, burner| %>
+        if ($http_user_agent !~ FeedBurner) {
+          rewrite <%= feed %> http://feeds.feedburner.com/<%= burner %> break;
+        }
+      <% end %>
+      
+      <% if site['auth_file'] %>
+      auth_basic            "<%= name %> requires credentials.";
+      auth_basic_user_file  <%= site['auth_file'] %>;
+      <% end %>
+      
+      # needed to forward user's IP address to rails
+      proxy_set_header  X-Real-IP  $remote_addr;
+      
+      # needed for HTTPS
+      proxy_set_header  X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header Host $http_host;
+      proxy_redirect false;
+      proxy_max_temp_file_size 0;
+      <% if site['ssl'] %>
+      # set X-FORWARDED_PROTO so ssl_requirement plugin works
+      proxy_set_header X-FORWARDED_PROTO https;
+      <% end %>
+      
+      # If the file exists as a static file serve it directly without
+      # running all the other rewite tests on it
+      if (-f $request_filename) { 
+        break; 
+      }
+      
+      # check for index.html for directory index
+      # if its there on the filesystem then rewite 
+      # the url to add /index.html to the end of it
+      # and then break to send it to the next config rules.
+      if (-f $request_filename/index.html) {
+        rewrite (.*) $1/index.html break;
+      }
+      
+      # this is the meat of the rails page caching config
+      # it adds .html to the end of the url and then checks
+      # the filesystem for that file. If it exists, then we
+      # rewite the url to have explicit .html on the end 
+      # and then send it on its way to the next config rule.
+      # if there is no file on the fs then it sets all the 
+      # necessary headers and proxies to our upstream mongrels
+      if (-f $request_filename.html) {
+        rewrite (.*) $1.html break;
+      }
+      
+      <% if site['upstream'] %>
+      if (!-f $request_filename) {
+        proxy_pass http://<%= name %>;
+        break;
+      }
+      <% end %>
+    }
+    
+    <% if site['404_not_found'] %>
+    error_page   404    <%= site['404_not_found'] %>;
+    <% end %>
+    
+    error_page   500 502 503 504  <%= site['50x_error_page'] || '/50x.html' %>;
+    location = /50x.html {
+      root   html;
+    }
+    
+    <% if site['prevent_hotlinking'] %>
+    valid_referers none blocked <%= server_names.join(' ') %>;
+    <% site['prevent_hotlinking'].split.each do |type| %>
+      <%  exts = case type
+          when 'images'
+            %w(jpg jpeg gif png)
+          else
+            type
+          end
+      %>
+    location ~* \.(<%= exts.join('|') %>)$ {
+      if ($invalid_referer) {
+        return 403;
+      }
+    }
+    <% end %>
+    <% end %>
+    
+    <% Array(site['location'] || site['locations']).each do |path, setting| %>
+    location <%= path %> {
+      <%= setting %>
+    }
+    <% end %>
+    
+  }
+  <% end # site %>
+  <% end # site_type %>
+}

data/lib/nginx_config_generator.rb

@@ -0,0 +1,35 @@
+#! /usr/bin/env ruby
+%w(erb yaml).each &method(:require)
+
+def error(message) puts(message) || exit end
+def file(file) "#{File.dirname(__FILE__)}/#{file}" end
+
+if ARGV.include? '--example'
+  example = file:'config.yml.example'
+  error open(example).read 
+end
+
+env_in  = ENV['NGINX_CONFIG_YAML']
+env_out = ENV['NGINX_CONFIG_FILE']
+
+error "Usage: generate_nginx_config [config file] [out file]" if ARGV.empty? && !env_in
+
+overwrite = %w(-y -o -f --force --overwrite).any? { |f| ARGV.delete(f) }
+
+config   = YAML.load(ERB.new(File.read(env_in || ARGV.shift || 'config.yml')).result)
+template = if custom_template_index = (ARGV.index('--template') || ARGV.index('-t'))
+  custom = ARGV[custom_template_index+1]
+  error "=> Specified template file #{custom} does not exist." unless File.exist?(custom)
+  ARGV.delete_at(custom_template_index) # delete the --argument
+  ARGV.delete_at(custom_template_index) # and its value
+  custom
+else
+  file:'nginx.erb'
+end
+
+if File.exists?(out_file = env_out || ARGV.shift || 'nginx.conf') && !overwrite
+  error "=> #{out_file} already exists, won't overwrite it.  Quitting."
+else
+  open(out_file, 'w+').write(ERB.new(File.read(template), nil, '>').result(binding))
+  error "=> Wrote #{out_file} successfully."
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: mattly-nginx_config_generator
+version: !ruby/object:Gem::Version 
+  version: 0.5.1
+platform: ruby
+authors: 
+- Matthew Lyon
+- Chris Wanstrath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-05 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: You got Nginx in my YAML! You got YAML in my Nginx!
+email: matt@flowerpowered.com
+executables: 
+- generate_nginx_config
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- Manifest
+- Rakefile
+- README
+- bin/generate_nginx_config
+- lib/config.yml.example
+- lib/nginx.erb
+- lib/nginx_config_generator.rb
+has_rdoc: false
+homepage: http://github.com/mattly/nginx_config_generator
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Creates Nginx config files from YAML options
+test_files: []
+