nginx_config_generator_kthompson 0.1.0

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2007 Chris Wanstrath
+
+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,20 @@
+A work in progress.  
+
+Check it: 
+  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.
+
+>> Chris Wanstrath
+=> chris[at]ozmm[dot]org

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rubygems'  
+require 'rake'  
+  
+begin  
+  require 'jeweler'  
+  Jeweler::Tasks.new do |gemspec|  
+    gemspec.name = "nginx_config_generator_kthompson"  
+    gemspec.summary = "Creates Nginx config files from YAML options"
+    gemspec.description = "You got Nginx in my YAML! You got YAML in my Nginx!"
+    gemspec.email = "mrunleaded@gmail.com"
+    gemspec.homepage = "http://github.com/kthompson/nginx_config_generator"
+    gemspec.authors = ["Kevin Thompson", "Chris Wanstrath"]
+    gemspec.executables = ["generate_nginx_config"]
+  end  
+  Jeweler::GemcutterTasks.new
+rescue LoadError  
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"  
+end  
+  
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/VERSION

@@ -0,0 +1 @@
+0.1.0

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,80 @@
+# This defines the default roots and alternate roots.
+# The name (or key) of your site will be sprintf'd with
+# the below root, right.
+root: 
+  rails: /home/chris/sites/%s/current/public
+  default: /home/chris/sites/%s
+
+# Some more additional config variables
+user: deploy
+group: deploy
+
+pid_path: /var/run/
+config_path: /etc/nginx/
+log_path: /var/log/nginx_
+
+# All your vhosts.
+sites: 
+  # We're naming this vhost 'errtheblog'
+  errtheblog:
+    # Two upstream servers to proxy balance fairly.
+    upstream: 
+      - 127.0.0.1:8000
+      - 127.0.0.1:8001
+    fair: true
+    # Just a string of server names.
+    server_name: errtheblog.com www.errtheblog.com
+    # www.errtheblog.com => errtheblog.com
+    no_www: true 
+    # Just strings that get spit out as rewrites
+    # which won't rewrite for feedburner itself
+    feeds:
+      - ^/feed/feedburner http://feeds.feedburner.com/errtheblog
+      - ^/feed/atom.xml http://feeds.feedburner.com/errtheblog
+    # Which root to use.  You can add a custom one here, too.
+    root: rails
+
+  cheat:
+    upstream: 127.0.0.1:8020
+    server_name: cheat.errtheblog.com
+
+  subtlety:
+    upstream: 127.0.0.1:8021
+    server_name: subtlety.errtheblog.com
+
+  sfruby:
+    upstream: 127.0.0.1:8030
+    server_name: sfruby.org www.sfruby.org
+    no_www: true
+    root: rails
+
+  trac:
+    upstream: 127.0.0.1:9000
+    server_name: require.errtheblog.com
+
+  qa:
+    server_name: qa.famupdate.com
+    auth_file: /home/builder/conf/htpasswd
+    root: /home/builder/site
+
+ssl_sites:
+  errtheblog:
+    # ssl configuration
+    ssl:
+      key: /path/to/err.key
+      cert: /path/to/err.crt	
+    # SSL only allows one vhost per IP this can be solved if you have multiple IPs.
+    listen: 10.10.10.1:443
+    # Two upstream servers to proxy balance.
+    upstream:
+      - 127.0.0.1:8000
+      - 127.0.0.1:8001
+    no_www: true
+    server_name: errtheblog.com
+    # Just strings that get spit out as rewrites
+    rewrites:
+      - ^/feed/feedburner http://feeds.feedburner.com/errtheblog
+      - ^/feed/atom.xml http://feeds.feedburner.com/errtheblog
+    # Which root to use.  You can add a custom one here, too.
+    root: rails
+

data/lib/nginx.erb

@@ -0,0 +1,216 @@
+## http://brainspl.at/nginx.conf.txt
+
+#user and group to run as
+user  <%= config['user'] || "nginx" %> <%= config['group'] || "nginx" %>;
+
+# number of nginx workers
+worker_processes  2;
+
+# pid of nginx master process
+pid   <%= config['pid_path'] || 'logs/' %>nginx.pid;
+
+server_names_hash_bucket_size 128;
+
+# Number of worker connections. 1024 is a good default
+events {
+	worker_connections  1024;
+}
+
+# start the http module where we config http access.
+http {
+	# pull in mime-types. You can break out your config 
+	# into as many include's as you want to make it cleaner
+	include       <%= config['config_path'] || 'conf/' %>mime.types;
+
+	<% if config['passenger_root'] && config['passenger_ruby'] %>
+    passenger_root <%= config['passenger_root'] %>;
+    passenger_ruby <%= config['passenger_ruby'] %>;
+	<% end %>
+
+	# set a default type for the rare situation that
+	# nothing matches from the mimie-type include
+	default_type  application/octet-stream;
+
+	# configure log format
+	log_format  main  '$remote_addr - $remote_user [$time_local] $status '
+                		'"$request" $body_bytes_sent "$http_referer" '
+                		'"$http_user_agent" "http_x_forwarded_for"';
+
+	# main access log
+	access_log  <%= config['log_path'] || 'logs/' %>access.log  main;
+
+	# main error log
+    error_log  <%= config['log_path'] || 'logs/' %>error.log  main;
+	#error_log logs/error.log debug_http;
+
+	# no sendfile on OSX 
+	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;
+
+	# this is where you define your mongrel clusters. 
+	# you need one of these blocks for each cluster
+	# and each one needs its own name to refer to it later.
+<% Array(config['sites']).each do |name, site| %>
+  <% next unless site['upstream'] %>
+  upstream <%= name %> {
+  <% if site['fair'] %>
+    fair;
+  <% end %>
+  <% Array(site['upstream'] || site['upstreams']).each do |server| %>
+    server <%= server %>;
+  <% end %>
+  }
+<% end %>
+
+<% %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'] %>
+
+<% if site['listen'] %>
+    listen		<%= site['listen'] %>;
+<% else %>    
+    listen		443;
+<% end %>
+    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;
+
+    # sets the domain[s] that this vhost server requests for
+    server_name  <%= site['server_name'] %>;
+    
+<% end %>
+    
+    # doc root
+    root <%= (config['root'][ site['root'] || 'default' ] || site['root']) % name %>;
+<% if site['passenger'] %>
+    passenger_enabled on;
+    rails_env <%= site['passenger']['environment'] || 'development' %>;
+<% end %>
+    # vhost specific access log
+    access_log  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/system/maintenance.html) {
+      rewrite  ^(.*)$  /system/maintenance.html last;
+      break;
+    }
+
+<% if site['no_www'] %>
+    if ($host ~* "www") {
+      rewrite ^(.*)$ http://<%= site['server_name'].split.first.sub(/^\./, '') %>$1 permanent;
+      break;
+    }
+<% end %>
+
+<% if site['always_www'] %>
+    if ($host != "www.<%= site['server_name'].split.first %>") {
+      rewrite ^(.*)$ http://www.<%= site['server_name'].split.first %>$1 permanent;
+      break;
+    }
+<% end %>
+
+    location / {
+<% Array(site['rewrite'] || site['rewrites']).each do |rewrite| %>
+      rewrite <%= rewrite %> break;
+<% end %>
+
+<% Array(site['feed'] || site['feeds']).each do |feed_rewrite| %>
+    if ($http_user_agent !~ FeedBurner) {
+      rewrite <%= feed_rewrite %> 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 %>
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+      root   html;
+    }
+    
+<% Array(site['location'] || site['locations']).each do |path, setting| %>
+    location = <%= path %> {
+      <%= setting %>
+    }
+<% end %>
+
+  }
+<% end %>
+<% end %>
+}

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,77 @@
+--- !ruby/object:Gem::Specification 
+name: nginx_config_generator_kthompson
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Kevin Thompson
+- Chris Wanstrath
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-08 00:00:00 -07:00
+default_executable: generate_nginx_config
+dependencies: []
+
+description: You got Nginx in my YAML! You got YAML in my Nginx!
+email: mrunleaded@gmail.com
+executables: 
+- generate_nginx_config
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- LICENSE
+- Manifest
+- README
+- Rakefile
+- VERSION
+- bin/generate_nginx_config
+- lib/config.yml.example
+- lib/nginx.erb
+- lib/nginx_config_generator.rb
+has_rdoc: true
+homepage: http://github.com/kthompson/nginx_config_generator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Creates Nginx config files from YAML options
+test_files: []
+