URLWatch Setup - urlwatch.conf File

Below is a sample urlwatch.conf file. Throughout the file are various comments and instructions as to what MUST be modified for your account, as well as OPTIONS that may be included for your visitors.

# this is the configuration file for the URLWatch program. 
# please note that we have included generic terms/names thoroughout this file
# you will need to change items as indicated to reflect your domain and/or 
# account name

################################################################
#                                                              #
#                     GENERAL INFORMATION                      #
#                                                              #
################################################################

# server:   -- the base url for the server.  This assumes that each 
#              html file supplies "/index.html" as it's URL, rather 
#              than the fully qualified URL.
#              Change "yourdomain.com" to the name of your domain

server: http://www.yourdomain.com

# filedir:  -- the base directory for the document files.  This also
#              assumes that the html file supplied "/index.html" as
#              it's URL, and so the two are concatenated directly.
#              change "yourdomain" to the name of your domain

filedir: /home/yourdomain/html

# database: -- the name of the MySQL database that holds
#              the table of docfile/address and address/passid pairs
#              change "yourdomain_com" to something relevant 
#              to your site

database: yourdomain_com

# table1:   -- the name of the MySQL table that holds the 
#              docfile/address pairs

table1: urlwatch

# table2:   -- the name of the MySQL table that holds the 
#              address/passid pairs 

table2: urlmaint

################################################################
#                                                              #
#                   MAIL MESSAGE PROCESSING                    #
#                                                              #
################################################################

# source:   -- the email address used as the source of the
#              messages sent out as notification of changes
#              on the website.  If the originating user is 
#              not trusted by sendmail, this may result in 
#              X-Authentication-Warning headers being inserted
#              into the outbound message.
#
#              If this field is missing, no '-f' parameter will
#              be passed into sendmail
#              change "yourdomain.com" to the name of your domain

source: urlwatch@yourdomain.com

# subject:  -- subject of the notification message
#              change Your Site Name to something appropriate for your 
#              site (ie, Abigial's Photo Gallery URLWatch)

subject: Your Site Name's URLWatch

# intro:    -- text to be sent to each user getting an update message.
#              This text is included in the message before the user's
#              email address and newly assigned passid are provided or
#              any URLs are listed.
#
#              This text is not reformatted but is sent verbatim.  It 
#              can include instructions and other pertinant information.
#              This is optional as the mailer generates a default.
#              Change "youraccountname" to your user account's name 
#              (8 char or fewer)

intro: /home/youraccountname/data/urlwatch/mail.intro

# update:   -- the url to supply to the user where they can go update their
#              entries for this site.  This should present a form that has
#              2 fields, "email" and "passid" which are submitted to 
#              /cgi-sbin/urlmaint.cgi which will authenticate and produce
#              a list of monitored pages

update: /urlmaint.html

# closing:  -- text to be sent to each user getting an update message.
#              This text is included after the email, passid and URL 
#              list for the day.  It can contain instructions, additional
#              help information or a simple signature.  The contents are 
#              sent as is.  This is optional as the mailer generates a
#              default.
#              change "youraccountname" to reflect your actual 
#              account name (8 char or less)

closing: /home/youraccountname/data/urlwatch/mail.closing

################################################################
#                                                              #
#                     SIGNUP OUTPUT FILES                      #
#                                                              #
################################################################

# header:   -- the full path to the HTML header to be sent
#              on the response pages.  This should include
#              everything up to and including the 
#              tag, with any other potential preamble included.  
#              change "youraccountname" to reflect your actual account name

sheader: /home/youraccountname/data/urlwatch/signup.header

# footer:   -- the full path to the HTML footer to be sent
#              on the response pages.  This should include
#              as a minimum the  and  tags.  
#              It will be sent after the page's contents 
#              have been sent.
#              change "youraccountname" to reflect your actual account name

sfooter: /home/youraccountname/data/urlwatch/signup.footer

# success:  -- the full path to the HTML text to be sent 
#              when a successful request has been processed
#              and stored in the data/urlwatchbase
#              change "youraccountname" to reflect your actual account name

signup: /home/youraccountname/data/urlwatch/signup.success

# The following are error documents, sent between the header
# and footer under certain conditions.

# already:  -- the full path to the HTML text to be sent 
#              when the requested email is already associated
#              with the given URL.  Duplicate entries are not
#              permitted in the data/urlwatchbase.
#              change "youraccountname" to reflect your actual account name

already: /home/youraccountname/data/urlwatch/error.already

# bademail: -- the full path to the HTML text to be sent 
#              when the requested email address contains 
#              invalid characters.  These include anything which
#              might cause problems when shelling out to send
#              the eventual email message.
#
#              Currently, the following characters are not 
#              permitted in email addresses by urlwatch.cgi:
#
#              <>,/?'"[]{}=|`~#$*()

bademail: /home/youraccountname/data/urlwatch/error.email

# noform:   -- the full path to the HTML text to be sent
#              when urlwatch.cgi is invokved without the 
#              appropriate form data/urlwatch.  This could be in part
#              by a user trying to access the script itself
#              from outside the defined form. (see urlwatch.html)
#              change "youraccountname" to reflect your actual account name

noform: /home/youraccountname/data/urlwatch/error.form

################################################################
#                                                              #
#                  MAINTENANCE OUTPUT FILES                    #
#                                                              #
################################################################

# mheader:  -- full path to HTML text file to used for response
#              pages sent out by urlmaint.cgi
#              change "youraccountname" to reflect your actual account name

mheader: /home/youraccountname/data/urlwatch/maint.header

# mfooter:  -- full path to HTML text file to used for response
#              pages sent out by urlmaint.cgi
#              change "youraccountname" to reflect your actual account name

mfooter: /home/youraccountname/data/urlwatch/maint.footer

# msuccess: -- full path to HTML to be sent when all requested
#              URLs are successfully removed from the database
#              change "youraccountname" to reflect your actual account name

removed: /home/youraccountname/data/urlwatch/maint.success

# mfailure: -- full path to HTML to be sent when one or more of
#              the requested URLs resulted in a database error
#              when being removed.
#              change "youraccountname" to reflect your actual account name

dataerr: /home/youraccountname/data/urlwatch/error.database

# noauth:   -- the full path to the HTML text to be sent when 
#              the identifying information doesn't match the
#              entries in the database.
#              change "youraccountname" to reflect your actual account name

noauth: /home/youraccountname/data/urlwatch/error.auth

# end of file #