Parameters by alphabetical order

Parameters of the tgol.conf file

browserTimeout

Description

Timeout from which a page is seen as fully loaded

Default Value (in ms)

5000

cdnUrl

Description

This parameter determines the Url of the Content Delivery Network that hosts all the resources by the web application. If empty (which is the default value), tanaguru will use the resources embedded in the web application.

Default Value

Empty

changePasswordUrl

Description

This parameter is based on web-app-url and shouldn't be modified. It corresponds to the Url of the modify password page sent to a user that wants to reset its password.

Default Value

${web-app-url}/home/contract/audit-result.html

crawlConfigFilePath

Description

This parameter is based on tgol-deployment-path and shouldn't be modified. It corresponds to the path that locates the configuration files needed by the crawler (heritrix).

Default Value

${tgol-deployment-path}/crawler/

emailSentToUserExclusionList

Description

The synchronousAuditDelay parameter defines a delay from which a synchronous audit will be managed as an asynchronous audit. When the audit is terminated an email is sent to the used. In some occasions, for some users, we don't want that email to be sent (for the guest user for example). The "emailSentToUserExclusionList" defines the lists of users (by their email and separated by a ";") that won't be alerted by email when the execution of one of the audits they launch has exceeded the synchronous delay.

Default Value

Empty

enable-account-settings

Description

Enable/Disable the access through the login page to the forgotten password page and the access of the user account settings page for an authentified user.

Default Value

false

enable-demo-link

Description

Enable/Disable the access through the login page to the application for the demo user (user defined with an username set to 'guest' and a password set to 'guest)

Default Value

false

enable-sign-up

Description

Enable/Disable the access through the login page to sign-up page.

Default Value

false

generatedHtmlExplanationLink

Description

The link that leads to the page that explains the characteristics and constraints of the generated HTML. This parameter is not supposed to be modified.

Default Value

http://www.tanaguru.org/en/content/generated-html-characteristics

heritrixHome

Description

Path used by the Crawler (Heritrix) to copy its temporary files.

Default value

/var/tmp/tanaguru

highlighterLocation

Description

Url of the highlighter component used to highlight the source code

Default value

http://localhost/geshi/tgol_highlighter.php

jdbc.driverClassName

Description

JDBC driver class

Default value

com.mysql.jdbc.Driver

jdbc.url

Description

JDBC Url

Default value

jdbc:mysql://localhost:3306/tanaguru

jdbc.username

Description

JDBC Username

Default value

tanaguru

jdbc.password

Description

JDBC Password

Default value

No default Value

jpa.showSql

Description

Enable/Disable the log traces in the mysql log file.

Default value

false

maxSimultaneousAuditPage

Description

Determines the number of page audits that can be run simultaneously. In case of low resources server, this value can be reduced to avoid memory issues.

DefaultValue

10

maxSimultaneousAuditScenario

Description

Determines the number of scenario audits that can be run simultaneously. In case of low resources server, this value can be reduced to avoid memory issues.

DefaultValue

2

maxSimultaneousAuditSite

Description

Determines the number of site audits that can be run simultaneously. In case of low resources server, this value can be reduced to avoid memory issues.

DefaultValue

2

maxSimultaneousAuditUpload

Description

Determines the number of upload audits that can be run simultaneously. In case of low resources server, this value can be reduced to avoid memory issues.

DefaultValue

2

proxyHost

Description

Defines the value of the proxy host when the server accesses the web through a proxy. Has to be present with an empty when no proxy is used.

Default Value

blank

proxyPort

Description

Defines the value of the proxy port when the server accesses the web through a proxy. Has to be present with an empty when no proxy is used.

Default Value

blank

proxyExclusionUrl

Description

Defines Url patterns that must ignore the proxy parameters.

Default Value

blank

Example values

proxyExclusionUrl=127.0.0.1
proxyExclusionUrl=127.0.0.1;localhost;myhost;
proxyExclusionUrl=myhost
proxyExclusionUrl=mydomain.com
proxyExclusionUrl=internalhost;mydomain.com

ruleArchiveRoot

Description

Path that locates the jar file that contains the implemenatation of the rules

Default value

/var/lib/tanaguru

snapshotServiceUrl

Description

Defines the Url of the external service used to build the snaphosts of tested site. If empty (which is the default value), tanaguru's logo will be used to illustrate a website

Default Value

Empty

snapshotServiceUserId

Description

Most of the website snapshot services requires a user Id to be used. This parameters enables to configure that Id. If the "snapshotServiceUrl" parameter is empty, that parameter is ignored.

Default Value

Empty

synchronousAuditDelay

Description

The result of a page audit or a group of audit audit is returned synchronously. For many reasons, an audit can last more than a few seconds, and this variable enables to define a delay from which a synchronous audit will be managed in a asynchronous way. After this delay, an audit in progress page is sent back, and the user is alerted by email when the audit is terminated.

Default Value

25000 (in ms)

tempFolderRootPath

Description

Path used by the application to copy its temporary files

Default value

/var/tmp/tanaguru

tgol-deployment-path

Description

Path that locates the configuration folder embeded by the web application

Default Value

No default value, depends on the version of tomcat and the way the web application is deployed. In case of use of tomcat6, the path is /var/lib/tomcat6/webapps/tgol-web-app-${version}/WEB-INF/conf

tgol-persistenceXmlLocation

Description

Path of the file that define the persistence layer of the application. This option shouldn't be modified.

Default Value

classpath:/conf/persistence.xml.

web-app-url

Description

Url of the web application. This option is needed to send info and links by email (when an audit is terminated for example)

Default Value

No default value, depends on the way the web application is installed. If the web application is accessible through the 8180 port of tomcat, the url is http://localhost:8180/tgol-web-app-${version}

webresourceUrlPrefix

Description

This parameter is based on web-app-url and shouldn't be modified. It corresponds to the Url of the audit-result page sent to a user when a site audit is terminated

Default Value

${web-app-url}/home/contract/audit-result.html