capistrano-cable 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6b994fb2900c73d5d4afe2a12e7a7432e2a53611fd37ad2ac4534031a3bbd65
-  data.tar.gz: bc7ee8750a36a2d613eaf7c9e8379da3d4d21cf5d69dffb40c5347eb0e8a8b07
+  metadata.gz: f72bb2750201ab8daf11827c5ebbbb6b95f876133ec9c41d0f84390a8a20f66e
+  data.tar.gz: 5279ffa62302ffb85b4b568c79243532fa66c950fb067bd23b73b318800602ec
 SHA512:
-  metadata.gz: 78ddf453aeeadee09e1bfe8418f7435fbc8565fdfbb9131f47b4e8d8a1d06f6f57f4245ee0cf0d8b77450aab013a8ab9f9b46e82095572843e961bfe701dc7d8
-  data.tar.gz: c094d0a7acda838ad3c219a29deee9226765213099a41a03d0176a98a75a0782ce6e57ae0f902904f4d71998abea30afea634a16d7e94a9a7645180790435f5b
+  metadata.gz: c5253f0c54f48c44f284be7a93497e40487af8585e4cd3fe27bb1cd45c9a67ced5cc84ce6fbf83495b7ce2e274e8bbbe28692205d582d9e1e9b43edd82455fd7
+  data.tar.gz: 931ab55287a48561c83d4c576c77caa5e8132da512807b276b9f563bf57ca1fb1d5de62eeb4a42ec78a0a3e3ea6c3c257c53b39feaa352ccb5d20fa91f701acf

data/README.md

@@ -1,6 +1,7 @@
 # Capistrano::Cable
 
 **Capistrano::Cable** helps to deploy standalone ActionCable server with Puma over `systemd`.
+It doesn't use a specific `puma.rb` for Puma configuration, it relies on given options.
 
 ## Installation
 
@@ -38,28 +39,29 @@ install_plugin Capistrano::Cable
 ```
 
 ### Config
+Many options are available to customize the cable server configuration. Here are the main ones:
 
 ```ruby
 # config/deploy.rb or config/deploy/<stage>.rb
 set :cable_role, :web
+set :cable_port, 29292
+# set :cable_ssl_certificate
+# set :cable_ssl_certificate_key
+set :cable_rackup_file, 'cable/config.ru'
+set :cable_dir, -> { File.join(release_path, "cable") }
+set :cable_pidfile, -> { File.join(shared_path, "tmp", "pids", "cable.pid") }
 set :cable_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
-set :cable_access_log, -> { File.join(shared_path, 'log', 'cable.log') }
-set :cable_error_log, -> { File.join(shared_path, 'log', 'cable.log') }
-
-set :cable_systemctl_bin, -> { fetch(:systemctl_bin, '/bin/systemctl') }
-set :cable_service_unit_name, -> { "#{fetch(:application)}_cable_#{fetch(:stage)}" }
-set :cable_enable_socket_service, false
-# set :cable_bind, ... # Example: ->{ "unix:/path/to/cable.sock" }
-
+set :cable_access_log, -> { File.join(shared_path, "log", "cable.access.log") }
+set :cable_error_log, -> { File.join(shared_path, "log", "cable.error.log") }
+set :cable_phased_restart, true
 set :cable_service_unit_env_files, -> { fetch(:service_unit_env_files, []) }
 set :cable_service_unit_env_vars, -> { fetch(:service_unit_env_vars, []) }
-
-set :cable_systemctl_user, -> { fetch(:systemctl_user, :user) }
-set :cable_enable_lingering, -> { fetch(:cable_systemctl_user) != :system }
-set :cable_lingering_user, -> { fetch(:lingering_user, fetch(:user)) }
-
-set :cable_service_templates_path, fetch(:service_templates_path, 'config/deploy/templates')
+set :cable_service_templates_path, fetch(:service_templates_path, "config/deploy/templates")
 ```
+See Capistrao::Cable::Systemd#set_defaults for more details.
+
+To enable SSL, set the `cable_ssl_certificate` and `cable_ssl_certificate_key` options.
+The both are required to enable SSL.
 
 ## Development
 

data/lib/capistrano/cable/systemd.rb

@@ -15,19 +15,13 @@ module Capistrano
       def set_defaults
         set_if_empty :cable_role, :web
         set_if_empty :cable_port, 29292
+        set_if_empty :cable_rackup_file, 'cable/config.ru'
         set_if_empty :cable_dir, -> { File.join(release_path, "cable") }
         set_if_empty :cable_pidfile, -> { File.join(shared_path, "tmp", "pids", "cable.pid") }
         set_if_empty :cable_env, -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
         set_if_empty :cable_access_log, -> { File.join(shared_path, "log", "cable.access.log") }
         set_if_empty :cable_error_log, -> { File.join(shared_path, "log", "cable.error.log") }
-
-        # Chruby, Rbenv and RVM integration
-        append :chruby_map_bins, "puma", "pumactl" if fetch(:chruby_map_bins)
-        append :rbenv_map_bins, "puma", "pumactl" if fetch(:rbenv_map_bins)
-        append :rvm_map_bins, "puma", "pumactl" if fetch(:rvm_map_bins)
-
-        # Bundler integration
-        append :bundle_bins, "puma", "pumactl"
+        set_if_empty :cable_phased_restart, true
 
         set_if_empty :cable_systemctl_bin, -> { fetch(:systemctl_bin, "/bin/systemctl") }
         set_if_empty :cable_service_unit_name, -> { "#{fetch(:application)}_cable_#{fetch(:stage)}" }
@@ -43,6 +37,14 @@ module Capistrano
         set_if_empty :cable_lingering_user, -> { fetch(:lingering_user, fetch(:user)) }
 
         set_if_empty :cable_service_templates_path, fetch(:service_templates_path, "config/deploy/templates")
+
+        # Chruby, Rbenv and RVM integration
+        append :chruby_map_bins, "puma", "pumactl" if fetch(:chruby_map_bins)
+        append :rbenv_map_bins, "puma", "pumactl" if fetch(:rbenv_map_bins)
+        append :rvm_map_bins, "puma", "pumactl" if fetch(:rvm_map_bins)
+
+        # Bundler integration
+        append :bundle_bins, "puma", "pumactl"
       end
 
       def expanded_bundle_command
@@ -118,13 +120,12 @@ module Capistrano
       def puma_options
         options = []
         options << "--no-config"
-        # options << "--dir #{fetch(:cable_dir)}" if fetch(:cable_dir) # or change WorkingDirectory in cable.service?
         if fetch(:cable_ssl_certificate) && fetch(:cable_ssl_certificate_key)
           options << "--bind 'ssl://0.0.0.0:#{fetch(:cable_port)}?key=#{fetch(:cable_ssl_certificate_key)}&cert=#{fetch(:cable_ssl_certificate)}'"
-          # Can use: &verify_mode=none&ca=...
+        else
+          options << "--port #{fetch(:cable_port)}"
         end
         options << "--environment #{fetch(:cable_env)}"
-        # options << "--port #{fetch(:cable_port)}"
         options << "--pidfile #{fetch(:cable_pidfile)}" if fetch(:cable_pidfile)
         options << "--threads #{fetch(:cable_threads)}" if fetch(:cable_threads)
         options << "--workers #{fetch(:cable_workers)}" if fetch(:cable_workers)

data/lib/capistrano/cable/version.rb

@@ -2,6 +2,6 @@
 
 module Capistrano
   module Cable
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

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

@@ -20,7 +20,7 @@ WatchdogSec=30
 <%="User=#{cable_user(@role)}" if fetch(:cable_systemctl_user) == :system %>
 <%="PIDFile=#{fetch(:cable_pidfile)}" if fetch(:cable_pidfile) %>
 WorkingDirectory=<%= current_path %>
-ExecStart=<%= expanded_bundle_command %> exec puma <%= puma_options %> cable/config.ru
+ExecStart=<%= expanded_bundle_command %> exec puma <%= puma_options %> <%= fetch(:cable_rackup_file) %>
 ExecReload=/bin/kill -USR1 $MAINPID
 Environment='RAILS_ENV=<%= fetch(:stage) %>'
 <% fetch(:default_env).reject{ |k, _| k.to_s == 'path' }.each do |variable, value| -%>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-cable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Brice TEXIER