capistrano3-puma 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f4e2a7e6da79b8288ad61281abffe71ac11d158
-  data.tar.gz: 6f5d84214b223319ab8f28e67daec049885cf1a6
+  metadata.gz: 906e7e263c2cf0567f367308907420814fedf12d
+  data.tar.gz: cf6269ede1b1f672c1d38d5ff63ac008ffd30efe
 SHA512:
-  metadata.gz: 3bf87fa33238e2c581f6ae1c736e93fc7c5e6ccb419863f7bb778a4d8d1db1eccc82308e1fe0b93a9e44b45ab121a60ac5375fa61df2190a51023206b3123b15
-  data.tar.gz: b7084811e7f7193286bf28579f50db5ba91e0c49ce7c3c6c8cc12c4f3114ac6a29f3d7073b1efd2addc01b7d35250adb53b1b978e0d80d13474bd6e918b187c4
+  metadata.gz: 1a2bc17d7c278226a39664ee3da1e16c7f1e103c9c170b4074662f0263739f27ad66c67d751ec55d0321a23ebae677ddf062086ebb76ce44cbff5de7abf2b7c4
+  data.tar.gz: cf8c248c466623a27f5f41c614ead058998f5d87a511ee94416b9d223bbb5ee21b2532ea4a88ce9072f322278055a7853d4931ef8aab8c4d8137ea88026bcadb

data/README.md

@@ -20,12 +20,28 @@ And then execute:
 
     require 'capistrano/puma'
     require 'capistrano/puma/workers' #if you want to control the workers (in cluster mode)
-    require 'capistrano/puma/jungle' #if you need the jungle tasks
-    require 'capistrano/puma/monit' #if you need the monit tasks
+    require 'capistrano/puma/jungle'  #if you need the jungle tasks
+    require 'capistrano/puma/monit'   #if you need the monit tasks
+    require 'capistrano/puma/nginx'   #if you want to upload a nginx site template
 ```
 
+then you can use ```cap -vT``` to list tasks
+```
+cap nginx:config # upload a nginx site config(eg. /etc/nginx/site-enabled/)
+cap puma:config  # upload puma config(eg. shared/puma.config)
+```
+you may want to customize these two templates localy before uploading
+```
+rails g capistrano:nginx_puma:config
+```
+
+if your nginx server configuration is not located in /etc/nginx, you may need to customize nginx_sites_available_path and nginx_sites_enabled_path
+```
+set :nginx_sites_available_path, "/etc/nginx/sites-available"
+set :nginx_sites_enabled_path, "/etc/nginx/sites-enabled"
+```
 
-Configurable options, shown here with defaults: Please note the configuration options below are not required unless you are trying to override a default setting, for instance if you are deploying on a host on which you do not have sudo or root privileges and you need to restrict the path. These settings go in the deploy.rb file. 
+Configurable options, shown here with defaults: Please note the configuration options below are not required unless you are trying to override a default setting, for instance if you are deploying on a host on which you do not have sudo or root privileges and you need to restrict the path. These settings go in the deploy.rb file.
 
 ```ruby
     set :puma_rackup, -> { File.join(current_path, 'config.ru') }
@@ -67,6 +83,7 @@ Ensure that the following directories are shared (via ``linked_dirs``):
     tmp/pids tmp/sockets log
 
 ## Changelog
+- 0.7.0: added Nginx template generator  @dfang
 - 0.6.1: added :puma_default_hooks, you can turn off the automatic hooks by setting it false
 - 0.6.0: Remove `daemonize true` from default puma.rb file. Explicitly pass `--daemon` flag when needed.
 - 0.5.1: Added worker_timeout option
@@ -97,11 +114,12 @@ Ensure that the following directories are shared (via ``linked_dirs``):
 
 ## Contributors
 
-- [Ruohan Chen] (https://github.com/crhan)
+- [Ruohan Chen](https://github.com/crhan)
 - [molfar](https://github.com/molfar)
 - [ayaya](https://github.com/ayamomiji)
 - [Shane O'Grady](https://github.com/shaneog)
 - [Jun Lin](https://github.com/linjunpop)
+- [fang duan](https://github.com/dfang/capistrano-puma)
 
 ## Contributing
 

data/lib/capistrano/puma.rb

@@ -1 +1 @@
-load File.expand_path('../tasks/puma.cap', __FILE__)
+load File.expand_path('../tasks/puma.cap', __FILE__)

data/lib/capistrano/puma/nginx.rb

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

data/lib/capistrano/puma/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Puma
-    VERSION = '0.6.1'
+    VERSION = '0.7.0'
   end
 end

data/lib/capistrano/tasks/nginx.cap

@@ -0,0 +1,10 @@
+namespace :nginx do
+  desc "Setup nginx configuration"
+  task :config do
+    on roles(:puma_nginx) do
+      template_puma("nginx_conf", "/tmp/nginx_#{fetch(:nginx_config_name)}")
+      sudo :mv, "/tmp/nginx_#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)}"
+      sudo :ln, '-fs', "#{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)} #{fetch(:nginx_sites_enabled_path)}/#{fetch(:nginx_config_name)}"
+    end
+  end
+end

data/lib/capistrano/tasks/puma.cap

@@ -2,6 +2,7 @@ namespace :load do
   task :defaults do
     set :puma_default_hooks, -> { true }
     set :puma_role, :app
+    set :puma_nginx_role, :web
     set :puma_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
     # Configure "min" to be the minimum number of threads to use to answer
     # requests and "max" the maximum.
@@ -20,6 +21,13 @@ namespace :load do
     # Rbenv and RVM integration
     set :rbenv_map_bins, fetch(:rbenv_map_bins).to_a.concat(%w{ puma pumactl })
     set :rvm_map_bins, fetch(:rvm_map_bins).to_a.concat(%w{ puma pumactl })
+
+    # Nginx and puma configuration
+    set :nginx_config_name, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
+    set :nginx_sites_available_path, -> { '/etc/nginx/sites-available' }
+    set :nginx_sites_enabled_path, -> { '/etc/nginx/sites-enabled' }
+    set :nginx_server_name, -> { "localhost #{fetch(:application)}.local" }
+
   end
 end
 
@@ -134,6 +142,9 @@ namespace :puma do
         "lib/capistrano/templates/#{from}.rb.erb",
         "lib/capistrano/templates/#{from}.rb",
         "lib/capistrano/templates/#{from}.erb",
+        "config/deploy/templates/#{from}.rb.erb",
+        "config/deploy/templates/#{from}.rb",
+        "config/deploy/templates/#{from}.erb",
         File.expand_path("../../templates/#{from}.rb.erb", __FILE__),
         File.expand_path("../../templates/#{from}.erb", __FILE__)
     ].each do |path|

data/lib/capistrano/templates/nginx_conf.erb

@@ -0,0 +1,61 @@
+upstream puma_<%= fetch(:nginx_config_name) %> {
+  server <%= fetch(:puma_bind) %> fail_timeout=0;
+}
+
+server {
+  listen 80;
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+  error_page 500 502 504 /500.html;
+  error_page 503 @503;
+
+  server_name <%= fetch(:nginx_server_name) %>;
+  root <%= current_path %>/public;
+  try_files $uri/index.html $uri @puma_<%= fetch(:nginx_config_name) %>;
+
+  location @puma_<%= fetch(:nginx_config_name) %> {
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header Host $http_host;
+    proxy_redirect off;
+    proxy_pass http://puma_<%= fetch(:nginx_config_name) %>;
+    # limit_req zone=one;
+    access_log <%= shared_path %>/log/nginx.access.log;
+    error_log <%= shared_path %>/log/nginx.error.log;
+  }
+
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  location = /50x.html {
+    root html;
+  }
+
+  location = /404.html {
+    root html;
+  }
+
+  location @503 {
+    error_page 405 = /system/maintenance.html;
+    if (-f $document_root/system/maintenance.html) {
+      rewrite ^(.*)$ /system/maintenance.html break;
+    }
+    rewrite ^(.*)$ /503.html break;
+  }
+
+  if ($request_method !~ ^(GET|HEAD|PUT|POST|DELETE|OPTIONS)$ ){
+    return 405;
+  }
+
+  if (-f $document_root/system/maintenance.html) {
+    return 503;
+  }
+
+  location ~ \.(php|html)$ {
+    return 405;
+  }
+}

data/lib/generators/capistrano/nginx_puma/USAGE

@@ -0,0 +1,9 @@
+To create local nginx and puma configuration files call
+
+    rails generate capistrano:nginx_puma:config [path]
+
+The default path is "config/deploy/templates". You can override it like so:
+
+    rails generate capistrano:nginx_puma:config "config/templates"
+
+If you override templates path, don't forget to set "templates_path" variable in your deploy.rb

data/lib/generators/capistrano/nginx_puma/config_generator.rb

@@ -0,0 +1,21 @@
+module Capistrano
+  module NginxPuma
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        desc "Create local nginx and puma configuration files for customization"
+        source_root File.expand_path('../templates', __FILE__)
+        argument :templates_path, :type => :string,
+          :default => "config/deploy/templates",
+          :banner => "path to templates"
+
+        def copy_template
+          copy_file "../../../../capistrano/templates/puma.rb.erb", "#{templates_path}/puma.rb.erb"
+          copy_file "../../../../capistrano/templates/nginx_conf.erb", "#{templates_path}/nginx_conf.erb"
+          # copy_file "puma.rb.erb", "#{templates_path}/puma.rb.erb"
+          # copy_file "puma_init.erb", "#{templates_path}/puma_init.erb"
+          # copy_file "logrotate.erb", "#{templates_path}/logrotate.erb"
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-puma
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Abdelkader Boudih
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -55,17 +55,22 @@ files:
 - lib/capistrano/puma.rb
 - lib/capistrano/puma/jungle.rb
 - lib/capistrano/puma/monit.rb
+- lib/capistrano/puma/nginx.rb
 - lib/capistrano/puma/version.rb
 - lib/capistrano/puma/workers.rb
 - lib/capistrano/tasks/jungle.cap
 - lib/capistrano/tasks/monit.cap
+- lib/capistrano/tasks/nginx.cap
 - lib/capistrano/tasks/puma.cap
 - lib/capistrano/tasks/workers.cap
+- lib/capistrano/templates/nginx_conf.erb
 - lib/capistrano/templates/puma-deb.erb
 - lib/capistrano/templates/puma-rpm.erb
 - lib/capistrano/templates/puma.rb.erb
 - lib/capistrano/templates/puma_monit.conf.erb
 - lib/capistrano/templates/run-puma.erb
+- lib/generators/capistrano/nginx_puma/USAGE
+- lib/generators/capistrano/nginx_puma/config_generator.rb
 homepage: https://github.com/seuros/capistrano-puma
 licenses:
 - MIT
@@ -88,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: Puma integration for Capistrano