Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Detect and show a maintenance page

branch: master
README.rdoc

rack-maintenance

Rack::Maintenance is a simple Rack middleware to detect the existence of a maintenance page and display that instead of incoming requests.

Installation

sudo gem install rack-maintenance

Installation with Bundler

In Gemfile:

gem 'rack-maintenance'

and then run `bundle`.

Usage

# html maintenance response
config.middleware.use 'Rack::Maintenance',
  :file => Rails.root.join('public', 'maintenance.html'),
  :env  => 'MAINTENANCE'

# json maintenance response
# it's up to you to provide a valid JSON file!
config.middleware.use 'Rack::Maintenance',
  :file => Rails.root.join('public', 'maintenance.json'),
  :env  => 'MAINTENANCE'

If :env is 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.

  • Make your feature addition or bug fix in a branch.

  • Add tests for it.

  • Commit, do not mess with Rakefile or VERSION (do that in a separate commit if you want a local version)

  • Push your branch.

  • Send me a pull request.

License

BSD. See LICENSE for details.

Something went wrong with that request. Please try again.