Compass Version 1.3

Compass Server and Build Client Configuration Files

The Compass Server and the Compass Build Client require a configuration file to start up. For the Compass Server, the configuration file only specifies HTTP server connection parameters and can be thought of as similar to an Apache conf file, although far less complex. The Compass Server configuration file therefore, only contains those things that are required to start an HTTP server and all other configuration of Compass is then done through the web interface.

Unlike the Compass server, all configuration for the Compass Build Client is done through the config file. The Compass Build Client has a limited number of configuration parameters and therefore this file is still relatively simple.

Configuration files are broken down into sections defined by a single line with a section name in brackets (ie [Section]). Each parameter is defined on a single line with the parameter name given first followed by an '=' and then the value of the parameter (ie: parameter=value). Below you can see every parameter, an explanation of the parameter, and the possible values for both the Compass Server configuration file and the Compass Build Client configuration file.

Compass Server Configuration File Parameters

[General]

Parameter Name	Allowed Values	Description
log	continuous string (no spaces allowed)	The log parameter is the name of the log file where Compass will log all internal errors and warnings. This file can be consulted for additional debugging information when errors occur.
port	integer number 1-99999	The port parameter is the http port that the server will run on, it defaults to the standard http port 80, but on some configurations this may need to be changed due to Apache or other web servers already running on port 80.
db	any continuous string	The db parameter specifies the relative filepath to the sqlite database file that the compass server will use. The default value is db/compass.db and should rarely need to be changed.
db_update	any continuous string	The db_update parameter specifies the file that tracks changes between versions of Compass and is the file that is used to update the sqlite database when a new version of Compass is installed. The default value is db/master_diff and should not be changed.

[Subdirs]

Parameter Name	Allowed Values	Description
dir[n]	any continuous string	The dir parameter is a list of of directories with name dir01, dir02...dir[n] where the Compass Server will look for python modules to load. The default is dir01=master and it generally should not be changed by end users.

[Modules]

Paramter Name	Allowed Values	Description
mod[n]	any continuous string	The mod parameter is a list of modules mod01, mod02... mod[n] of module names that the Compass Server should load to start up with. The default is mod01=master_mod and it generally should not be changed by end users.

Compass Client Builder Configuration File Parameters

[General]

Parameter Name	Allowed Values	Description
port	integer value 1-99999	The port parameter is the port number that the client opens to receive instructions from the Compass Server. The default value is 8080. If Build Client is on the same machine as the Compass Server this must be different from the Compass Server port.
name	any continuous string	The name parameter is the name of the Compass Build Client. This is the name that will appear in the Build Monitor on the Compass Server and the name displayed in the windows Compass Manager task trey application.
log	any continuous string	The log parameter is the name of the log file where Compass will log all internal errors and warnings. This file can be consulted for additional debugging information when errors occur.
db	any continuous string	The db parameter specifies the relative file path to the sqlite database file that the compass build client will use. The default value is db/compass.db and should rarely need to be changed.
db_update	any continuous string	The db_update parameter specifies the file that tracks changes between versions of Compass and is the file that is used to update the sqlite database when a new version of Compass is installed. The default value is db/client_diff and should not be changed.

[Client]

Parameter Name	Allowed Values	Description
password	any continuous string	The password parameter is the password specified on the Compass Server's Administrator web page. It is used to authenticate Compass Build Clients with the Compass Server.
config	any continuous string	The config parameter is the build config type that this client will execute. The default is either windows or Linux. The list of available values is controlled through the Compass Server's Administration web page in the Build Configurations section.
master	any continuous string	The master parameter is the name and port of the Compass Server separated by a colon. (ie: localhost:8080). The default is 'localhost'.
threads	integer value < 100	The threads parameter determines the maximum number of build plans this client will execute at one time. If a number greater than 100 is used Compass internally clamps this value back to 100.

[Subdirs]

Parameter Name	Allowed Values	Description
dir[n]	any continuous string	The dir parameter is a list of of directories with name dir01, dir02...dir[n] where the Compass Build Client will look for python modules to load. The default is dir01=master and it generally should not be changed by end users.

[Modules]

Parameter Name	Allowed Values	Description
mod[n]	any continuous string	The mod parameter is a list of modules mod01, mod02... mod[n] of module names that the Compass Server should load to start up with. The default is mod01=master_mod and it generally should not be changed by end users.