/includes/config.php

Description
Description | Constants

CoNtRol configuration file

Configuration details for CoNtRol. This file is included at the top of header.php, and hence is automatically included in every page that produces HTML output. It must be included separately in each handler page.

Note: while the defaults *should* work on most systems, it is strongly recommended to review the settings from the first section, and preferably also the second section.

Constants
Description | Constants
ACCEPT_KNOWN_CRN_SUBMISSIONS = true (line 97)

Accept online submissions of known CRNs?

ADMIN_EMAIL = 'control@reaction-networks.net' (line 42)

Email address for the site admin.

All emails sent by CoNtRol are sent from this address.

BINARY_FILE_DIR = '../bin/' (line 109)

Location for the executables used by CoNtRol

You may want to change this to a directory that is not web-accessible for extra security.

CLIENT_LINE_ENDING = $line_ending (line 203)

Client computer line ending (Windows/Mac/UNIX)

CRNDEBUG = false (line 114)

Debugging variable. Set to true when debugging.

DB_PASS = '5Us5vJDRSReM37H5' (line 71)

Database password

Not required for SQLite.

DB_PREFIX = '' (line 78)

Database table prefix

Optional, useful for MySQL on hosting with a limited number of MySQL databases.

DB_STRING = 'mysql:host=localhost;dbname=control;charset=utf8' (line 51)

Database connection information.

You definitely need to change this if you want to use batch processing.

DB_USER = 'control' (line 64)

Database user

Not required for SQLite.

DEFAULT_PAGE_DESCRIPTION = 'CoNtRol is a web application to analyse chemical reaction networks. It also generates LaTeX markup describing their associated DSR graphs and equations.' (line 184)

Default page meta description tag.

DEFAULT_PAGE_TITLE = 'CoNtRol - Chemical Reaction Network analysis tool' (line 179)

Default page title.

MAX_REACTIONS_PER_NETWORK = 16 (line 157)

The maximum number of reactions that CoNtRol will accept without warning.

This option is included because some of the tests struggle with large networks. The analysereacs test currently doesn't complete in a sensible amount of time for networks of more than 16 reactions, so this is the recommended default maximum size. The dsr test has a tendency to crash for large networks, although generally larger than 16. The endotacticity test using glpsol rather than scip also frequently takes a long time for larger networks.

NICENESS = 'nice -n 19 ionice -c3 ' (line 129)

Niceness level to use when running tests

Note trailing space.

NOTIFY_ADMIN_OF_CRN_SUBMISSION = true (line 102)

Notify administrator of new CRN submissions?

REQUIRE_CAPTCHA = true (line 92)

Require CAPTCHA for submission of batch jobs or known CRNs?

It is STRONGLY recommended that you set this to true for a server that is publicly accessible to the internet.

SITE_DIR = 'control' (line 28)

Site subdirectory.

SITE_URL = 'https://reaction-networks.net/'.SITE_DIR.'/' (line 35)

Site URL.

If you want to run CoNtRol in the top level directory, remove SITE_DIR from this.

TEMP_FILE_DIR = '/var/tmp/' (line 136)

Location for temporary files

The default should work but you may wish to change it.

TEST_TIMEOUT_LIMIT = 60 (line 144)

The maximum amount of time a test will run before being cancelled

This is required because tests are run via calls to exec(), which doesn't count towards max_execution_time.

Documentation generated on Sat, 22 Apr 2017 18:00:50 +0100 by phpDocumentor 1.4.4