capistrano-simple-nginx 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a9ac6aadc4c603895f54113c81c07eda319dfa84
+  data.tar.gz: 05f828e9a45cadd79f04651acb3d459803eef407
+SHA512:
+  metadata.gz: 87f3c6256b086415f50c9467b6f3bc4354a9ad22f3c02c743d6c7b155f36f083be45a78c0e356b97ab0f511c65784a26011f91e03348125eb7d09e63dc266b81
+  data.tar.gz: b2c42cc8a15850231e5f067d8c5434d344cd01c93bcb23b982648de2bbc3daf1f2ae358ad0ac84711d0f995b30abef0da28ba88ee3f7fe024748bd58e8342e4c

data/Gemfile

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

data/README.md

@@ -0,0 +1,59 @@
+# Capistrano::SimpleNginx
+Support for Capistrano 3.x
+
+## Installlation
+
+Add this line to your application's `Gemfile`:
+```
+gem 'capistrano'
+gem 'capistrano-simple-nginx', '~> 0.0.1'
+```
+
+And then run:
+```
+$ bundle
+```
+Or install it yourself as:
+```
+$ gem install capistrano-simple-nginx
+```
+
+## Usage
+
+Require in `Capfile`:
+```
+require 'capistrano/simple-nginx'
+```
+
+* Generate file config nginx, run:
+```
+$ cap production nginx:setup
+```
+
+* start|stop|restart nginx, run:
+```
+$ cap production nginx:start
+$ cap production nginx:stop
+$ cap production nginx:restart
+```
+
+You need add directory to sock file of app. Example using unicorn for app:
+```
+# in config/deploy.rb
+set :nginx_upstream_file, "/tmp/unicorn.sock"
+```
+
+## Default config
+
+```
+    set :nginx_listen_port, 80 #listen_port
+    set :nginx_server_name, "_" #server_name
+    set :nginx_upstream_name, -> { "#{fetch(:application)}" } # upstream name
+    set :nginx_config_name, -> { "#{fetch(:application)}_#{fetch(:stage)}" } #file name config
+    set :nginx_fail_timeout, 0
+    set :nginx_access_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.access.log" } # access log file
+    set :nginx_error_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.error.log" } # error log file
+    set :nginx_upstream_file, -> { "/tmp/#{fetch(:application)}.sock" } # .sock file path
+```
+
+

data/Rakefile

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

data/capistrano-simple-nginx.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = "capistrano-simple-nginx"
+  s.version       = "0.0.1"
+  s.date          = "2018-07-23"
+  s.summary       = "Capistrano tasks for automatic nginx configuration"
+  s.description   = <<-EOF.gsub(/^\s+/, '')
+    Capistrano tasks for automatic nginx configuration
+    Work *only* with Capistrano 3+
+  EOF
+  s.authors       = ["truongkma"]
+  s.email         = "nd.truong1902@gmail.com"
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+  s.homepage      = "https://github.com/truongkma/capistrano-simple-nginx"
+  s.license       = "MIT"
+
+  s.add_runtime_dependency "capistrano", "~> 3.1"
+  s.add_runtime_dependency "sshkit", "~> 1.2"
+
+  s.add_development_dependency "rake", "~> 0"
+end

data/lib/capistrano/simple_nginx.rb

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

data/lib/capistrano/simple_nginx/helpers.rb

@@ -0,0 +1,44 @@
+require 'erb'
+
+module Capistrano
+  module SimpleNginx
+    module Helpers
+      def template template_name
+        StringIO.new(template_to_s(template_name))
+      end
+
+      def template_to_s template_name
+        config_file = File.join(File.dirname(__FILE__), "../../templates/#{template_name}")
+        ERB.new(File.read(config_file), nil, '-').result(binding)
+      end
+
+      def sudo_upload! from, to
+        filename = File.basename(to)
+        to_dir = File.dirname(to)
+        tmp_file = "/tmp/#{filename}"
+        upload! from, tmp_file
+        sudo :mv, tmp_file, to_dir
+      end
+
+      def file_exists? path
+        test "[ -e #{path} ]"
+      end
+
+      def deploy_user
+        capture :id, '-un'
+      end
+
+      def os_is_ubuntu?
+        capture(:cat, "/etc/*-release").include? "ubuntu"
+      end
+
+      def nginx_config_file
+        if os_is_ubuntu?
+          "/etc/nginx/sites-available/#{fetch(:nginx_config_name)}.conf"
+        else
+          "/etc/nginx/conf.d/#{fetch(:nginx_config_name)}.conf"
+        end
+      end
+    end
+  end
+end

data/lib/capistrano/tasks/nginx.rake

@@ -0,0 +1,35 @@
+require 'capistrano/simple_nginx/helpers'
+include Capistrano::SimpleNginx::Helpers
+
+namespace :load do
+  task :defaults do
+    set :nginx_listen_port, 80
+    set :nginx_server_name, "_"
+    set :nginx_upstream_name, -> { "#{fetch(:application)}" }
+    set :nginx_config_name, -> { "#{fetch(:application)}_#{fetch(:stage)}" }
+    set :nginx_fail_timeout, 0
+    set :nginx_access_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.access.log" }
+    set :nginx_error_log_file, -> { "/var/log/nginx/#{fetch(:nginx_config_name)}.error.log" }
+    set :nginx_upstream_file, -> { "/tmp/#{fetch(:application)}.sock" }
+  end
+end
+
+namespace :nginx do
+  desc 'Setup nginx configuration'
+  task :setup do
+    on roles :web do
+      unless file_exists?(nginx_config_file)
+        sudo_upload! template('nginx_conf.erb'), nginx_config_file
+      end
+    end
+  end
+
+  %w[stop start restart reload].each do |action|
+    desc "#{action} nginx"
+    task action do
+      on roles :web do
+        sudo :service, "nginx", action
+      end
+    end
+  end
+end

data/lib/templates/nginx_conf.erb

@@ -0,0 +1,57 @@
+upstream <%= fetch(:nginx_upstream_name) %> {
+  server unix:<%= fetch(:nginx_upstream_file) %> fail_timeout=<%= fetch(:nginx_fail_timeout) %>;
+}
+
+server {
+    server_tokens off;
+    add_header X-Content-Type-Options nosniff;
+    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 @<%= fetch(:nginx_upstream_name) %>;
+
+    location @<%= fetch(:nginx_upstream_name) %> {
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header Host $http_host;
+        proxy_redirect off;
+        proxy_pass http://<%= fetch(:nginx_upstream_name) %>;
+
+        access_log <%= fetch(:nginx_access_log_file) %>;
+        error_log <%= fetch(:nginx_error_log_file) %>;
+    }
+
+    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|PATCH|POST|DELETE|OPTIONS)$ ){
+        return 405;
+    }
+
+    if (-f $document_root/system/maintenance.html) {
+        return 503;
+    }
+}

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-simple-nginx
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- truongkma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-07-23 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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 tasks for automatic nginx configuration
+  Work *only* with Capistrano 3+
+email: nd.truong1902@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- capistrano-simple-nginx.gemspec
+- lib/capistrano-simple-nginx.rb
+- lib/capistrano/simple_nginx.rb
+- lib/capistrano/simple_nginx/helpers.rb
+- lib/capistrano/tasks/nginx.rake
+- lib/templates/nginx_conf.erb
+homepage: https://github.com/truongkma/capistrano-simple-nginx
+licenses:
+- MIT
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Capistrano tasks for automatic nginx configuration
+test_files: []