capistrano3-nginx 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e858774c17cb8f1436362e15a348d7366e5bf4e4
+  data.tar.gz: a6e62a7b762d34b1ca9e87106e3d6fdfeb179b25
+SHA512:
+  metadata.gz: f4c5331b8f735a1ae182f4d626ff95bff6b184c04001e38eedceeb9e5da677ea17c7f5450745ef3d059200a9a064796b15e1d2ed40b9d0bcd72106f6667ca984
+  data.tar.gz: 39e28e58d0e906acbf81c2fcac00e054f5ad2d578751121d273c41a30c7a2d9579dbbfbb5a45cb8276092fe86980bf459bcffa0aebf694696e583155dfc0deb3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in capistrano-bundler.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Capistrano, your one stop deployment shop.
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 platanus
+
+MIT License
+
+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/README.md

@@ -0,0 +1,104 @@
+# Capistrano::Nginx [![Gem Version](https://badge.fury.io/rb/capistrano3-nginx.png)](http://badge.fury.io/rb/capistrano3-nginx)
+
+Nginx support for Capistrano 3.x
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'capistrano3-nginx'
+    gem 'capistrano'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install capistrano-nginx
+
+## Usage
+
+Require in `Capfile` to use the default task:
+
+```ruby
+require 'capistrano/nginx'
+```
+
+You will get the following tasks
+
+```ruby
+cap nginx:start                    # Start nginx service
+cap nginx:stop                     # Stop nginx service
+cap nginx:reload                   # Reload nginx service
+cap nginx:restart                  # Restart nginx service
+cap nginx:site:add                 # Creates the site configuration and upload it to the available folder
+cap nginx:site:disable             # Disables the site removing the symbolic link located in the enabled folder
+cap nginx:site:enable              # Enables the site creating a symbolic link into the enabled folder
+cap nginx:site:remove              # Removes the site removing the configuration file from the available folder
+```
+
+Configurable options, shown here with examples:
+
+```ruby
+# Server name for nginx
+# No default vaue
+set :nginx_domains, "foo.bar.com"
+
+# Roles the deploy nginx site on,
+# default value: :web
+set :nginx_roles, :web
+
+# Path, where nginx log file will be stored
+# default value:  "#{shared_path}/log"
+set :nginx_log_path, "#{shared_path}/log"
+
+# Path where nginx is installed
+# default value: "/etc/nginx"
+set :nginx_root_path, "/etc/nginx"
+
+# Path where nginx available site are stored
+# default value: "sites-available"
+set :nginx_sites_available, "sites-available"
+
+# Path where nginx available site are stored
+# default value: "sites-enabled"
+set :nginx_sites_enabled, "sites-enabled"
+
+# Path to look for custom config template
+# default value: "config/deploy/#{stage}/nginx.conf.erb"
+set :nginx_template, "config/deploy/#{stage}/nginx.conf.erb"
+
+# Use ssl on port 443 to serve on https. Every request to por 80
+# will be rewritten to 443
+# default value: false
+set :nginx_use_ssl, false
+
+# Whether you want to server an application through a proxy pass
+# default value: true
+set :app_server, true
+
+# Socket file that nginx will use as upstream to serve the application
+# Note: Socket upstream has priority over host:port upstreams
+# no default value
+set :app_server_socket, "#{shared_path}/sockets/#{application}.sock"
+
+# The host that nginx will use as upstream to server the application
+# default value: 127.0.0.1
+set :app_server_port,
+
+# The port the application server is running on
+# no default value
+set :app_server_host,
+```
+
+## Thanks
+Thansk for the inspiration on several nginx recipes out there
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/capistrano3-nginx.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'capistrano3-nginx'
+  spec.version       = '1.0.0'
+  spec.authors       = ['Juan Ignacio Donoso']
+  spec.email         = ['jidonoso@gmail.com']
+  spec.description   = %q{Adds suuport to nginx for Capistrano 3.x}
+  spec.summary       = %q{Adds suuport to nginx for Capistrano 3.x}
+  spec.homepage      = 'https://github.com/platanus/capistrano3-nginx'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'capistrano', '>= 3.0.0'
+
+  spec.add_development_dependency 'rake'
+end

data/lib/capistrano/nginx.rb

@@ -0,0 +1 @@
+load File.expand_path('../tasks/nginx.rake', __FILE__)

data/lib/capistrano/tasks/nginx.rake

@@ -0,0 +1,89 @@
+namespace :load do
+  task :defaults do
+    set :nginx_roles, -> { :web }
+    set :nginx_log_path, -> { "#{shared_path}/log" }
+    set :nginx_root_path, -> { "/etc/nginx" }
+    set :nginx_sites_enabled, -> { "sites-enabled" }
+    set :nginx_sites_available, -> { "sites-available" }
+    set :nginx_template, -> { "config/deploy/#{fetch(:stage)}/nginx.conf.erb" }
+    set :nginx_use_ssl, -> { false }
+    set :app_server, -> { true }
+  end
+end
+
+namespace :nginx do
+  task :load_vars do
+    set :sites_available, -> { File.join(fetch(:nginx_root_path), fetch(:nginx_sites_available)) }
+    set :sites_enabled, -> { File.join(fetch(:nginx_root_path), fetch(:nginx_sites_enabled)) }
+    set :enabled_application, -> { File.join(fetch(:sites_enabled), fetch(:application)) }
+    set :available_application, -> { File.join(fetch(:sites_available), fetch(:application)) }
+  end
+
+  %w[start stop restart reload].each do |command|
+    desc "#{command.capitalize} nginx service"
+    task command do
+      on release_roles fetch(:nginx_roles) do
+        if command === 'stop' || (test "sudo nginx -t")
+          execute :sudo, "service nginx #{command}"
+        end
+      end
+    end
+  end
+
+  after 'deploy:check', nil do
+    on release_roles fetch(:nginx_roles) do
+      execute :mkdir, '-pv', fetch(:nginx_log_path)
+    end
+  end
+
+  namespace :site do
+    desc 'Creates the site configuration and upload it to the available folder'
+    task :add => ['nginx:load_vars'] do
+      on release_roles fetch(:nginx_roles) do
+        within fetch(:sites_available) do
+          config_file = fetch(:nginx_template)
+          unless File.exists?(config_file)
+            config_file = File.expand_path('../../../../templates/nginx.conf.erb', __FILE__)
+          end
+          config = ERB.new(File.read(config_file)).result(binding)
+          upload! StringIO.new(config), '/tmp/nginx.conf'
+
+          execute :mv, '/tmp/nginx.conf', fetch(:application)
+        end
+      end
+    end
+
+    desc 'Enables the site creating a symbolic link into the enabled folder'
+    task :enable => ['nginx:load_vars'] do
+      on release_roles fetch(:nginx_roles) do
+        if test "! [ -h #{fetch(:enabled_application)} ]"
+          within fetch(:sites_enabled) do
+            execute :ln, '-nfs', fetch(:available_application), fetch(:enabled_application)
+          end
+        end
+      end
+    end
+
+    desc 'Disables the site removing the symbolic link located in the enabled folder'
+    task :disable => ['nginx:load_vars'] do
+      on release_roles fetch(:nginx_roles) do
+        if test "[ -f #{fetch(:enabled_application)} ]"
+          within fetch(:sites_enabled) do
+            execute :rm, '-f', fetch(:application)
+          end
+        end
+      end
+    end
+
+    desc 'Removes the site removing the configuration file from the available folder'
+    task :remove => ['nginx:load_vars'] do
+      on release_roles fetch(:nginx_roles) do
+        if test "[ -f #{fetch(:available_application)} ]"
+          within fetch(:sites_available) do
+            execute :rm, fetch(:application)
+          end
+        end
+      end
+    end
+  end
+end

data/templates/nginx.conf.erb

@@ -0,0 +1,68 @@
+<% if fetch(:app_server) && (fetch(:app_server_socket) || fetch(:app_server_port))%>
+# Define App Server Upstream
+upstream <%= fetch(:application) %>-app-server {
+<% if fetch(:app_server_socket) %>
+  server unix:<%= fetch(:app_server_socket) %> fail_timeout=0;
+<% elsif fetch(:app_server_port) %>
+  server <%= fetch(:app_server_host, '127.0.0.1') %>:<%= fetch(:app_server_port) %> fail_timeout=0;
+<% end %>
+}
+<% end %>
+
+# HTTP Server
+
+<% if fetch(:nginx_use_ssl) %>
+server {
+  listen 80;
+  rewrite ^(.*) https://$host$1 permanent;
+}
+<% end %>
+
+server {
+
+<% if fetch(:nginx_use_ssl) %>
+  listen 443;
+  ssl on;
+  ssl_certificate /etc/ssl/certs/<%= nginx_ssl_certificate %>;
+  ssl_certificate_key /etc/ssl/private/<%= nginx_ssl_certificate_key %>;
+<% else %>
+  listen 80;
+<% end %>
+
+  server_name <%= fetch(:nginx_domains) %>;
+  root        <%= fetch(:deploy_to) %>/current/<%= fetch(:static_dir) %>;
+
+  access_log <%= fetch(:nginx_log_path) %>/nginx-access.log;
+  error_log  <%= fetch(:nginx_log_path) %>/nginx-error.log;
+
+  error_page 404 /404.html;
+  location /404.html { root <%= fetch(:deploy_to) %>/current/<%= fetch(:static_dir) %>; }
+
+  error_page 500 /500.html;
+  location /500.html { root <%= fetch  (:deploy_to) %>/current/<%= fetch(:static_dir) %>; }
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+<% if fetch(:app_server) && (fetch(:app_server_socket) || fetch(:app_server_port))%>
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  try_files $uri/index.html $uri @<%= fetch(:application) %>-app-server;
+
+  location @<%= fetch(:application) %>-app-server {
+    proxy_set_header X-Real-IP $remote_addr;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-FORWARDED_PROTO http;
+    proxy_set_header Host $http_host;
+  <% if fetch(:nginx_use_ssl) %>
+    proxy_set_header X-Forwarded-Proto https;
+  <% end %>
+    proxy_redirect off;
+    proxy_pass http://<%= fetch(:application) %>-app-server;
+  }
+<% end %>
+}

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: capistrano3-nginx
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Juan Ignacio Donoso
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Adds suuport to nginx for Capistrano 3.x
+email:
+- jidonoso@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- capistrano3-nginx.gemspec
+- lib/capistrano/nginx.rb
+- lib/capistrano/tasks/nginx.rake
+- lib/capistrano3-nginx.rb
+- templates/nginx.conf.erb
+homepage: https://github.com/platanus/capistrano3-nginx
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Adds suuport to nginx for Capistrano 3.x
+test_files: []