vagrant-reverse-proxy 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fc6bfbd2be5d73661529df41828a6f2bdbfacdc3
-  data.tar.gz: e3aad94f72a27c83b4c9cf4838109680ebb2d1fc
+  metadata.gz: 6b161ccdfa9f23fc816ef78e026e3612473a5c2d
+  data.tar.gz: 6e1f550ea1d7209e405937b4eefe4dacd702f344
 SHA512:
-  metadata.gz: 444eb3425dcea8535e3ee9bdbb9e9b305438f209829c3c90c317e7315188612ee210b0b1d0519d0e62357d5925c52bed4a8fb7970e3dd7161aa6a98c5d916802
-  data.tar.gz: 047e6b869a09fb2a68a59227243943eb1850c48924a022027f93e34461c8b1e5ca7b446d0f8fea7dfff6a274abc450b1aaf2809a7f8a992f50b6e91ae2d1057d
+  metadata.gz: b4f5e4f857f7c261fe576c96ceab51fa8ebc28bdc76cc20a73b12c90ea6f299de4185f07edd24781b8c67daf693ad34a74a9f865269d46f0e950ea96960dc6b5
+  data.tar.gz: 0b4259a235e8e93e56f2d81410464686b456e51a76593b4d4662799823d77804281cdd6379486fccea05cb7bb993f7a3c86980d85c49298d32b6fda34478fd51

data/README.md

@@ -107,6 +107,36 @@ to be executed:
 
     config.reverse_proxy.nginx_reload_command = 'sudo service nginx reload'
 
+### Adding custom NGINX configuration to your proxy
+
+Sometimes the standard settings are not enough, and you'll need
+additional custom configuration in a proxy block.  A good example is
+when you want to support websockets; in order to do that, you need to
+force NGINX to use HTTP/1.1 and pass on any `upgrade` headers to the
+downstream server.
+
+To do this, you can add a global setting that will affect all vhosts:
+
+    config.reverse_proxy.nginx_extra_config = <<EOF
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection "upgrade";
+    EOF
+
+If you have a particular setting that applies to a single vhost only,
+you can set a similar property in the vhost hash:
+
+    config.reverse_proxy.vhosts = {
+        "bar" => {:host => "bar.test",
+                  :nginx_extra_config => "proxy_http_version 1.1;\nproxy_set_header Upgrade $http_upgrade;\n"}
+    }
+
+These "extra configs" will be appended to the configuration, with the
+vhost-specific one last.  Of course, for more complicated
+configuration you can just use the NGINX `include` directive to load
+an extra file.  **NOTE:** Remember that all NGINX config directives
+require a trailing semicolon, or the config will be invalid!
+
 ## Adding proxy support to your application
 
 This plugin will instruct NGINX to pass the following headers to your
@@ -136,6 +166,7 @@ add a bit of custom code there if you need to override the base URL.
 
 ## Changelog
 
+- 0.5.0 Add support for `nginx_extra_config` setting (Fixes ticket #8).
 - 0.4.0 Add support for `vagrant reload`, add support for host-based instead
   of location-based dispatching (both thanks to Sam Stevens). NOTE: This is a
   backwards incompatible change: the default name of the config file has

data/lib/vagrant-reverse-proxy/action/write_nginx_config.rb

@@ -93,7 +93,7 @@ module VagrantPlugins
           end
           ip = get_ip_address(machine)
           vhosts.collect do |path, vhost|
-            # Rewrites are matches literally by nginx, which means
+            # Rewrites are matched literally by nginx, which means
             # http://host:80/... will NOT match http://host/...!
             port_suffix = vhost[:port] == 80 ? '' : ":#{vhost[:port]}"
             <<EOF
@@ -108,6 +108,9 @@ location /#{path}/ {
 
     proxy_pass http://#{ip}#{port_suffix}/;
     proxy_redirect http://#{vhost[:host]}#{port_suffix}/ /#{path}/;
+
+    #{vhost[:nginx_extra_config]}
+    #{machine.config.reverse_proxy.nginx_extra_config}
 }
 EOF
           end.join("\n")
@@ -122,7 +125,7 @@ EOF
           end
           ip = get_ip_address(machine)
           vhosts.collect do |path, vhost|
-            # Rewrites are matches literally by nginx, which means
+            # Rewrites are matched literally by nginx, which means
             # http://host:80/... will NOT match http://host/...!
             port_suffix = vhost[:port] == 80 ? '' : ":#{vhost[:port]}"
             <<EOF
@@ -140,7 +143,11 @@ server {
         proxy_set_header X-Forwarded-Port $server_port;
         proxy_set_header X-Real-IP $remote_addr;
         proxy_set_header X-Forwarded-Proto $scheme;
+
         proxy_pass http://#{ip}#{port_suffix}/;
+
+        #{vhost[:nginx_extra_config]}
+        #{machine.config.reverse_proxy.nginx_extra_config}
     }
 }
 EOF

data/lib/vagrant-reverse-proxy/config.rb

@@ -2,7 +2,7 @@ module VagrantPlugins
   module ReverseProxy
     class Plugin
       class Config < Vagrant.plugin(2, :config)
-        attr_accessor :enabled, :vhosts, :nginx_locations_config_file, :nginx_servers_config_file, :nginx_reload_command
+        attr_accessor :enabled, :vhosts, :nginx_locations_config_file, :nginx_servers_config_file, :nginx_reload_command, :nginx_extra_config
         alias_method :enabled?, :enabled
 
         def initialize
@@ -11,6 +11,7 @@ module VagrantPlugins
           @nginx_locations_config_file = UNSET_VALUE
           @nginx_servers_config_file = UNSET_VALUE
           @nginx_reload_command = UNSET_VALUE
+          @nginx_extra_config = UNSET_VALUE
         end
 
         def finalize!
@@ -19,19 +20,23 @@ module VagrantPlugins
             @vhosts = nil
           elsif @vhosts.is_a?(Array)
             # Convert to canonical hash form of
-            # {path => {:host => name, :port => num}}
+            # {path => {:host => name, :port => num, :nginx_extra_config => str}}
             vhosts_hash = {}
-            @vhosts.each {|entry| vhosts_hash[entry] = {:host => entry, :port => 80} }
+            @vhosts.each {|entry| vhosts_hash[entry] = {:host => entry, :port => 80, :nginx_extra_config => ""} }
             @vhosts = vhosts_hash
           elsif @vhosts.is_a?(Hash)
             @vhosts.each do |key, value|
               if (value.is_a?(String))
-                @vhosts[key] = {:host => value, :port => 80}
+                @vhosts[key] = {:host => value, :port => 80,  :nginx_extra_config => ""}
               else
                 value[:port] ||= 80
+                value[:nginx_extra_config] ||= ""
               end
             end
           end
+          if @nginx_extra_config == UNSET_VALUE
+            @nginx_extra_config = nil
+          end
           if @nginx_locations_config_file == UNSET_VALUE
             @nginx_locations_config_file = '/etc/nginx/vagrant-proxy-config-locations'
           end
@@ -73,6 +78,10 @@ module VagrantPlugins
             errors << 'vhosts must be an array of hostnames, a string=>string hash or nil'
           end
 
+          unless @nginx_extra_config.instance_of?(String) || @nginx_extra_config == nil || @nginx_extra_config == UNSET_VALUE
+            errors << 'nginx_extra_config must be a string'
+          end
+
           unless @nginx_locations_config_file.instance_of?(String) || @nginx_locations_config_file == nil || @nginx_locations_config_file == UNSET_VALUE
             errors << 'nginx_locations_config_file must be a string'
           end

data/lib/vagrant-reverse-proxy/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module ReverseProxy
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-reverse-proxy
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Peter Bex
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2017-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler