mina-puma-nginx 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c5b99967e0d48cb5e9c99be0bd3447dccb029f1faac8b6cba2630edd2ecc58c
+  data.tar.gz: b65ac99351ac4adf51267ee4759709b3ec10dd5829e7a014024bec6b6ecf355d
+SHA512:
+  metadata.gz: df7ec3ad66a0174c7db9ecdadcaab80ebe48ad1cda024a09c34ba39623993243dbf34f9901ca372735d3bdee22182d39fbe27e5fecf618af9643e5fe7b2150da
+  data.tar.gz: 79fc2f58ba3ad30132a4260e6588b0e37694f6a7dee9d711031ac35265db9e7ff304fc941ce2e6a6bf08bcb64aa5b0ddb7ed2c45429c75af8a9fa145e1f8326f

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 hbin
+
+MIT License
+
+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,58 @@
+# Mina Nginx
+
+[Mina](https://github.com/nadarei/mina) tasks for handle with
+[Nginx](http://nginx.com/).
+
+This gem provides several mina tasks:
+
+    mina nginx:install  # Install template config to host repo for easy overrides
+    mina nginx:setup    # Install config file to the server's shared dir + symlink
+    mina nginx:print    # Parse & print the nginx config
+
+    mina nginx:reload   # Reload Nginx
+    mina nginx:restart  # Restart Nginx
+    mina nginx:start    # Start Nginx
+    mina nginx:status   # Status Nginx
+    mina nginx:stop     # Stop Nginx
+
+## Installation
+
+Add this line to your application's Gemfile, then `bundle install`:
+
+    gem 'mina-nginx', :require => false
+
+Once installed, add this to your `config/deploy.rb` file:
+
+    require 'mina/nginx'
+
+Install the base template to your repo's `lib/mina/templates` directory:
+
+    $ bundle exec mina nginx:install
+
+Consider variables used by the nginx config, particularly:
+
+* `application`       - application name; defaults to 'application'
+* `nginx_socket_path` - path to socket file used in nginx upstream directive
+* `server_name`       - application's nginx server_name (e.g. example.com); defaults to value for `domain`
+* `domain`            - fqdn you are deploying to
+* `deploy_to`         - deployment path
+* `current_path`      - current revision path
+
+Edit installed template as required.
+
+## Recommended Usage
+
+1. Follow install steps above; and
+2. Invoke `nginx:setup` in your main `setup` task
+3. Run `nginx:setup` (or base `setup`) to install config changes
+
+n.b. if the config template has not been installed locally, `mina-nginx` will
+fall back to the default template gracefully.
+
+## Contributing
+
+1. Fork it ( http://github.com/hbin/mina-nginx/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/mina/nginx/version.rb

@@ -0,0 +1,5 @@
+module Mina
+  module Nginx
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/mina/nginx.rb

@@ -0,0 +1,91 @@
+require 'mina/nginx/version'
+require "erb"
+
+namespace :nginx do
+  set :nginx_path,        '/etc/nginx'
+  set :nginx_socket_path, -> { "#{fetch(:shared_path)}/tmp/sockets/puma.sock" }
+  set :nginx_socket_flags, "fail_timeout=0"
+  set :nginx_config_unit, -> { "#{fetch(:application)}_#{fetch(:stage, fetch(:rails_env))}" }
+  set :nginx_config_name, -> { "#{fetch(:nginx_config_unit)}.conf" }
+
+  set :nginx_sites_available_path, -> { "#{fetch(:nginx_path)}/sites-available" }
+  set :nginx_sites_enabled_path,   -> { "#{fetch(:nginx_path)}/sites-enabled" }
+
+
+  set :nginx_config,      -> { "#{fetch(:nginx_sites_available_path)}/#{fetch(:nginx_config_name)}" }
+  set :nginx_config_e,    -> { "#{fetch(:nginx_sites_enabled_path)}/#{fetch(:nginx_config_name)}" }
+  set :nginx_use_ssl,             true
+  set :nginx_use_http2,           true
+  set :nginx_sts,                 true
+  set :nginx_ssl_stapling,        true
+  set :nginx_ssl_certificate,     nil
+  set :nginx_ssl_certificate_key, nil
+  set :nginx_ssl_dhparam,         nil
+
+
+
+  desc 'Install Nginx config to repo'
+  task :install do
+    run :local do
+      installed_path = path_for_template
+
+      if File.exist? installed_path
+        error! %(file exists; please rm to continue: #{installed_path})
+      else
+        command %(mkdir -p config/deploy/templates)
+        command %(cp #{nginx_template} #{installed_path})
+      end
+    end
+  end
+
+  desc 'Print nginx config in local terminal'
+  task :print do
+    puts processed_nginx_template
+  end
+
+  desc 'Setup Nginx on server'
+  task :setup do
+    nginx_config = fetch(:nginx_config)
+    nginx_enabled_config = fetch(:nginx_config_e)
+
+    comment %(Installing nginx config file to #{nginx_config})
+    command %(sudo echo -ne '#{escaped_nginx_template}' > #{nginx_config})
+
+    comment %(Symlinking nginx config file to #{nginx_enabled_config})
+    command %(sudo ln -nfs #{nginx_config} #{nginx_enabled_config})
+
+    invoke :'nginx:restart'
+  end
+
+  %w(stop start restart reload status).each do |action|
+    desc "#{action.capitalize} Nginx"
+    task action.to_sym do
+      comment %(#{action.capitalize} Nginx)
+      command "sudo service nginx #{action}"
+    end
+  end
+
+  private
+
+  def nginx_template
+    installed_path = path_for_template
+    template_path = path_for_template installed: false
+
+    File.exist?(installed_path) ? installed_path : template_path
+  end
+
+  def processed_nginx_template
+    erb = File.read(nginx_template)
+    ERB.new(erb, trim_mode: '-').result(binding)
+  end
+
+  def escaped_nginx_template
+    processed_nginx_template.gsub("\n","\\n").gsub("'","\\'")
+  end
+
+  def path_for_template installed: true
+    installed ?
+      File.expand_path('./config/deploy/templates/nginx.conf.erb') :
+      File.expand_path('../templates/nginx.conf.erb', __FILE__)
+  end
+end

data/lib/mina/templates/nginx.conf.erb

@@ -0,0 +1,99 @@
+upstream puma_<%= fetch(:nginx_config_unit) %> {
+  server unix:<%= fetch(:nginx_socket_path) %> <%= fetch(:nginx_socket_flags) %>;
+}
+<% if fetch(:nginx_use_ssl) -%>
+server {
+  listen 80;
+  server_name <%= fetch(:nginx_server_name) %>;
+  return 301 https://$host$1$request_uri;
+}
+<% end -%>
+
+server {
+<% if fetch(:nginx_use_ssl) -%>
+<% 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) %>;
+<% end -%>
+<% if fetch(:nginx_ssl_certificate_key) -%>
+  ssl_certificate_key <%= fetch(:nginx_ssl_certificate_key) %>;
+<% end -%>
+<% if fetch(:nginx_ssl_dhparam) -%>
+  ssl_dhparam <%= fetch(:nginx_ssl_dhparam) %>;
+<% end -%>
+<% if fetch(:nginx_sts) -%>
+  add_header Strict-Transport-Security max-age=15768000;
+<% end -%>
+<% if fetch(:nginx_ssl_stapling) -%>
+  ssl_stapling on;
+<% end -%>
+
+<% else -%>
+  listen 80;
+<% end -%>
+  server_name <%= fetch(:nginx_server_name) %>;
+  root <%= fetch(:current_path) %>/public;
+  try_files $uri/index.html $uri @puma_<%= fetch(:nginx_config_unit) %>;
+
+  client_max_body_size 4G;
+  keepalive_timeout 10;
+
+  error_page 500 502 504 /500.html;
+  error_page 503 @503;
+
+  location @puma_<%= fetch(:nginx_config_unit) %> {
+    proxy_http_version 1.1;
+    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+    proxy_set_header X-Forwarded-Proto $scheme;
+    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;
+    # custom
+    proxy_set_header X-Forwarded-Ssl on;
+<% else -%>
+  <% if fetch(:nginx_downstream_uses_ssl) -%>
+    proxy_set_header X-Forwarded-Proto https;
+  <% else -%>
+    proxy_set_header X-Forwarded-Proto http;
+  <% end -%>
+<% end -%>
+
+    # custom
+    proxy_set_header X-Forwarded-Port $server_port;
+    proxy_set_header X-Forwarded-Host $host;
+
+    proxy_pass http://puma_<%= fetch(:nginx_config_unit) %>;
+    # limit_req zone=one;
+    access_log /var/log/nginx/<%= fetch(:nginx_config_unit) %>.access.log;
+    error_log /var/log/nginx/<%= fetch(:nginx_config_unit) %>.error.log;
+  }
+
+  location ^~ /assets/ {
+    gzip_static on;
+    expires max;
+    add_header Cache-Control public;
+  }
+
+  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;
+  }
+}

data/mina-puma-nginx.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mina/nginx/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mina-puma-nginx'
+  spec.version       = Mina::Nginx::VERSION
+  spec.authors       = ['Vladimir Elchinov']
+  spec.email         = ['elik@elik.ru']
+  spec.summary       = %(Mina tasks for handle with Nginx.)
+  spec.description   = %(Configuration and managements Mina tasks for Nginx.)
+  spec.homepage      = 'https://github.com/railsblueprint/mina-puma-nginx.git'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mina'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 0'
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: mina-puma-nginx
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladimir Elchinov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mina
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Configuration and managements Mina tasks for Nginx.
+email:
+- elik@elik.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mina/nginx.rb
+- lib/mina/nginx/version.rb
+- lib/mina/templates/nginx.conf.erb
+- mina-puma-nginx.gemspec
+homepage: https://github.com/railsblueprint/mina-puma-nginx.git
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Mina tasks for handle with Nginx.
+test_files: []