mina_maintenance 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30b72d4034c4eb6f181fb96df08913523461fb66
-  data.tar.gz: 23541e53f02dee948d4499e1537dbb00a4bf0dd3
+  metadata.gz: 5bcf6a54ab2e9163df6317274a20a65c34344a12
+  data.tar.gz: 6c39640c952523dd8cb3c40b7c29255e821d300e
 SHA512:
-  metadata.gz: 4434bcf20eda27d1c33d56cf5df4a256f28836a7b7b8cf7e505eb50771e995ee0601eaab93e7e2d6b2f63abe3fd5d121ca8693abc401f0a751ce65d27d267be5
-  data.tar.gz: 9e61d1b0168b8780eb09c1ae961ddd39a37b1d2eae592d276a104a855309aec4cf4517b5e44c1663c8f5bd95bfc0b0d646703171a1dc67a2aa959b559c705c25
+  metadata.gz: f919d4ea7dffc16c45b575735d57d6670d4273ed7f34d200487329fdab81b58fc32b635850fef9bed8fe34700237b41159ee75ac0a87f2446698991a705865fa
+  data.tar.gz: fd583317f8eb136f09b6fd9fb3dd38613573ea41afa47c324ef867492cdc03e28c9bbeee5f76f4785f9f6eacca961b3584d983962e894a0c8609b235f5fc337a

data/README.md

@@ -6,10 +6,56 @@ Maintenance Page Support For [Mina](http://nadarei.co/mina). Heavily inspired by
 ## Installation
 
     gem install mina_maintenance
-
-## Usage example
+    
+And require mina_maintenance tasks in your `deploy.rb` file:
 
     require 'mina_maintenance/tasks'
+    
+## Usage
+
+Before using the maintenance tasks, you need to configure your webserver. How you do this depends on how your server is configured, but the following examples should help you on your way.
+
+Application servers such as [Passenger](https://www.phusionpassenger.com) and [unicorn](http://unicorn.bogomips.org) requires you to set your public web directory to `current/public`. Both examples below are compatible with this setup.
+
+Here is an example config for **nginx**. Note that this is just a part of the complete config, and will probably require modifications.
+
+```
+error_page 503 @503;
+
+# Return a 503 error if the maintenance page exists.
+if (-f /var/www/domain.com/shared/public/system/maintenance.html) {
+  return 503;
+}
+
+location @503 {
+  # Serve static assets if found.
+  if (-f $request_filename) {
+    break;
+  }
+
+  # Set root to the shared directory.
+  root /var/www/domain.com/shared/public;
+  rewrite ^(.*)$ /system/maintenance.html break;
+}
+```
+
+And here is an example config for **Apache**. This will also need to be modified.
+
+```
+# Create an alias to the maintenance page used as error document.
+Alias "/error" "/var/www/domain.com/shared/public/system/"
+ErrorDocument 503 /error/maintenance.html
+
+# Return 503 error if the maintenance page exists.
+RewriteCond /var/www/domain.com/shared/public/system/maintenance.html -f
+RewriteRule !^/error/maintenance.html - [L,R=503]
+
+# Redirect all non-static requests to unicorn (or similar).
+# Will not redirect any requests if the maintenance page exists.
+RewriteCond /var/www/domain.com/shared/public/system/maintenance.html !-f
+RewriteCond %{DOCUMENT_ROOT}/%{REQUEST_FILENAME} !-f
+RewriteRule ^/(.*)$ balancer://unicornserver%{REQUEST_URI} [P,QSA,L]
+```
 
 ## Available Tasks
 

data/lib/mina_maintenance/tasks.rb

@@ -11,9 +11,9 @@ set_default :maintenance_template, File.join(File.expand_path('../templates', __
 set_default :maintenance_basename, 'maintenance'
 
 # ### maintenance_path
-# Sets a path to the server's mainenance file on server.
-# Default: /public/system/
-set_default :maintenance_path, '/public/system/'
+# Sets a path to the server's maintenance file on server.
+# Default: public/system
+set_default :maintenance_path, 'public/system'
 
 # ## Control Tasks
 namespace :maintenance do
@@ -24,7 +24,7 @@ namespace :maintenance do
     template = settings.maintenance_template
     result   = File.open(template).read
 
-    rendered_path = "#{deploy_to}/#{shared_path}/#{settings.maintenance_path}"
+    rendered_path = "#{deploy_to}/#{shared_path}/#{settings.maintenance_path}/"
     rendered_name = "#{settings.maintenance_basename}.html"
 
     queue %[
@@ -42,6 +42,6 @@ namespace :maintenance do
   task :off do
     queue %[echo "-----> Turning maintenance mode OFF"]
 
-    queue! %[rm -f #{deploy_to}/#{shared_path}/public/system/#{settings.maintenance_basename}.html]
+    queue! %[rm -f #{deploy_to}/#{shared_path}/#{settings.maintenance_path}/#{settings.maintenance_basename}.html]
   end
-end
+end

data/lib/mina_maintenance/version.rb

@@ -1,3 +1,3 @@
 module MinaMaintenance
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: mina_maintenance
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mike Bajur
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-08 00:00:00.000000000 Z
+date: 2015-02-09 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'
 description: Maintenance Page Support For Mina
@@ -31,7 +31,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -52,17 +52,17 @@ 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.0.14
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Maintenance Page Support For Mina