AWBot 1.0 Documentation

 


AWBot configuration directives/options for config/test file


AWbot need a config/test file to know what site and kind of action it should test. This page presents all available directives/options you can use to build your config file.
Note that one config/test file is provided with AWBot (awbot.test.conf).

First this is content of this sample file :
All lines starting with "#" are comments. All other lines must start with one of the allowed keyword directives/options explained in this page.


First this is an index of all directives available for each part of config/test file :


INIT PARAMETERS

DATABASE PARAMETERS (Required if you need pre-post SQL commands)

OTHER PARAMETERS

LIST OF ACTIONS TO EXECUTE BEFORE A TEST

LIST OF ORDERED URLS TO TEST

LIST OF ACTIONS TO EXECUTE AFTER A TEST




OUTPUTDIR
Version : 1.0 +
Syntax :
OUTPUTDIR="./myoutput"
Examples :
OUTPUTDIR="./myoutput"
Explanation :
This directive contains the name of directory where AWBot will
store all output files (results of tests).



SERVER
Version : 1.0 +
Syntax :
SERVER="/var/log/httpd/mylog.log"
Examples :
SERVER="www.mysite.com"
SERVER="myintranetserver"
SERVER="127.0.0.1"
Explanation :
This directive contains the name of server to test.
Note that this directive will be ignored if server name to test is provided on command line with -server option when launching AWBot.



USER
Version : 1.0 +
Syntax :
USER="username"
Examples :
USER="john"
Explanation :
This directive contains the name of the user to use to access pages that require a Basic HTTP authentication.
Note that this directive will be overwrited if user is provided on command line with -user option when launching AWBot.



PASSWORD
Version : 1.0 +
Syntax :
PASSWORD="password"
Examples :
PASSWORD="a12QioP_e"
PASSWORD="$USER"
Explanation :
This directive contains the name of the password to use to access pages that require a Basic HTTP authentication.
Note that this directive will be overwrited if password is provided on command line with -password option when launching AWBot.



BOTNAME
Version : 1.0 +
Syntax :
BOTNAME="bot name"
Examples :
BOTNAME="AWBot"
Explanation :
This directive contains the name of the User Agent that AWBot will use as its browser name.
This data might only appear is the web server log file.



DELAY
Version : 1.0 +
Syntax :
DELAY=d
Examples :
DELAY=-1
DELAY=0
DELAY=5
Explanation :
Between each URL request, you can ask AWBot to wait a certain number of time. Use this directive to give this time in number of seconds:
  • d Means AWBot will wait d seconds (after receiving a HTTP page) before sending next HTTP request.

  • 0 Means AWBot will never wait (There is always a running request).

  • -1 Means AWBot will wait a key pressed on console that run the bot.

  • Note that this directive will be overwrited if delay is provided on command line with -delay option when launching AWBot.



    MAXSIZE
    Version : 1.0 +
    Syntax :
    MAXSIZE=d
    Examples :
    MAXSIZE=0
    MAXSIZE=524288
    Explanation :
    This directive is rarely used. If you really need to "cut" a HTTP page to its first MAXSIZE octets, you can set this parameter. In most cases, use MAXSIZE=0 to always get there entire page.



    TIMEOUT
    Version : 1.0 +
    Syntax :
    TIMEOUT=d
    Examples :
    TIMEOUT=120
    Explanation :
    This directive contains the time-out used when AWbot is waiting a page after requesting a page.
    This is a number of seconds. Traditionnal browsers have a such time-out set between 120 and 300.