Browse files

Added usage details for

  • Loading branch information...
Brian McDonnell
Brian McDonnell committed May 17, 2012
1 parent 28166f9 commit fa1ce8329f628afc44c55adf206adb22c46996c1
Showing with 26 additions and 3 deletions.
  1. +26 −3
@@ -1,4 +1,27 @@
+# cherokee_scripts
-Scripts for interacting with Cherokee Web Server
+Scripts for interacting with Cherokee Web Server
+## /
+Enables/disables a vserver rule to trigger a maintenance notice.
+Cherokee has a great admin interface for humans but not much
+support for scripted actions. This script delves into the
+cherokee config file to enable/disable a very specific rule under a
+specified vserver.
+### Example Usage
+$ enable --vserver_nicl="My Example VServer"
+### Required Maintenance Rules
+The relevant vserver should have two maintenance rules.
+Rule 1) Handles the maintenance page.
+Rule 2) Directs all traffic to a maintenance page.
+Rule 1) Can handle the maintenance page whatever way you like.
+Rule 2) needs to be a directory match on '/' (which will match everything).
+Its handler is a regex redirection performing an internal redirection
+of everything (.*) to the maintenance page.

0 comments on commit fa1ce83

Please sign in to comment.