mina-unicorn_systemd 0.0.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f61e026a1e150bdc56cc14d0c20871a9ac4ab39f6a519de09d3debd713e210ab
-  data.tar.gz: 8db9dc35c5a631ad6488feb2c8d301cd893a03f931824e01dc2be3861a699431
+  metadata.gz: 6123396e12d908365364a32d70b1bb5d124a93b5eae7a63ed07d6bd42cffb2e9
+  data.tar.gz: e5b0aa4b22c8bd93775a4776e83ec03a4f2307c9723a7dadfc919d3a73305897
 SHA512:
-  metadata.gz: 3467ec21d4ae700d9bbd2dda8ce6f5906ca0358e789693caab816a458bb465154b7a394f2b2f1a642566ebd122a38e7eae8e2996c79cab2e555233dfb14b0609
-  data.tar.gz: edb3c9611090d1dc8d09f4af1e5bd5ced4d206438e0f38a2439de90b1d4140a21ead936f1afdfa99236baa15dd9be98bf98f0964f318de953f5176b0afe8e137
+  metadata.gz: de663882a915c36815baa6fbbcc007b44e3fd3fcb0833166b9d53398b9ea7358b88110660de72504bc8de3dce31ba68ca51296c1a8998f26ff7505f942024254
+  data.tar.gz: 9a293f8c095a30c878f2ab0489d6feac95e1331b59faa4ef79da2895321a68e4696b65d9652d059e71e93ed25d5d18f196006252ec0ebd77848149ee493f47b9

data/README.md

@@ -9,7 +9,6 @@ This gem assumes that you
 * Are on a Linux system with systemd in /etc/systemd/
 * Are using RVM to manage your Ruby version
 * That the setup task has sudoer or root permissions or that you are running with execution_mode :system and are entering passwords. If your regular user does not have sudo, then you can set the `setup_user` to the name of a user who does.
-* Want to run nginx in front and that you want to update nginx configuration to point to unicorn instead.
 
 ## Basic installation instructions
 
@@ -32,14 +31,18 @@ require 'mina/nginx'
 require 'mina/unicorn'
 ```
 
-3. Manually run `'mina unicorn:setup'` or invoke from your own setup task.
+3. Manually run `'mina unicorn:setup'` or invoke from your own setup task to enable all one time tasks.
 
-4. Manually run `'mina unicorn:restart'` or invoke from your own deploy task.
+4. Once you are ready to enable unicorn run `'mina unicorn:enable'` to enable the systemd service (persists across reboots).
+
+5. To manually restart unicorn after a deploy use `'mina unicorn:restart'`.
 
 ## Customization
 
 To change the unicorn systemd service template and/or the `unicorn_conf.rb`, run `'mina unicorn:generate'`.
 
+By default `mina-unicorn_systemd` is running unicorn as a user service (`systemd --user`), but the unicorn service template also includes settings for running as a system service. To enable this, add `set :unicorn_system_or_user, 'system'` to the top of your `deploy.rb`.
+
 ## Contributing
 
 1. Fork it ( http://github.com/coezbek/mina-unicorn_systemd/fork )

data/lib/mina/templates/unicorn.service.erb

@@ -9,10 +9,11 @@ After=network.target
 [Service]
 Type=forking
 WorkingDirectory=/home/<%= application %>/app/
-
+<% if !is_unicorn_user_installation? %>
 <%# Use the defined user and fall back to the application name -%> 
-User=<%= fetch :user, application %> 
+User=<%= fetch :user, application %>
 
+<% end %>
 #
 # How to actually start Unicorn?
 #
@@ -40,4 +41,8 @@ RestartSec=1
 PIDFile=/home/<%= application %>/app/shared/unicorn.pid
 
 [Install]
-WantedBy=multi-user.target
+<% if is_unicorn_user_installation? %>
+WantedBy=default.target
+<% else %>
+WantedBy=multi-user.target
+<% end %>

data/lib/mina/unicorn.rb

@@ -6,7 +6,16 @@ require "mina/unicorn/version"
 namespace :unicorn do
   
   set :unicorn_service_name,        -> { "unicorn-#{fetch(:application_name)}.service" }
-  set :unicorn_systemd_config_path, -> { "/etc/systemd/system/#{fetch :unicorn_service_name}" }
+  
+  set :unicorn_system_or_user,      -> { "user" }
+
+  set :unicorn_systemd_config_path, -> {    
+    if is_unicorn_user_installation?
+      "$HOME/.config/systemd/user/#{fetch :unicorn_service_name}" 
+    else
+      "/etc/systemd/system/#{fetch :unicorn_service_name}"
+    end
+  }
   
   set :nginx_socket_path,           -> { "#{fetch(:shared_path)}/unicorn.sock" }
   
@@ -27,48 +36,70 @@ namespace :unicorn do
     end
   end
   
-  desc "Setup Unicorn systemd service on the remote server"
+  desc "Setup Unicorn systemd service on the remote server (but doesn't start it)"
   task :setup do
   
-    elevate
-  
-    comment %(Check for systemd on remote server)    
-    command %([[ `systemctl` =~ -\.mount ]] || { echo 'Systemd not found, but mina-unicorn_systemd needs it.'; exit 1; }) # From https://unix.stackexchange.com/a/164092
-    
+    # Fetch these before elevation!
+    username = fetch(:user)
     target_path = fetch :unicorn_systemd_config_path
+    template = erb template_path
+
+    unicorn_elevate do 
+      run :remote do 
+
+        comment %(Check for systemd on remote server)
+        command %([[ `systemctl` =~ -\.mount ]] || { echo 'Systemd not found, but mina-unicorn_systemd needs it.'; exit 1; }) # From https://unix.stackexchange.com/a/164092
+
+        if is_unicorn_user_installation?
+          comment %(Check for libpam on remote server)
+          command %(DEBIAN_FRONTEND=noninteractive apt -yqq install libpam-systemd)
+      
+          comment %(Enable linger for systemd --user)    
+          command %(loginctl enable-linger #{username} || { echo 'Could not enable linger for user #{username} but mina-unicorn_systemd needs it.'; exit 1; }) 
+        end  
+
+        comment %(Installing unicorn systemd config file to #{target_path})
+        command %(mkdir -p $(dirname #{target_path}))
+        command %(echo '#{template}' > #{target_path})
 
-    comment %(Installing unicorn systemd config file to #{target_path})
-    command %(echo '#{erb template_path}' > #{target_path})
+        comment %(Reloading systemd configuration)
+        command %(systemctl#{" --user" if is_unicorn_user_installation?} daemon-reload || { echo 'If this command fails in user mode then you likely have disabled UsePAM in your /etc/ssh/sshd_config which is needed'; exit 1; }) # https://superuser.com/a/1561345/32638
 
-    comment %(Reloading systemd configuration)
-    command %(systemctl daemon-reload)
+      end
+    end
     
   end
   
   desc "Get the status of the Unicorn systemd service on the remote server"
   task :status do
-    command %(systemctl status #{fetch :unicorn_service_name})
+    command command_systemd_raw("status")
   end
   
-  desc "Start the Unicorn systemd service on the remote server"
-  task :start do
-    elevate
-    # Start the service and if it fails print the error information
-    command %((systemctl start #{fetch :unicorn_service_name} && systemctl status #{fetch :unicorn_service_name}) || journalctl --no-pager _SYSTEMD_INVOCATION_ID=`systemctl show -p InvocationID --value #{fetch :unicorn_service_name}`)
-  end
-  
-  desc "Stop the Unicorn systemd service on the remote server"
-  task :stop do
-    elevate
-    command %((systemctl stop #{fetch :unicorn_service_name} && systemctl status #{fetch :unicorn_service_name}) || journalctl --no-pager _SYSTEMD_INVOCATION_ID=`systemctl show -p InvocationID --value #{fetch :unicorn_service_name}`)
-  end
-  
-  desc "Restart the Unicorn systemd service on the remote server"
-  task :restart do
-    elevate
-    command %((systemctl restart #{fetch :unicorn_service_name} && systemctl status #{fetch :unicorn_service_name}) || journalctl --no-pager _SYSTEMD_INVOCATION_ID=`systemctl show -p InvocationID --value #{fetch :unicorn_service_name}`)
-  end 
-  
+  %w(start stop restart enable disable).each { |verb| 
+    desc "#{verb.capitalize} the Unicorn systemd service on the remote server"
+    
+    task verb.to_sym do
+    
+      if is_unicorn_user_installation?
+        
+        run :remote do 
+          command_systemd verb
+        end
+
+      else
+        
+        unicorn_elevate do 
+          run :remote do 
+            command_systemd verb
+          end
+        end
+      
+      end
+    
+    end
+    
+  }
+    
   # Returns the path to the template to use. Depending on whether the internal template was customized.
   def template_path
   
@@ -77,14 +108,41 @@ namespace :unicorn do
     
     File.exist?(custom_path) ? custom_path : original_path
   end
+
+  def is_unicorn_user_installation?
+    case fetch(:unicorn_system_or_user)
+    when "user" 
+      true
+    when "system"
+      false
+    else
+      raise "Undefined unicorn_system_or_user value. Must be 'user' or 'system'."
+    end
+  end
+
+  def command_systemd_raw verb
+    return %(systemctl#{" --user" if is_unicorn_user_installation?} #{verb} #{fetch :unicorn_service_name})
+  end
+
+  # Execute the systemd verb action and if it fails print the error information
+  def command_systemd verb
+    c = %((#{command_systemd_raw(verb)} && #{command_systemd_raw("status")}) || journalctl #{" --user" if is_unicorn_user_installation?} --no-pager _SYSTEMD_INVOCATION_ID=`systemctl #{" --user" if is_unicorn_user_installation?} show -p InvocationID --value #{fetch :unicorn_service_name}`)
+
+    comment c
+    command c
+  end
   
-  def elevate 
-  
+  def unicorn_elevate 
+
     user = fetch(:user)
     setup_user = fetch(:setup_user, user)
-    if setup_user != user
+    if setup_user && setup_user != user
       comment %{Switching to setup_user (#{setup_user})}
       set :user, setup_user
+      yield
+      set :user, user
+    else
+      yield
     end
   
   end
@@ -99,7 +157,8 @@ namespace :unicorn do
   desc "Print current Unicorn systemd service config from remote"
   task :print_remote do
     unicorn_systemd_config_path = fetch :unicorn_systemd_config_path
-    command %(cat #{unicorn_systemd_config_path})
+    comment %(Printing content of #{unicorn_systemd_config_path} from remote server)
+    command %(cat #{unicorn_systemd_config_path} || echo "Hello")
   end
 
 end

data/lib/mina/unicorn/version.rb

@@ -1,5 +1,5 @@
 module Mina
   module Unicorn
-    VERSION = '0.0.1'.freeze
+    VERSION = '0.9.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mina-unicorn_systemd
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.9.0
 platform: ruby
 authors:
 - coezbek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2020-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mina