capistrano-passenger5-nginx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fe28665d633a045a29d5147385c5cf8c44ac083
+  data.tar.gz: 73b5253dcd355d3b12ada43be3a0b15f8de0b6fc
+SHA512:
+  metadata.gz: a46a236c69ec8353bad25974ff2d294782c2e231c6fb8dca918d19c4bf58fe84372a09951c1fa3b1fd13b5c9fde88e6f0b808b5d53c5644d2039242a2d0f978e
+  data.tar.gz: 05bb460e973dd5b87f20cbae5a2e594052afbe6b49ad070f7aca3960e5e7784e7e8d763990fbe02d60cf0e6d7763874a00d0f9cefb69401caa7874b5bd9caac3

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/vendor/ruby
+.idea

data/CHANGELOG.md

@@ -0,0 +1 @@
+# Changelog

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright © 2015 Standout AB
+Copyright (c) 2014 Bruno Sutic
+
+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,84 @@
+# Capistrano Passenger 5 and Nginx
+
+This gem intends to ease the deployment of Rails apps with capistrano to passenger5 and nginx setup.
+
+Warning: It is only tested with Capistrano 3 and some parts of the gem might be specific to our own usage (live `rbenv`). You are welcome to change it or send pull requests.
+
+
+### What it does?
+
+* Deploy Rails apps to passenger 5 and Nginx combination on Server.
+* Ability to generate and upload a default Nginx configuration file for the application
+
+
+# How to use
+
+## Gemfile
+
+Add this to `Gemfile`:
+
+    group :development do
+      gem "capistrano", "~> 3.3"
+      gem 'capistrano-rbenv', '~> 2.0'
+      gem 'capistrano-passenger5-nginx' , :git => 'https://github.com/standout/capistrano-passenger5-nginx.git'
+    end
+
+And then:
+
+    $ bundle
+
+## Capfile
+
+Add this to your `Capfile`
+
+
+    require 'capistrano/passenger5_nginx'
+
+
+## Setup and usage
+
+    rails g capistrano:passenger5_nginx:config
+
+Above command will generate the default nginx config file in your project which will be at living at `/config/deploy/templates/nginx_conf.erb`
+
+Warning: Below line is commented out in `nginx_conf.rb` file, if your ruby version is different than the version passenger5 uses, then uncomment this line and change the path with the one one your application should use.
+
+`# passenger_ruby /your/ruby/version/path/2.2.0/bin/ruby;`
+
+## Default log file directories
+
+Nginx will be logging everything to `/opt/nginx/log/` directory
+
+## Configuration
+
+There are some flags that should be added to your production/staging.rb
+
+These are:
+* rails_env
+* nginx_server_name
+* nginx_use_ssl (true|false)
+* passenger_min_instances  (if you want to have more than one instances running your app, default 1)
+
+Here is an example for production.rb
+
+	set :nginx_server_name, 'app.example.com'
+	set :nginx_use_ssl, true
+	set :rails_env, 'production'
+	set :passenger_min_instances, 2
+
+
+## After deploy
+
+Run the command below for uploading the nginx configuration and reloading the nginx for the first time deploy. This config file is not uploaded after each deploy so should be done manually.
+
+`bundle exec cap production nginx:setup bundle exec cap production nginx:reload`
+
+### Thanks
+
+[@kalys](https://github.com/kalys) - for his
+[capistrano-nginx-unicorn](https://github.com/kalys/capistrano-nginx-unicorn)
+plugin.
+
+[@bruno-](https://github.com/bruno-) - for his
+[capistrano-unicorn-nginx](https://github.com/capistrano-plugins/capistrano-unicorn-nginx)
+plugin.

data/Rakefile

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

data/capistrano-passenger5-nginx.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/passenger5_nginx/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "capistrano-passenger5-nginx"
+  gem.version       = Capistrano::Passenger5Nginx::VERSION
+  gem.authors       = ["Hüseyin Öztürk"]
+  gem.email         = ["support@standout.se"]
+  gem.description   = "Capistrano meets passenger 5"
+  gem.summary       = "Capistrano deploys to Passenger 5 + nginx configuraion"
+  gem.homepage      = "https://github.com/standout/capistrano-passenger5-nginx"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "capistrano", ">= 3.1"
+  gem.add_dependency "sshkit", ">= 1.2.0"
+
+  gem.add_development_dependency "rake"
+end

data/lib/capistrano/dsl/nginx_paths.rb

@@ -0,0 +1,49 @@
+module Capistrano
+  module DSL
+    module NginxPaths
+
+      def nginx_sites_available_file
+        "#{fetch(:nginx_location)}/sites-available/#{fetch(:nginx_config_name)}"
+      end
+
+      def nginx_sites_enabled_file
+        "#{fetch(:nginx_location)}/sites-enabled/#{fetch(:nginx_config_name)}"
+      end
+
+      def nginx_service_path
+        '/etc/init.d/nginx'
+      end
+
+      def nginx_default_pid_file
+        '/opt/nginx/logs/nginx.pid'
+      end
+
+      # ssl related files
+      def nginx_default_ssl_cert_file_name
+        "#{fetch(:nginx_server_name)}.crt"
+      end
+
+      def nginx_default_ssl_cert_key_file_name
+        "#{fetch(:nginx_server_name)}.key"
+      end
+
+      def nginx_ssl_cert_file
+        "/etc/ssl/certs/#{fetch(:nginx_ssl_cert)}"
+      end
+
+      def nginx_ssl_cert_key_file
+        "/etc/ssl/private/#{fetch(:nginx_ssl_cert_key)}"
+      end
+
+      # log files
+      def nginx_access_log_file
+        "/opt/nginx/access.log"
+      end
+
+      def nginx_error_log_file
+        "/opt/nginx/error.log"
+      end
+
+    end
+  end
+end

data/lib/capistrano/passenger5_nginx.rb

@@ -0,0 +1,2 @@
+require 'capistrano/dsl/nginx_paths'
+load File.expand_path("../tasks/nginx.rake", __FILE__)

data/lib/capistrano/passenger5_nginx/helpers.rb

@@ -0,0 +1,54 @@
+require 'erb'
+
+module Capistrano
+  module Passenger5Nginx
+    module Helpers
+
+      # renders the ERB template specified by template_name to string. Use the locals variable to pass locals to the
+      # ERB template
+      def template_to_s(template_name, locals = {})
+        config_file = "#{fetch(:templates_path)}/#{template_name}"
+        # if no customized file, proceed with default
+        unless File.exists?(config_file)
+          config_file = File.join(File.dirname(__FILE__), "../../generators/capistrano/passenger5_nginx/templates/#{template_name}")
+        end
+
+        ERB.new(File.read(config_file)).result(ERBNamespace.new(locals).get_binding)
+      end
+
+      # renders the ERB template specified by template_name to a StringIO buffer
+      def template(template_name, locals = {})
+        StringIO.new(template_to_s(template_name, locals))
+      end
+
+      def file_exists?(path)
+        test "[ -e #{path} ]"
+      end
+
+      def deploy_user
+        capture :id, '-un'
+      end
+
+      def sudo_upload!(from, to)
+        filename = File.basename(to)
+        to_dir = File.dirname(to)
+        tmp_file = "#{fetch(:tmp_dir)}/#{filename}"
+        upload! from, tmp_file
+        sudo :mv, tmp_file, to_dir
+      end
+
+      # Helper class to pass local variables to an ERB template
+      class ERBNamespace
+        def initialize(hash)
+          hash.each do |key, value|
+            singleton_class.send(:define_method, key) { value }
+          end
+        end
+
+        def get_binding
+          binding
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/passenger5_nginx/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Passenger5Nginx
+    VERSION = "0.0.1"
+  end
+end

data/lib/capistrano/tasks/nginx.rake

@@ -0,0 +1,80 @@
+require 'capistrano/dsl/nginx_paths'
+require 'capistrano/passenger5_nginx/helpers'
+
+include Capistrano::Passenger5Nginx::Helpers
+include Capistrano::DSL::NginxPaths
+
+namespace :load do
+  task :defaults do
+    set :templates_path, 'config/deploy/templates'
+    set :nginx_config_name, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
+    set :nginx_pid, nginx_default_pid_file
+    # set :nginx_server_name # default set in the `nginx:defaults` task
+    # ssl options
+    set :nginx_location, '/opt/nginx'
+    set :nginx_use_ssl, false
+    set :nginx_use_spdy, false
+    # if true, passes the SSL client certificate to the application server for consumption in Ruby code
+    set :nginx_pass_ssl_client_cert, false
+    set :nginx_ssl_cert, -> { nginx_default_ssl_cert_file_name }
+    set :nginx_ssl_cert_key, -> { nginx_default_ssl_cert_key_file_name }
+    set :nginx_upload_local_cert, true
+    set :nginx_ssl_cert_local_path, -> { ask(:nginx_ssl_cert_local_path, 'Local path to ssl certificate: ') }
+    set :nginx_ssl_cert_key_local_path, -> { ask(:nginx_ssl_cert_key_local_path, 'Local path to ssl certificate key: ') }
+    set :nginx_fail_timeout, 0 # see http://nginx.org/en/docs/http/ngx_http_upstream_module.html#fail_timeout
+
+    set :linked_dirs, fetch(:linked_dirs, []).push('log')
+  end
+end
+
+namespace :nginx do
+
+  task :defaults do
+    on roles :web do
+      set :nginx_server_name, fetch(:nginx_server_name, host.to_s)
+    end
+  end
+
+  desc 'Setup nginx configuration'
+  task :setup do
+    on roles :web do
+      sudo_upload! template('nginx_conf.erb'), nginx_sites_available_file
+      sudo :ln, '-fs', nginx_sites_available_file, nginx_sites_enabled_file
+    end
+  end
+
+  desc 'Setup nginx ssl certs'
+  task :setup_ssl do
+    next unless fetch(:nginx_use_ssl)
+    on roles :web do
+      next if file_exists?(nginx_ssl_cert_file) && file_exists?(nginx_ssl_cert_key_file)
+      if fetch(:nginx_upload_local_cert)
+        sudo_upload! fetch(:nginx_ssl_cert_local_path), nginx_ssl_cert_file
+        sudo_upload! fetch(:nginx_ssl_cert_key_local_path), nginx_ssl_cert_key_file
+      end
+      sudo :chown, 'root:root', nginx_ssl_cert_file
+      sudo :chown, 'root:root', nginx_ssl_cert_key_file
+    end
+  end
+
+  desc 'Reload nginx configuration'
+  task :reload do
+    on roles :web do
+      sudo nginx_service_path, 'reload'
+    end
+  end
+
+  before :setup, :defaults
+  before :setup_ssl, :defaults
+
+end
+
+namespace :deploy do
+  after :publishing, 'nginx:reload'
+end
+
+desc 'Server setup tasks'
+task :setup do
+  invoke 'nginx:setup'
+  invoke 'nginx:setup_ssl'
+end

data/lib/generators/capistrano/passenger5_nginx/USAGE.md

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

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

@@ -0,0 +1,17 @@
+module Capistrano
+  module Passenger5Nginx
+    module Generators
+      class ConfigGenerator < Rails::Generators::Base
+        desc "Create local nginx and passenger 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 "nginx_conf.erb", "#{templates_path}/nginx_conf.erb"
+        end
+      end
+    end
+  end
+end

data/lib/generators/capistrano/passenger5_nginx/templates/nginx_conf.erb

@@ -0,0 +1,76 @@
+<% if fetch(:nginx_use_ssl) %>
+server {
+  listen 80;
+  server_name <%= fetch(:nginx_server_name) %>;
+  return 301 https://$server_name$request_uri;
+}
+<% end %>
+
+server {
+  <% if fetch(:nginx_use_ssl) %>
+  listen 443;
+  charset UTF-8;
+  ssl on;
+  ssl_certificate <%= current_path %>/config/ssl/server.crt;
+  ssl_certificate_key <%= current_path %>/config/ssl/server.key;
+  <% else %>
+  listen 80;
+  <% end %>
+  server_name <%= fetch(:nginx_server_name) %>;
+
+  # passenger_ruby /your/ruby/version/path/2.2.0/bin/ruby;
+  passenger_enabled on;
+  passenger_app_env <%= fetch(:rails_env) %>;
+
+  <% if fetch(:passenger_min_instances) %>
+  passenger_min_instances <%= fetch(:passenger_min_instances) %>;
+  <% end %>
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+  error_page 500 502 504 /500.html;
+  error_page 503 @503;
+
+  root <%= current_path %>/public;
+
+
+  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)$ {
+    return 405;
+  }
+}
+<% if fetch(:nginx_use_ssl) %>
+passenger_pre_start https://<%=fetch(:nginx_server_name)%>:443;
+<% else %>
+passenger_pre_start http://<%=fetch(:nginx_server_name)%>;
+<% end %>

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-passenger5-nginx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hüseyin Öztürk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: sshkit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.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: Capistrano meets passenger 5
+email:
+- support@standout.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- capistrano-passenger5-nginx.gemspec
+- lib/capistrano-passenger5-nginx.rb
+- lib/capistrano/dsl/nginx_paths.rb
+- lib/capistrano/passenger5_nginx.rb
+- lib/capistrano/passenger5_nginx/helpers.rb
+- lib/capistrano/passenger5_nginx/version.rb
+- lib/capistrano/tasks/nginx.rake
+- lib/generators/capistrano/passenger5_nginx/USAGE.md
+- lib/generators/capistrano/passenger5_nginx/config_generator.rb
+- lib/generators/capistrano/passenger5_nginx/templates/nginx_conf.erb
+homepage: https://github.com/standout/capistrano-passenger5-nginx
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Capistrano deploys to Passenger 5 + nginx configuraion
+test_files: []