Fils RSS pour les
Articles
Commentaires

Pages de maintenance personnalisées avec Capistrano


Marc Charlet 26 avril 2007 par Marc Charlet

d'après l'article Custom Maintenance Pages sur le blog de Mike Clarke.

 

Capistrano permet de facilement générer et afficher une page de maintenance lorsque vous devez intervenir sur votre site. Pour faire cela, capistrano met à disposition les commandes disable_web pour afficher la page de maintenance et enable_web pour revenir à la normale.

Microsoft Windows XP [Version 5.1.2600]
(C) Copyright 1985-2001 Microsoft Corp.
 
C:\Documents and Settings\Marc\workspace\monapplic>cap disable_web
C:\Documents and Settings\Marc\workspace\monapplic>
C:\Documents and Settings\Marc\workspace\monapplic>cap enable_web
C:\Documents and Settings\Marc\workspace\monapplic>

La page affichée par défaut est, malheureusement pour nous, en anglais.

generic.jpg

Dans son article, Mike Clarke nous donne une méthode pour remédier à cette situation en nous donnant le moyen d'afficher une page de maintenance personnalisée.

  • pour que la page de maintenance s'affiche, il faut, bien entendu, que le site soit préparé à afficher la page si elle est présente. Pour ce faire il suffit de modifier le fichier .htaccess du répertoire public1 de la façon suivante:
  • juste après RewriteEngine On, ajouter
PLAIN TEXT
  1. # Display maintenance.html if file exists (cap disable_web)
  2. RewriteCond %{DOCUMENT_ROOT}/system/maintenance.html -f
  3. RewriteCond %{SCRIPT_FILENAME} !maintenance.html
  4. RewriteRule ^.*$ /system/maintenance.html [L]

  • nous devons également modifier notre fichier /config/deploy.rb en conséquence2 et ajouter une redéfinition de la tâche disable_web à la fin du fichier
PLAIN TEXT
  1. desc "Redefine disable_web task for custom maintenance page"
  2. task :disable_web, :roles => :web do
  3.       on_rollback { delete "#{shared_path}/system/maintenance.html" }
  4.                   
  5.       maintenance = render("./app/views/layouts/maintenance.rhtml",
  6.                        :deadline => ENV['UNTIL'],
  7.                        :reason => ENV['REASON'])
  8.                                       
  9.       put maintenance, "#{shared_path}/system/maintenance.html",
  10.                       :mode => 0644
  11. end

  • pour traduire et personnaliser la page de maintenance, il nous suffit de modifier le fichier maintenance.rhtml que nous avons placé dans le répertoire /app/views/layouts, comme suggéré par Mike Clarke.
PLAIN TEXT
  2.  
  3.   <div class="outer">
  4.      <div class="DialogBody" style="text-align: center;">
  5.        <div style="text-align: center; width: 200px; margin: 0 auto;">
  6.          <p style="color: red; font-size: 16px; line-height: 20px;">
  7.            Le syst&egrave;me est arr&ecirc;t&eacute; pour <%= reason ? reason : "maintenance" %>
  8.             depuis <%= Time.now.strftime("%H:%M %Z") %>.
  9.          </p>
  10.          <p style="color: #666;">
  11.            Nous serons de retour <%= deadline ? " #{deadline}" : "d&egrave;s que possible" %>.
  12.          </p>
  13.        </div
  14.      </div>
  15.   </div>
  16.  
  17. </body>

  • lançons la commande disable_web pour constater que c'est notre page personnalisée qui s'affiche.3

C:\Documents and Settings\Marc\workspace\monapplic>cap disable_web
* executing task disable_web
servers: ["monapplic.toutenruby.com"]
* uploading /home/Marc/monapplic.toutenruby.com/shared/system/maintenance.html
** uploading data to monapplic.toutenruby.com:/home/nnoel/monapplic.toutenruby.com/shared/system/maintenance.html
* done uploading data to monapplic.toutenruby.com:/home/nnoel/monapplic.toutenruby.com/shared/system/maintenance.html
upload finished

french.jpg

  • si nous voulons envoyer des variables personnalisées, il suffit de les déclarer dans la fenêtre de commande.

Microsoft Windows XP [Version 5.1.2600]
(C) Copyright 1985-2001 Microsoft Corp.
 
C:\Documents and Settings\Marc\workspace\monapplic>set UNTIL=dans 10 minutes
C:\Documents and Settings\Marc\workspace\monapplic>
C:\Documents and Settings\Marc\workspace\monapplic>set REASON=cause d'upgrade de Wordpress
C:\Documents and Settings\Marc\workspace\monapplic>

custom.jpg

  • pour 'effacer' les variables environnement, il suffit de les redéclarer 'vides'

Microsoft Windows XP [Version 5.1.2600]
(C) Copyright 1985-2001 Microsoft Corp.
 
C:\Documents and Settings\Marc\workspace\monapplic>set UNTIL=
C:\Documents and Settings\Marc\workspace\monapplic>
C:\Documents and Settings\Marc\workspace\monapplic>set REASON=
C:\Documents and Settings\Marc\workspace\monapplic>

  • lorsque la situation redevient 'normale', il suffit de réactiver le site via la commande enable_web

C:\Documents and Settings\Marc\workspace\monapplic>cap enable_web
* executing task enable_web
* executing "rm -f /home/nnoel/monapplic.toutenruby.com/shared/system/maintenance.html"
servers: ["monapplic.toutenruby.com"]
[monapplic.toutenruby.com] executing command
command finished
C:\Documents and Settings\Marc\workspace\monapplic>

 

  1. dans mon cas, je modifie .htaccess.prd [retour]
  2. voir l'article de Mike [retour]
  3. ne pas oublier de mettre son site à jour avec, par exemple, une nouvelle exécution de la commande cap deploy [retour]

Tags: , , , , , ,

Publié dans Ruby on Rails |

Les commentaires sont fermés.