capistrano3-puma 3.1.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: aea05894d90b7b2c3d9e0c8b6da97a0c9bd095a0
-  data.tar.gz: fc5089649511e22e2965d95e687e87c10aa1f1dd
+SHA256:
+  metadata.gz: db942a399af982332ceec90035d18c0e46b1f346ba41e4832058fe7e8813982a
+  data.tar.gz: 4beefbf1ec135ea27c80b7dad93fa373d9b4f9d888c8e215573c804e24e09f82
 SHA512:
-  metadata.gz: b35bfb74e3004346403dd141d7fc9f9892ac897a26f7b1cc5f3dcf52962c917b96566e466c287cc74fcd305389b430a2c39bd6dc94abd30eeda0d3ab4308f3d6
-  data.tar.gz: 7176bdadcda38433454f8da5f5528c22ffea4374e1aea66d4c030a2d483b06fb9715f59a3d3ee74ebbb4f5b2eaac53bb9fe8441c98de910218b53d73d8b6f7af
+  metadata.gz: fdee4e5dfeeeea003da8af2eaffc49ba1bb394162535646fa78179a4958bf4bd0cdcbc1e42f88e7ab6ce841790266625c1ceebbfe5a67eecaa0e1a660cc77e64
+  data.tar.gz: 9eb231db71755a26bd740ec1ae2ad3f86675906f93777683c15d59dbb2698f5769391ebf8b1e2ef86c87f3c7aba9ac23ff159d153be8f88759954daf48dd05f1

data/CHANGELOG.md

@@ -1,16 +1,21 @@
 ## Changelog
-- 3.1.0: 
+- 5.0.0:
+  - Support puma 5.0
+  - Support SystemD service manager
+- 4.0.0:
+  - Support puma 4.x
+- 3.1.0:
   - Don't load puma hooks by default.
 - 3.0.0:
- - Require capistrano 3.7+
- - Implement the plugin system
- - don't fail if puma was already running
- - Added :puma_daemonize option (default is false)
+   - Require capistrano 3.7+
+   - Implement the plugin system
+   - don't fail if puma was already running
+   - Added :puma_daemonize option (default is false)
 
 - 2.0.0: 
- - Require puma 3.4+
- - Require Capistrano 3.5+
- - Require capistrano-bundler
+   - Require puma 3.4+
+   - Require Capistrano 3.5+
+   - Require capistrano-bundler
  
 - 1.2.0: add support for puma user for puma user @mcb & @seuros
 - 1.1.0: Set :puma_preload_app to false; Reload Monit after uploading any monit configuration; Always refresh Gemfile @rafaelgoulart @suhailpatel @sime

data/CONTRIBUTORS.md

@@ -45,3 +45,4 @@
 - Suraj Shirvankar
 - marshall-lee
 - ruohan chen
+- ayaya zhao

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2013-2017 Abdelkader Boudih
+Copyright (c) 2013-2020 Abdelkader Boudih
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -26,6 +26,14 @@ And then execute:
     install_plugin Capistrano::Puma::Monit  # if you need the monit tasks
     install_plugin Capistrano::Puma::Nginx  # if you want to upload a nginx site template
 ```
+You will need to select your service manager
+```ruby
+install_plugin Capistrano::Puma::Daemon  # If you using puma daemonized (not supported in Puma 5+)
+```
+or
+```ruby
+install_plugin Capistrano::Puma::Systemd  # if you use SystemD 
+```
 
 To prevent loading the hooks of the plugin, add false to the load_hooks param.
 ```ruby
@@ -36,15 +44,24 @@ To prevent loading the hooks of the plugin, add false to the load_hooks param.
     install_plugin Capistrano::Puma::Monit, load_hooks: false  # Monit tasks without hooks
 ```
 
+To make it work with rvm, rbenv and chruby, install the plugin after corresponding library inclusion.
+```ruby
+    # Capfile
+    
+    require 'capistrano/rbenv'   
+    require 'capistrano/puma'
+    install_plugin Capistrano::Puma
+```
+
 ### Config
 
 To list available tasks use `cap -T`
 
 To upload puma config use:
 ```ruby
-cap puma:config
+cap production puma:config
 ```
-By default the file located in  `shared/puma.config`
+By default the file located in  `shared/puma.rb`
 
 
 Ensure that `tmp/pids` and ` tmp/sockets log` are shared (via `linked_dirs`):
@@ -55,7 +72,7 @@ Ensure that `tmp/pids` and ` tmp/sockets log` are shared (via `linked_dirs`):
 
 To upload a nginx site config (eg. /etc/nginx/sites-enabled/) use:
 ```ruby
-cap puma:nginx_config
+cap production puma:nginx_config
 ```
 
 To customize these two templates locally before uploading use:
@@ -86,13 +103,26 @@ For Jungle tasks (beta), these options exist:
     set :puma_run_path, '/usr/local/bin/run-puma'
 ```
 
+### Systemd
+
+Install Systemd plugin in `Capfile`:
+```ruby
+install_plugin Capistrano::Puma
+install_plugin Capistrano::Puma::Systemd
+```
+
+To generate unit file use:
+```
+cap production puma:systemd:config puma:systemd:enable
+```
+
 ### Multi bind
 
 Multi-bind can be set with an array in the puma_bind variable
 ```ruby
   set :puma_bind, %w(tcp://0.0.0.0:9292 unix:///tmp/puma.sock)
 ```
-    * Listening on tcp://0.0.0.0:9220
+    * Listening on tcp://0.0.0.0:9292
     * Listening on unix:///tmp/puma.sock
 
 ### Active Record
@@ -124,10 +154,23 @@ Configurable options, shown here with defaults: Please note the configuration op
     set :puma_worker_timeout, nil
     set :puma_init_active_record, false
     set :puma_preload_app, false
-    set :puma_daemonize, true
+    set :puma_daemonize, false
     set :puma_plugins, []  #accept array of plugins
     set :puma_tag, fetch(:application)
+    set :puma_restart_command, 'bundle exec puma'
+
+    set :nginx_config_name, "#{fetch(:application)}_#{fetch(:stage)}"
+    set :nginx_flags, 'fail_timeout=0'
+    set :nginx_http_flags, fetch(:nginx_flags)
+    set :nginx_server_name, "localhost #{fetch(:application)}.local"
+    set :nginx_sites_available_path, '/etc/nginx/sites-available'
+    set :nginx_sites_enabled_path, '/etc/nginx/sites-enabled'
+    set :nginx_socket_flags, fetch(:nginx_flags)
+    set :nginx_ssl_certificate, "/etc/ssl/certs/#{fetch(:nginx_config_name)}.crt"
+    set :nginx_ssl_certificate_key, "/etc/ssl/private/#{fetch(:nginx_config_name)}.key"
     set :nginx_use_ssl, false
+    set :nginx_use_http2, true
+    set :nginx_downstream_uses_ssl, false
 ```
 
 __Notes:__ If you are setting values for variables that might be used by other plugins, use `append` instead of `set`. For example:

data/capistrano3-puma.gemspec

@@ -5,7 +5,7 @@ require 'capistrano/puma/version'
 
 Gem::Specification.new do |spec|
   spec.name = 'capistrano3-puma'
-  spec.version = Capistrano::PumaVERSION
+  spec.version = Capistrano::PUMAVERSION
   spec.authors = ['Abdelkader Boudih']
   spec.email = ['Terminale@gmail.com']
   spec.description = %q{Puma integration for Capistrano 3}
@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'capistrano', '~> 3.7'
   spec.add_dependency 'capistrano-bundler'
-  spec.add_dependency 'puma' , '~> 3.4'
+  spec.add_dependency 'puma' , '>= 4.0', '< 6.0'
   spec.post_install_message = %q{
     All plugins need to be explicitly installed with install_plugin.
     Please see README.md

data/lib/capistrano/puma.rb

@@ -8,7 +8,7 @@ module Capistrano
       if user == role.user
         block.call
       else
-        as user do
+        backend.as user do
           block.call
         end
       end
@@ -76,6 +76,7 @@ module Capistrano
       set_if_empty :puma_preload_app, false
       set_if_empty :puma_daemonize, false
       set_if_empty :puma_tag, ''
+      set_if_empty :puma_restart_command, 'bundle exec puma'
 
       # Chruby, Rbenv and RVM integration
       append :chruby_map_bins, 'puma', 'pumactl'
@@ -88,7 +89,6 @@ module Capistrano
 
     def register_hooks
       after 'deploy:check', 'puma:check'
-      after 'deploy:finished', 'puma:smart_restart'
     end
 
     def puma_workers
@@ -116,6 +116,8 @@ module Capistrano
 end
 
 require 'capistrano/puma/workers'
+require 'capistrano/puma/daemon'
+require 'capistrano/puma/systemd'
 require 'capistrano/puma/monit'
 require 'capistrano/puma/jungle'
-require 'capistrano/puma/nginx'
+require 'capistrano/puma/nginx'

data/lib/capistrano/puma/daemon.rb

@@ -0,0 +1,13 @@
+module Capistrano
+  class Puma::Daemon < Capistrano::Plugin
+    include PumaCommon
+
+    def register_hooks
+      after 'deploy:finished', 'puma:smart_restart'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/daemon.rake', __FILE__)
+    end
+  end
+end

data/lib/capistrano/puma/jungle.rb

@@ -13,16 +13,10 @@ module Capistrano
 
     def debian_install(role)
       template_puma 'puma-deb', "#{fetch(:tmp_dir)}/puma", role
-      execute "chmod +x #{fetch(:tmp_dir)}/puma"
-      sudo "mv #{fetch(:tmp_dir)}/puma /etc/init.d/puma"
-      sudo 'update-rc.d -f puma defaults'
     end
 
     def rhel_install(role)
       template_puma 'puma-rpm', "#{fetch(:tmp_dir)}/puma", role
-      execute "chmod +x #{fetch(:tmp_dir)}/puma"
-      sudo "mv #{fetch(:tmp_dir)}/puma /etc/init.d/puma"
-      sudo 'chkconfig --add puma'
     end
   end
 end

data/lib/capistrano/puma/monit.rb

@@ -22,10 +22,13 @@ module Capistrano
 
     def sudo_if_needed(command)
       if fetch(:puma_monit_use_sudo)
-        sudo command
+        backend.sudo command
       else
-        execute command
+        puma_role = fetch(:puma_role)
+        backend.on(puma_role) do
+          backend.execute command
+        end
       end
     end
   end
-end
+end

data/lib/capistrano/puma/nginx.rb

@@ -11,6 +11,8 @@ module Capistrano
       set_if_empty :nginx_http_flags, fetch(:nginx_flags)
       set_if_empty :nginx_socket_flags, fetch(:nginx_flags)
       set_if_empty :nginx_use_ssl, false
+      set_if_empty :nginx_use_http2, true
+      set_if_empty :nginx_downstream_uses_ssl, false
     end
 
     def define_tasks

data/lib/capistrano/puma/systemd.rb

@@ -0,0 +1,19 @@
+module Capistrano
+  class Puma::Systemd < Capistrano::Plugin
+    include PumaCommon
+
+    def register_hooks
+      after 'deploy:finished', 'puma:restart'
+    end
+
+    def define_tasks
+      eval_rakefile File.expand_path('../../tasks/systemd.rake', __FILE__)
+    end
+
+    def set_defaults
+      set_if_empty :puma_systemd_conf_dir, '/etc/systemd/system'
+      set_if_empty :puma_systemctl_bin, '/bin/systemctl'
+      set_if_empty :puma_service_unit_name, 'puma'
+    end
+  end
+end

data/lib/capistrano/puma/version.rb

@@ -1,3 +1,3 @@
 module Capistrano
-  PumaVERSION = '3.1.0'
+  PUMAVERSION = '5.0.1'
 end

data/lib/capistrano/tasks/daemon.rake

@@ -0,0 +1,74 @@
+git_plugin = self
+
+namespace :puma do
+  desc 'Start puma'
+  task :start do
+    on roles(fetch(:puma_role)) do |role|
+      git_plugin.puma_switch_user(role) do
+        if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+          info 'Puma is already running'
+        else
+          within current_path do
+            with rack_env: fetch(:puma_env) do
+              execute :puma, "-C #{fetch(:puma_conf)} --daemon"
+            end
+          end
+        end
+      end
+    end
+  end
+
+  %w[halt stop status].map do |command|
+    desc "#{command} puma"
+    task command do
+      on roles (fetch(:puma_role)) do |role|
+        within current_path do
+          git_plugin.puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if test "[ -f #{fetch(:puma_pid)} ]"
+                if test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+                  execute :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+                else
+                  # delete invalid pid file , process is not running.
+                  execute :rm, fetch(:puma_pid)
+                end
+              else
+                #pid file not found, so puma is probably not running or it using another pidfile
+                warn 'Puma not running'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  %w[phased-restart restart].map do |command|
+    desc "#{command} puma"
+    task command do
+      on roles (fetch(:puma_role)) do |role|
+        within current_path do
+          git_plugin.puma_switch_user(role) do
+            with rack_env: fetch(:puma_env) do
+              if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
+                # NOTE pid exist but state file is nonsense, so ignore that case
+                execute :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
+              else
+                # Puma is not running or state file is not present : Run it
+                invoke 'puma:start'
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
+  task :smart_restart do
+    if !fetch(:puma_preload_app) && fetch(:puma_workers, 0).to_i > 1
+      invoke 'puma:phased-restart'
+    else
+      invoke 'puma:restart'
+    end
+  end
+end

data/lib/capistrano/tasks/jungle.rake

@@ -11,9 +11,15 @@ namespace :puma do
         if test '[ -f /etc/redhat-release ]'
           #RHEL flavor OS
           git_plugin.rhel_install(role)
+          execute "chmod +x #{fetch(:tmp_dir)}/puma"
+          sudo "mv #{fetch(:tmp_dir)}/puma /etc/init.d/puma"
+          sudo 'chkconfig --add puma'
         elsif test '[ -f /etc/lsb-release ]'
           #Debian flavor OS
           git_plugin.debian_install(role)
+          execute "chmod +x #{fetch(:tmp_dir)}/puma"
+          sudo "mv #{fetch(:tmp_dir)}/puma /etc/init.d/puma"
+          sudo 'update-rc.d -f puma defaults'
         else
           #Some other OS
           error 'This task is not supported for your OS'
@@ -32,7 +38,11 @@ namespace :puma do
     desc 'Add current project to the jungle'
     task :add do
       on roles(fetch(:puma_role)) do|role|
-        sudo "/etc/init.d/puma add '#{current_path}' #{fetch(:puma_user, role.user)}"
+        begin
+          sudo "/etc/init.d/puma add '#{current_path}' #{fetch(:puma_user, role.user)} '#{fetch(:puma_conf)}'"
+        rescue => error
+          warn error
+        end
       end
     end
 

data/lib/capistrano/tasks/monit.rake

@@ -8,6 +8,8 @@ namespace :puma do
         git_plugin.template_puma 'puma_monit.conf', "#{fetch(:tmp_dir)}/monit.conf", role
         git_plugin.sudo_if_needed "mv #{fetch(:tmp_dir)}/monit.conf #{fetch(:puma_monit_conf_dir)}"
         git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} reload"
+        # Wait for Monit to be reloaded
+        sleep 1
       end
     end
 
@@ -15,10 +17,10 @@ namespace :puma do
     task :monitor do
       on roles(fetch(:puma_role)) do
         begin
-          git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} monitor #{puma_monit_service_name}"
+          git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} monitor #{git_plugin.puma_monit_service_name}"
         rescue
           invoke 'puma:monit:config'
-          git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} monitor #{puma_monit_service_name}"
+          git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} monitor #{git_plugin.puma_monit_service_name}"
         end
       end
     end
@@ -27,7 +29,7 @@ namespace :puma do
     task :unmonitor do
       on roles(fetch(:puma_role)) do
         begin
-          git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} unmonitor #{puma_monit_service_name}"
+          git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} unmonitor #{git_plugin.puma_monit_service_name}"
         rescue
           # no worries here (still no monitoring)
         end
@@ -37,23 +39,23 @@ namespace :puma do
     desc 'Start Puma monit-service'
     task :start do
       on roles(fetch(:puma_role)) do
-        git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} start #{puma_monit_service_name}"
+        git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} start #{git_plugin.puma_monit_service_name}"
       end
     end
 
     desc 'Stop Puma monit-service'
     task :stop do
       on roles(fetch(:puma_role)) do
-        git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)}  stop #{puma_monit_service_name}"
+        git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)}  stop #{git_plugin.puma_monit_service_name}"
       end
     end
 
     desc 'Restart Puma monit-service'
     task :restart do
       on roles(fetch(:puma_role)) do
-        git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} restart #{puma_monit_service_name}"
+        git_plugin.sudo_if_needed "#{fetch(:puma_monit_bin)} restart #{git_plugin.puma_monit_service_name}"
       end
     end
 
   end
-end
+end

data/lib/capistrano/tasks/puma.rake

@@ -8,75 +8,6 @@ namespace :puma do
     end
   end
 
-  desc 'Start puma'
-  task :start do
-    on roles(fetch(:puma_role)) do |role|
-      git_plugin.puma_switch_user(role) do
-        if test "[ -f #{fetch(:puma_conf)} ]"
-          info "using conf file #{fetch(:puma_conf)}"
-        else
-          invoke 'puma:config'
-        end
-
-        if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
-          info 'Already Puma is running'
-        else
-          within current_path do
-            with rack_env: fetch(:puma_env) do
-              execute :puma, "-C #{fetch(:puma_conf)} --daemon"
-            end
-          end
-        end
-      end
-    end
-  end
-
-  %w[halt stop status].map do |command|
-    desc "#{command} puma"
-    task command do
-      on roles (fetch(:puma_role)) do |role|
-        within current_path do
-          git_plugin.puma_switch_user(role) do
-            with rack_env: fetch(:puma_env) do
-              if test "[ -f #{fetch(:puma_pid)} ]"
-                if test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
-                  execute :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
-                else
-                  # delete invalid pid file , process is not running.
-                  execute :rm, fetch(:puma_pid)
-                end
-              else
-                #pid file not found, so puma is probably not running or it using another pidfile
-                warn 'Puma not running'
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-
-  %w[phased-restart restart].map do |command|
-    desc "#{command} puma"
-    task command do
-      on roles (fetch(:puma_role)) do |role|
-        within current_path do
-          git_plugin.puma_switch_user(role) do
-            with rack_env: fetch(:puma_env) do
-              if test "[ -f #{fetch(:puma_pid)} ]" and test :kill, "-0 $( cat #{fetch(:puma_pid)} )"
-                # NOTE pid exist but state file is nonsense, so ignore that case
-                execute :pumactl, "-S #{fetch(:puma_state)} -F #{fetch(:puma_conf)} #{command}"
-              else
-                # Puma is not running or state file is not present : Run it
-                invoke 'puma:start'
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-
   task :check do
     on roles(fetch(:puma_role)) do |role|
       #Create puma.rb for new deployments
@@ -87,14 +18,4 @@ namespace :puma do
       end
     end
   end
-
-
-  task :smart_restart do
-    if !git_plugin.puma_preload_app? && git_plugin.puma_workers.to_i > 1
-      invoke 'puma:phased-restart'
-    else
-      invoke 'puma:restart'
-    end
-  end
-
 end

data/lib/capistrano/tasks/systemd.rake

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+git_plugin = self
+
+namespace :puma do
+  namespace :systemd do
+    desc 'Config Puma systemd service'
+    task :config do
+      on roles(fetch(:puma_role)) do |role|
+        unit_filename = "#{fetch(:puma_service_unit_name)}.service"
+        git_plugin.template_puma unit_filename, "#{fetch(:tmp_dir)}/#{unit_filename}", role
+        sudo "mv #{fetch(:tmp_dir)}/#{unit_filename} #{fetch(:puma_systemd_conf_dir)}"
+        sudo "#{fetch(:puma_systemctl_bin)} daemon-reload"
+      end
+    end
+
+    desc 'Enable Puma systemd service'
+    task :enable do
+      on roles(fetch(:puma_role)) do
+        sudo "#{fetch(:puma_systemctl_bin)} enable #{fetch(:puma_service_unit_name)}"
+      end
+    end
+
+    desc 'Disable Puma systemd service'
+    task :disable do
+      on roles(fetch(:puma_role)) do
+        sudo "#{fetch(:puma_systemctl_bin)} disable #{fetch(:puma_service_unit_name)}"
+      end
+    end
+  end
+
+  desc 'Start Puma service via systemd'
+  task :start do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} start #{fetch(:puma_service_unit_name)}"
+    end
+  end
+
+  desc 'Stop Puma service via systemd'
+  task :stop do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} stop #{fetch(:puma_service_unit_name)}"
+    end
+  end
+
+  desc 'Restart Puma service via systemd'
+  task :restart do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} restart #{fetch(:puma_service_unit_name)}"
+    end
+  end
+
+  desc 'Get Puma service status via systemd'
+  task :status do
+    on roles(fetch(:puma_role)) do
+      sudo "#{fetch(:puma_systemctl_bin)} status #{fetch(:puma_service_unit_name)}"
+    end
+  end
+end

data/lib/capistrano/templates/nginx_conf.erb

@@ -14,16 +14,27 @@ end
 server {
   listen 80;
   server_name <%= fetch(:nginx_server_name) %>;
-  rewrite ^(.*) https://$host$1 permanent;
+  return 301 https://$host$1$request_uri;
 }
 <% end -%>
 
 server {
 <% if fetch(:nginx_use_ssl) -%>
-  listen 443;
-  ssl on;
+  <% if fetch(:nginx_use_http2) -%>
+  listen 443 ssl http2;
+  <% else -%>
+  listen 443 ssl;
+  <% end -%>
+<% if fetch(:nginx_ssl_certificate) -%>
+  ssl_certificate <%= fetch(:nginx_ssl_certificate) %>;
+<% else -%>
   ssl_certificate /etc/ssl/certs/<%= fetch(:nginx_config_name) %>.crt;
+<% end -%>
+<% if fetch(:nginx_ssl_certificate_key) -%>
+  ssl_certificate_key <%= fetch(:nginx_ssl_certificate_key) %>;
+<% else -%>
   ssl_certificate_key /etc/ssl/private/<%= fetch(:nginx_config_name) %>.key;
+<% end -%>
 <% else -%>
   listen 80;
 <% end -%>
@@ -38,11 +49,20 @@ server {
   error_page 503 @503;
 
   location @puma_<%= fetch(:nginx_config_name) %> {
+    proxy_http_version 1.1;
     proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-    proxy_set_header Host $http_host;
+    proxy_set_header Host $host;
     proxy_redirect off;
+    proxy_set_header Upgrade $http_upgrade;
+    proxy_set_header Connection "Upgrade";
 <% if fetch(:nginx_use_ssl) -%>
     proxy_set_header X-Forwarded-Proto https;
+<% else -%>
+  <% if fetch(:nginx_downstream_uses_ssl) -%>
+    proxy_set_header X-Forwarded-Proto https;
+  <% else -%>
+    proxy_set_header X-Forwarded-Proto http;
+  <% end -%>
 <% end -%>
     proxy_pass http://puma_<%= fetch(:nginx_config_name) %>;
     # limit_req zone=one;

data/lib/capistrano/templates/puma-deb.erb

@@ -1,17 +1,16 @@
 #! /bin/sh
 ### BEGIN INIT INFO
-# Provides: puma
-# Required-Start: $remote_fs $syslog
-# Required-Stop: $remote_fs $syslog
-# Default-Start: 2 3 4 5
-# Default-Stop: 0 1 6
-# Short-Description: Example initscript
-# Description: This file should be used to construct scripts to be
-# placed in /etc/init.d.
+# Provides:          puma 
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Puma web server
+# Description:       A ruby web server built for concurrency http://puma.io
+#                    initscript to be placed in /etc/init.d.
 ### END INIT INFO
 
-# Author: Darío Javier Cravero <'dario@exordo.com'>
-# Modified by: Abdelkader Boudih <'terminale@gmail.com'>
+# Author: Darío Javier Cravero <dario@exordo.com>
 #
 # Do NOT "set -e"
 
@@ -24,6 +23,7 @@ SCRIPTNAME=/etc/init.d/$NAME
 CONFIG=<%=fetch(:puma_jungle_conf)%>
 JUNGLE=`cat $CONFIG`
 RUNPUMA=<%=fetch(:puma_run_path)%>
+USE_LOCAL_BUNDLE=0
 
 # Load the VERBOSE setting and other rcS variables
 . /lib/init/vars.sh
@@ -33,22 +33,13 @@ RUNPUMA=<%=fetch(:puma_run_path)%>
 . /lib/lsb/init-functions
 
 #
-# Function that starts the jungle
+# Function that starts the jungle 
 #
 do_start() {
   log_daemon_msg "=> Running the jungle..."
   for i in $JUNGLE; do
     dir=`echo $i | cut -d , -f 1`
-    user=`echo $i | cut -d , -f 2`
-    config_file=`echo $i | cut -d , -f 3`
-    if [ "$config_file" = "" ]; then
-      config_file="$dir/config/puma.rb"
-    fi
-    log_file=`echo $i | cut -d , -f 4`
-    if [ "$log_file" = "" ]; then
-      log_file="$dir/log/puma.log"
-    fi
-    do_start_one $dir $user $config_file $log_file
+    do_start_one $dir
   done
 }
 
@@ -58,21 +49,41 @@ do_start_one() {
     PID=`cat $PIDFILE`
     # If the puma isn't running, run it, otherwise restart it.
     if [ "`ps -A -o pid= | grep -c $PID`" -eq 0 ]; then
-      do_start_one_do $1 $2
+      do_start_one_do $1
     else
-      do_restart_one $1 $2
+      do_restart_one $1
     fi
   else
-    do_start_one_do $1 $2
+    do_start_one_do $1
   fi
 }
 
 do_start_one_do() {
-  log_daemon_msg "--> Woke up puma $1"
-  log_daemon_msg "user $2"
-  log_daemon_msg "log to $4"
-  log_daemon_msg "start-stop-daemon --verbose --start --chdir $1 --chuid $2 --background --exec $RUNPUMA $1 "
-  start-stop-daemon --verbose --start --chdir $1 --chuid $2 --background --exec $RUNPUMA -- $1
+  i=`grep $1 $CONFIG`
+  dir=`echo $i | cut -d , -f 1`
+  user=`echo $i | cut -d , -f 2`
+  config_file=`echo $i | cut -d , -f 3`
+  if [ "$config_file" = "" ]; then
+    config_file="$dir/config/puma.rb"
+  fi
+  log_file=`echo $i | cut -d , -f 4`
+  if [ "$log_file" = "" ]; then
+    log_file="$dir/log/puma.log"
+  fi
+  environment=`echo $i | cut -d , -f 5`
+
+  log_daemon_msg "--> Woke up puma $dir"
+  log_daemon_msg "user $user"
+  log_daemon_msg "log to $log_file"
+
+  if [ ! -z "$environment" ]; then
+    for e in $(echo "$environment" | tr ';' '\n'); do
+        log_daemon_msg "environment $e"
+        v=${e%%\=*} ;  eval "$e" ; export $v
+    done
+  fi
+
+  start-stop-daemon --verbose --start --chdir $dir --chuid $user --background --exec $RUNPUMA -- $dir $config_file $log_file
 }
 
 #
@@ -82,8 +93,7 @@ do_stop() {
   log_daemon_msg "=> Putting all the beasts to bed..."
   for i in $JUNGLE; do
     dir=`echo $i | cut -d , -f 1`
-    user=`echo $i | cut -d , -f 2`
-    do_stop_one $dir $user
+    do_stop_one $dir
   done
 }
 #
@@ -99,7 +109,11 @@ do_stop_one() {
       log_daemon_msg "---> Puma $1 isn't running."
     else
       log_daemon_msg "---> About to kill PID `cat $PIDFILE`"
-      su - $2 -c "pumactl --state $STATEFILE stop"
+      if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
+        cd $1 && bundle exec pumactl --state $STATEFILE stop
+      else
+        pumactl --state $STATEFILE stop
+      fi
       # Many daemons don't delete their pidfiles when they exit.
       rm -f $PIDFILE $STATEFILE
     fi
@@ -110,13 +124,12 @@ do_stop_one() {
 }
 
 #
-# Function that restarts the jungle
+# Function that restarts the jungle 
 #
 do_restart() {
   for i in $JUNGLE; do
     dir=`echo $i | cut -d , -f 1`
-    user=`echo $i | cut -d , -f 2`
-    do_restart_one $dir $user
+    do_restart_one $dir
   done
 }
 
@@ -125,39 +138,52 @@ do_restart() {
 #
 do_restart_one() {
   PIDFILE=$1/tmp/pids/puma.pid
-  i=`grep $1 $CONFIG`
-  dir=`echo $i | cut -d , -f 1`
 
   if [ -e $PIDFILE ]; then
     log_daemon_msg "--> About to restart puma $1"
-    su - $2 -c "pumactl --state $dir/tmp/pids/puma.state restart"
-    # kill -s USR2 `cat $PIDFILE`
+    kill -s USR2 `cat $PIDFILE`
     # TODO Check if process exist
   else
     log_daemon_msg "--> Your puma was never playing... Let's get it out there first"
-    user=`echo $i | cut -d , -f 2`
-    config_file=`echo $i | cut -d , -f 3`
-    if [ "$config_file" = "" ]; then
-      config_file="$dir/config/puma.rb"
-      do_start_one $dir $user $config_file
-    fi
-    log_file=`echo $i | cut -d , -f 4`
-    if [ "$log_file" = "" ]; then
-      log_file="$dir/log/puma.log"
-    fi
-    do_start_one $dir $user $config_file $log_file
+    do_start_one $1
   fi
-  return 0
+	return 0
+}
+
+#
+# Function that phased restarts the jungle
+#
+do_phased_restart() {
+  for i in $JUNGLE; do
+    dir=`echo $i | cut -d , -f 1`
+    do_phased_restart_one $dir
+  done
+}
+
+#
+# Function that sends a SIGUSR1 to the daemon/service
+#
+do_phased_restart_one() {
+  PIDFILE=$1/tmp/pids/puma.pid
+
+  if [ -e $PIDFILE ]; then
+    log_daemon_msg "--> About to restart puma $1"
+    kill -s USR1 `cat $PIDFILE`
+    # TODO Check if process exist
+  else
+    log_daemon_msg "--> Your puma was never playing... Let's get it out there first"
+    do_start_one $1
+  fi
+	return 0
 }
 
 #
-# Function that statuss the jungle
+# Function that statuss the jungle 
 #
 do_status() {
   for i in $JUNGLE; do
     dir=`echo $i | cut -d , -f 1`
-    user=`echo $i | cut -d , -f 2`
-    do_status_one $dir $user
+    do_status_one $dir
   done
 }
 
@@ -168,16 +194,20 @@ do_status_one() {
   PIDFILE=$1/tmp/pids/puma.pid
   i=`grep $1 $CONFIG`
   dir=`echo $i | cut -d , -f 1`
-
+  
   if [ -e $PIDFILE ]; then
     log_daemon_msg "--> About to status puma $1"
-
-    su - $2 -c "pumactl --state $dir/tmp/pids/puma.state stats "
-
+    if [ "$USE_LOCAL_BUNDLE" -eq 1 ]; then
+      cd $1 && bundle exec pumactl --state $dir/tmp/pids/puma.state stats
+    else
+      pumactl --state $dir/tmp/pids/puma.state stats
+    fi
+    # kill -s USR2 `cat $PIDFILE`
+    # TODO Check if process exist
   else
-    log_daemon_msg "--> $1 isn't there :(..."
+    log_daemon_msg "--> $1 isn't there :(..." 
   fi
-  return 0
+	return 0
 }
 
 do_add() {
@@ -188,7 +218,7 @@ do_add() {
       str=$1
     else
       echo "The app is already being managed. Remove it if you want to update its config."
-      exit 0
+      exit 1 
     fi
   else
     echo "The directory $1 doesn't exist."
@@ -215,7 +245,12 @@ do_add() {
     str="$str,$4"
   fi
 
-  # Add it to the jungle
+  # Environment variables
+  if [ "$5" != "" ]; then
+    str="$str,$5"
+  fi
+
+  # Add it to the jungle 
   echo $str >> $CONFIG
   log_daemon_msg "Added a Puma to the jungle: $str. You still have to start it though."
 }
@@ -232,6 +267,49 @@ do_remove() {
   fi
 }
 
+config_bundler() {
+  HOME="$(eval echo ~$(id -un))"
+
+  if [ -d "$1/.rbenv/bin" ]; then
+    PATH="$1/.rbenv/bin:$1/.rbenv/shims:$1"
+    eval "$(rbenv init -)"
+    USE_LOCAL_BUNDLE=1
+    return 0
+
+  elif [ -d "/usr/local/rbenv/bin" ]; then
+    PATH="/usr/local/rbenv/bin:/usr/local/rbenv/shims:$PATH"
+    eval "$(rbenv init -)"
+    USE_LOCAL_BUNDLE=1
+    return 0
+
+  elif [ -d "$HOME/.rbenv/bin" ]; then
+    PATH="$HOME/.rbenv/bin:$HOME/.rbenv/shims:$PATH"
+    eval "$(rbenv init -)"
+    USE_LOCAL_BUNDLE=1
+    return 0
+
+  # TODO: test rvm
+  # elif [ -f  /etc/profile.d/rvm.sh ]; then
+  #   source /etc/profile.d/rvm.sh
+  # elif [ -f /usr/local/rvm/scripts/rvm ]; then
+  #   source /etc/profile.d/rvm.sh
+  # elif [ -f "$HOME/.rvm/scripts/rvm" ]; then
+  #   source "$HOME/.rvm/scripts/rvm"
+  # TODO: don't know what to do with chruby
+  # elif [ -f /usr/local/share/chruby/chruby.sh ]; then
+  #   source /usr/local/share/chruby/chruby.sh
+  #   if [ -f /usr/local/share/chruby/auto.sh ]; then
+  #     source /usr/local/share/chruby/auto.sh
+  #   fi
+  # if you aren't using auto, set your version here
+  # chruby 2.0.0
+  fi
+
+  return 1
+}
+
+config_bundler
+
 case "$1" in
   start)
     [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME"
@@ -240,18 +318,12 @@ case "$1" in
     else
       i=`grep $2 $CONFIG`
       dir=`echo $i | cut -d , -f 1`
-      user=`echo $i | cut -d , -f 2`
-      config_file=`echo $i | cut -d , -f 3`
-      if [ "$config_file" = "" ]; then
-        config_file="$dir/config/puma.rb"
-
-        do_start_one $dir $user $config_file
-      fi
-      case "$?" in
-        0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
-        2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
-      esac
+      do_start_one $dir
     fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
   ;;
   stop)
     [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
@@ -296,11 +368,25 @@ case "$1" in
       2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
     esac
   ;;
+  phased-restart)
+    log_daemon_msg "Restarting (phased) $DESC" "$NAME"
+    if [ "$#" -eq 1 ]; then
+      do_phased_restart
+    else
+      i=`grep $2 $CONFIG`
+      dir=`echo $i | cut -d , -f 1`
+      do_phased_restart_one $dir
+    fi
+    case "$?" in
+      0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
+      2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
+    esac
+  ;;
   add)
     if [ "$#" -lt 3 ]; then
-      echo "Please, specifiy the app's directory and the user that will run it at least."
-      echo " Usage: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
-      echo " config and log are optionals."
+      echo "Please, specify the app's directory and the user that will run it at least."
+      echo "  Usage: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
+      echo "    config and log are optionals."
       exit 1
     else
       do_add $2 $3 $4 $5
@@ -324,13 +410,12 @@ case "$1" in
   ;;
   *)
     echo "Usage:" >&2
-    echo " Run the jungle: $SCRIPTNAME {start|stop|status|restart}" >&2
-    echo " Add a Puma: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
-    echo " config and log are optionals."
-    echo " Remove a Puma: $SCRIPTNAME remove /path/to/app"
-    echo " On a Puma: $SCRIPTNAME {start|stop|status|restart} PUMA-NAME" >&2
+    echo "  Run the jungle: $SCRIPTNAME {start|stop|status|restart|phased-restart}" >&2
+    echo "  Add a Puma: $SCRIPTNAME add /path/to/app user /path/to/app/config/puma.rb /path/to/app/config/log/puma.log"
+    echo "    config and log are optionals."
+    echo "  Remove a Puma: $SCRIPTNAME remove /path/to/app"
+    echo "  On a Puma: $SCRIPTNAME {start|stop|status|restart|phased-restart} PUMA-NAME" >&2
     exit 3
   ;;
 esac
 :
-

data/lib/capistrano/templates/puma.rb.erb

@@ -28,6 +28,8 @@ worker_timeout <%= fetch(:puma_worker_timeout).to_i %>
 daemonize
 <% end %>
 
+restart_command '<%= fetch(:puma_restart_command) %>'
+
 <% if puma_preload_app? %>
 preload_app!
 <% else %>

data/lib/capistrano/templates/puma.service.erb

@@ -0,0 +1,18 @@
+[Unit]
+Description=Puma HTTP Server for <%= "#{fetch(:application)} (#{fetch(:stage)})" %>
+After=network.target
+
+[Service]
+Type=simple
+User=<%= puma_user(@role) %>
+WorkingDirectory=<%= current_path %>
+ExecStart=<%= SSHKit.config.command_map[:bundle] %> exec puma -C <%= fetch(:puma_conf) %>
+ExecReload=/bin/kill -TSTP $MAINPID
+ExecStop=/bin/kill -TERM $MAINPID
+StandardOutput=append:<%= fetch(:puma_access_log) %>
+StandardError=append:<%= fetch(:puma_error_log) %>
+
+Restart=always
+
+[Install]
+WantedBy=multi-user.target

data/lib/capistrano/templates/run-puma.erb

@@ -1,9 +1,20 @@
 #!/bin/bash
-app=$1;
-cd $app || exit 1
 
-if [ -e Gemfile ]; then
-    exec <%= fetch(:puma_user) ? "sudo -u #{puma_user(@role)}" : '' %> sh -c "exec bundle exec puma -C <%= fetch(:puma_conf) %> --daemon"
-else
-    exec <%= fetch(:puma_user) ? "sudo -u #{puma_user(@role)}" : '' %> sh -c "exec puma -C <%= fetch(:puma_conf) %> --daemon"
+# source ENV variables manually
+. /etc/environment
+# on system boot, and root have no rbenv installed,
+#   after start-stop-daemon switched to current user, we have to init rbenv
+if [ -d "$HOME/.rbenv/bin" ]; then
+  PATH="$HOME/.rbenv/bin:$HOME/.rbenv/shims:$PATH"
+  eval "$(rbenv init -)"
+elif [ -d "/usr/local/rbenv/bin" ]; then
+  PATH="/usr/local/rbenv/bin:/usr/local/rbenv/shims:$PATH"
+  eval "$(rbenv init -)"
+elif [ -f /usr/local/rvm/scripts/rvm ]; then
+  source /etc/profile.d/rvm.sh
+elif [ -f "$HOME/.rvm/scripts/rvm" ]; then
+  source "$HOME/.rvm/scripts/rvm"
 fi
+
+app=$1; config=$2; log=$3;
+cd $app && exec bundle exec puma -C $config 2>&1 >> $log

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano3-puma
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Abdelkader Boudih
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-03-24 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -42,16 +42,22 @@ dependencies:
   name: puma
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '6.0'
 description: Puma integration for Capistrano 3
 email:
 - Terminale@gmail.com
@@ -68,20 +74,25 @@ files:
 - Rakefile
 - capistrano3-puma.gemspec
 - lib/capistrano/puma.rb
+- lib/capistrano/puma/daemon.rb
 - lib/capistrano/puma/jungle.rb
 - lib/capistrano/puma/monit.rb
 - lib/capistrano/puma/nginx.rb
+- lib/capistrano/puma/systemd.rb
 - lib/capistrano/puma/version.rb
 - lib/capistrano/puma/workers.rb
+- lib/capistrano/tasks/daemon.rake
 - lib/capistrano/tasks/jungle.rake
 - lib/capistrano/tasks/monit.rake
 - lib/capistrano/tasks/nginx.rake
 - lib/capistrano/tasks/puma.rake
+- lib/capistrano/tasks/systemd.rake
 - lib/capistrano/tasks/workers.rake
 - 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.service.erb
 - lib/capistrano/templates/puma_monit.conf.erb
 - lib/capistrano/templates/run-puma.erb
 - lib/capistrano3-puma.rb
@@ -107,9 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Puma integration for Capistrano
 test_files: []