Turnout makes it easy to put Rack apps into maintenance mode
Turnout makes it easy to put Rack apps into maintenance mode
Turnout is Rack middleware with a Ruby on Rails engine that allows you to easily put your app in maintenance mode.
In your Gemfile add:
gem 'turnout'then run
bundle installNote that you'll need to restart your Rails server before it will work
In your Sinatra app file
require 'rack/turnout'
class App < Sinatra::Base
configure do
use Rack::TurnoutIn your Rakefile
require 'turnout/rake_tasks'rake maintenance:startor
rake maintenance:start reason="Somebody googled Google!"or
rake maintenance:start allowed_paths="/login,^/faqs/[0-9]*"or
rake maintenance:start allowed_ips="4.8.15.16"or
rake maintenance:start reason="Someone told me I should type sudo rm -rf /" allowed_paths="^/help,^/contact_us" allowed_ips="127.0.0.1,192.168.0.0/24"or if you've configured named_maintenance_file_paths with a path named server
rake maintenance:server:startreason parameter can contain HTMLallowed_paths and allowed_ips can be given. Just comma separate them.allowed_paths are treated as regular expressions.allowed_paths regular expression just escape it with a backslash: \,.allowed_ips using CIDR notation.rake maintenance:endor if you activated with a named path like server
rake maintenance:server:endTurnout can be configured in two different ways:
Pass a config hash to the middleware
use Rack::Turnout,
app_root: '/some/path',
named_maintenance_file_paths: {app: 'tmp/app.yml', server: '/tmp/server.yml'},
maintenance_pages_path: 'app/views/maintenance',
default_maintenance_page: Turnout::MaintenancePage::JSON,
default_reason: 'Somebody googled Google!',
default_allowed_paths: ['^/admin/'],
default_response_code: 418,
default_retry_after: 3600Using a config block
Turnout.configure do |config|
config.skip_middleware = true
config.app_root = '/some/path'
config.named_maintenance_file_paths = {app: 'tmp/app.yml', server: '/tmp/server.yml'}
config.maintenance_pages_path = 'app/views/maintenance'
config.default_maintenance_page = Turnout::MaintenancePage::JSON
config.default_reason = 'Somebody googled Google!'
config.default_allowed_paths = ['^/admin/']
config.default_response_code = 418
config.default_retry_after = 3600
endNOTICE: Any custom configuration should be loaded not only in the app but in the rake task. This should happen automatically in Rails as the environment task is run if it exists. But you may want to create your own environment task in non-Rails apps.
Turnout.configure do |config|
config.app_root = '.'
config.named_maintenance_file_paths = {default: config.app_root.join('tmp', 'maintenance.yml').to_s}
config.maintenance_pages_path = config.app_root.join('public').to_s
config.default_maintenance_page = Turnout::MaintenancePage::HTML
config.default_reason = "The site is temporarily down for maintenance.\nPlease check back soon."
config.default_allowed_paths = []
config.default_response_code = 503
config.default_retry_after = 7200
endDefault maintenance pages are provided, but you can create your own public/maintenance.[html|json|html.erb] files instead. If you provide a reason to the rake task, Turnout will parse the maintenance page file and attempt to replace a Liquid-style {{ reason }} tag with the provided reason. So be sure to include a {{ reason }} tag in your maintenance.html file. In the case of a .html.erb file, reason will be a local variable.
WARNING:
The source code of any custom maintenance files you created in the /public directory will be able to be viewed by visiting that URL directly (i.e. http://example.com/maintenance.html.erb). This shouldn't be an issue with HTML and JSON files but with ERB files, it could be. If you're going to use a custom .erb.html file, we recommend you change the maintenance_pages_path setting to something other than the /public directory.
There is no denied_paths feature because turnout denies everything by default.
However you can achieve the same sort of functionality by using
negative lookaheads with the allowed_paths setting, like so:
rake maintenance:start allowed_paths="^(?!/your/under/maintenance/path)"A central named_maintenance_file_path can be configured in all your apps such as /tmp/turnout.yml so that all apps on a server can be put into mainteance mode at once. You could even configure service based paths such as /tmp/mongodb_maintenance.yml so that all apps using MongoDB could be put into maintenance mode.
If you'd like to detect if maintenance mode is on in your app (for those users or pages that aren't blocked) just call !Turnout::MaintenanceFile.find.nil?.
On every request the Rack app will check to see if tmp/maintenance.yml exists. If the file exists the maintenance page will be shown (unless allowed IPs are given and the requester is in the allowed range).
So if you want to get the maintenance page up or down in a hurry touch tmp/maintenance.yml and rm tmp/maintenance.yml will work.
Turnout will attempt to parse the maintenance.yml file looking for reason, allowed_ip and other settings. The file is checked on every request so you can change these values manually or just rerun the rake maintenance:start command.
---
reason: Someone told me I should type sudo rm -rf /
allowed_paths:
- ^/help
- ^/contact_us
allowed_ips:
- 127.0.0.1
- 192.168.0.0/24
response_code: 503
retry_after: 3600No open issues yet, or sync has not completed.