Configuration

What follows is a list of settings that can be tweaked to fit the deploying site's needs:

• SCRIPT_PATH: The path where the script has been installed. This will usually be something to the likes of /usr/local/revive.

• FRONTEND_PATH: The path where the web frontend has been installed. This defaults to SCRIPT_PATH/var/www.

• FRONTEND_PATH_EXTERNAL: This must be the full Internet URL to the directory that contains the web frontend files including the FQDN of the server.

• USERLIST: Determines how the list of the users in question should be constructed: MODE_HOME, MODE_PASSWD, MODE_LISTS. See 3.1 for details on the modes.

• WEBSERVER_LOG: Specifies the location of the web server log files required to update the good users and bad users lists. The user executing the scripts needs read access to those files.

• RUNAS_USER: Chooses under which user the scripts are executed. Take care of the file permissions, especially for files and directories that need to be written, such as files under SCRIPT_PATH/var and SCRIPT_PATH/tmp and the web server logs (read-only access required).

• SERVER_NAME: The name of the server the scripts run on. This can be anything and is used in the mailings.

• ADMIN_EMAIL: The e-mail address of the admin used to send out status changes. Should be set to a real address at least for initial deployment and debugging.

• FIRSTTIME_MODE: Which action should be taken upon first occurrence of a bad user, is one of: NOTHING, WARN, CHMOD000, RMHOME, CUSTOM.

• FIRSTTIME_CUSTOM: Specifies a command to execute when FIRSTTIME_MODE=CUSTOM is used.

• FIRSTTIME_CUSTOM_DESC: Specifies a human-readable description for FIRSTTIME_MODE=CUSTOM that is included in the warning e-mail.

• SECONDTIME_MODE, SECONDTIME_CUSTOM, SECONDTIME_CUSTOM_DESC are used exactly like the FIRSTTIME settings.

• NOTIFY_ADMIN: A bitmask in MSB first notation specifying on which events the admin is noticed. Starting with the LSB (the last digit):
  1. revive_enable event.
  2. revive_disable event.
  3. Update of the good users list for the currently active cycle, i.e. each time the revive_check script adds users to those list which means more users have responded.
  4. Used to indicate that a summary should be sent at the end of the cycle.

  Of course, during the deployment phase, 1111 is strictly recommended since you would want to be notified of every event (this is the default). If everything runs smoothly and as intended, you might consider 1000 which will only send you the summary at the end of the cycle.