Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

docs

  • Loading branch information...
commit 635355e7febd99508b91f6cc049f8fdabec9de03 1 parent 4cd1cd7
David Dollar authored
Showing with 11 additions and 0 deletions.
  1. +11 −0 README.rdoc
11 README.rdoc
View
@@ -7,6 +7,17 @@ maintenance.html page and display that instead of incoming requests.
sudo gem install rack-maintenance
+== Usage
+
+ # config/environment.rb
+ config.middleware.use 'Rack::Maintenance',
+ :file => Rails.root.join('public', 'maintenance.html'),
+ :env => 'MAINTENANCE'
+
+The `:env` is optional. If specified, all requests will be shown the
+maintenance page if the environment variable is set. If `:env` is not
+specified, the maintenance page will be shown if it exists.
+
== Note on Patches/Pull Requests
* Fork the project.
Please sign in to comment.
Something went wrong with that request. Please try again.