Maintenance Mode

From FIA Wiki
Jump to: navigation, search

Saved from

Same of Nginx and Puma: Nginx (and Puma behind) maintenance mode for Rack/Rails applications with Capistrano

There is a time, when we need to switch our apps into maintenance mode. Maybe it is because of some data processing stuff, maybe because of backups, Capistrano or whatever good reason you might have. To be honest it doesn’t matter why. What does matter, is how we should handle working users of our apps. Of course all the downtimes should take place when there is the smallest amount of users online. In most cases it might be a good idea to switch application off in the middle of the night (or on Sunday, etc.), but this won’t solve our primary problem: what should we show users that are already online?

The worst scenario ever would be showing them nothing (for example by shutting down whole application server). Users probably will think, that something bad happened. Much better idea is to show users a maintenance page with some sort of information like “Temporary down for maintenance”. It would be even better, it such a page would automatically show when needed.

To do so, we can use Apache Mod Rewrite module and a static 503.html page.

Mod Rewrite for Maintenance mode detection How to determine if we are in maintenance mode? Let’s check if maintenance.txt file exists in tmp/ dir of our app:

 RewriteCond %{DOCUMENT_ROOT}/../tmp/maintenance.txt !-f
 When it exists, we need to redirect user to our 503.html static page:
 RewriteRule ^(.*)$ /503.html [NC,R,L]

Of course the whole .htaccess should include also enabling RewriteEngine, ignoring redirects of CSS files and redirecting from 503.html to root, when the maintenance is off:

 RewriteEngine On
 # Set error 503 static page
 ErrorDocument 503 /503.html
 # Don't redirect when someone requests assets used in 503.html
 RewriteCond %{REQUEST_URI} !^/assets/layouts/portal/favicon.ico$
 RewriteCond %{REQUEST_URI} !^/assets/libraries/bootstrap/bootstrap.min.css$
 RewriteCond %{REQUEST_URI} !^/assets/layouts/portal/application.css$
 RewriteCond %{REQUEST_URI} !^/503.html$
 RewriteCond %{DOCUMENT_ROOT}/../tmp/maintenance.txt -f
 # Set 503 status for all requests
 RewriteRule ^(.*)$ /503.html [NC,R=503,L]
 # When it is not maintenance mode redirect to root_path from 503.html
 RewriteCond %{DOCUMENT_ROOT}/../tmp/maintenance.txt !-f
 RewriteCond %{REQUEST_URI} ^/503.html
 RewriteRule ^503.html http://www.project.domain/ [R=302,L]

Of course, you need to remember to create your own 503.html file, put it in public/ dir of your project and customize all the htaccess rules based on your needs.

Capistrano hookup To automate enabling and disabling my projects, I use a set of simple Capistrano tasks, enclosed in an Apache namespace:

 namespace :apache do

 desc 'Restarts the current Passenger project'
 task :restart do
   run "touch #{current_path}/tmp/restart.txt"

 desc 'Sets project server in dev mode - so the 503 page is served'
 task :lock do
   run "touch #{current_path}/tmp/maintenance.txt"

 desc 'Sets project to a standard mode'
 task :unlock do
   run "rm -f #{current_path}/tmp/maintenance.txt"

Usage example:

 before 'deploy:update' do
 after 'deploy:update' do