Monzenbarai

Monzenbarai is simple Rack middleware that allows you to easily put your app in maintenance mode.

Add this line to your application's Gemfile:

gem 'monzenbarai'

And then execute:

$ bundle

Or install it yourself as:

$ gem install monzenbarai

Make config file.

Monzenbarai.configure do |config|
  config.expel = lambda do |env|
    return false if env['PATH_INFO'] == '/allowed'
    true
  end
  
  config.trigger_file = 'path/to/trigger_file'
end

If expel block returns true, Monzenbarai renders maintenance page.
By default, expel always returns only true.

env argument is Rack environment.

Add Monzenbarai middleware

use Monzenbarai # Sinatra
config.middleware.use Monzenbarai # Rails

Execute monzenbarai start path/to/config_file command.
This command makes trigger_file. Monzenbarai keep maintenance mode during trigger_file exists.

Execute monzenbarai end path/to/config_file command. This command removes trigger_file.

Bug reports and pull requests are welcome on GitHub at https://github.com/takuan-oishii/monzenbarai.
This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

The gem is available as open source under the terms of the MIT License.