Configuration

The configuration file generated in the Setup step consists of the following configuration sections:

The configuration file uses the standard .ini format that follows this structure:

[section_name]

setting.name = value

Experiment Support System configuration

The settings in this section configure the Experiment Support System itself. To work correctly, they must all be specified within the [app:main] section of the configuration file.

Application settings

app.title

The title to use for the Experiment Support System. Change this to integrate the system into a site-specific branding.

Default: Experiment Support System

SQLAlchemy database connection string

sqlalchemy.url
The SQLAlchemy database connection URL. Consult the SQLAlchemy connection string documentation to find the correct format for the database and database library you are using.

E-Mail settings

email.smtp_host
The host-name of the SMTP server to use for sending e-mails. If this setting is not specified then non of the e-mail related functions in the Experiment Support System will be enabled.

Session handling configuration

The settings in this section specify how the user sessions are managed. For details on the available settings, consult the beaker documentation. In most cases you will only want to change the beaker.session.key setting.

beaker.session.lock_dir

The directory used for locking.

Default: %(here)s/tmp

beaker.session.type

The type of session storage to use. By default uses cookie-based sessions.

Default: cookie

beaker.session.key

The key to use for session access. With cookie-based sessions this is the name of the cookie to use.

Default: ess

beaker.session.encrypt_key
Encryption key to use to ensure cookie-based sessions are harder to manipulate. The key is automatically and semi-randomly generated when the configuration is created.
beaker.session.validate_key
Validation key to use to test that cookie-based sessions have not been manipulated. The key is automatically and semi-randomly generated when the configuration is created.

Pyramid framework configuration

The settings in this section are set for a production deployment and should not be changed in a production environment.

pyramid.reload_templates

Whether to automatically reload HTML templates when they are updated.

Default: false

pyramid.debug_authorization

Whether to provide detailed debug information for the authorization process.

Default: false

pyramid.debug_notfound

Whether to provide detailed debug information for URLs that are not handled by the Experiment Support System.

Default: false

pyramid.debug_routematch

Whether to provide detailed debug information on the URL processing functions.

Default: false

pyramid.debug_templates

Whether to provide detailed debug information for errors in the HTML templates.

Default: false

pyramid.default_locale_name

The default locale to use.

Default: en

pyramid.includes

Any additional components to load on application startup. By default the Pyramid Transaction Management component is loaded. For debugging add pyramid_debugtoolbar to this setting. This will allow arbitrary access to everything in the application. Do not include on a production system.

Default: pyramid_tm

Default server configuration

This section configures the default built-in application server, which is mainly designed for use in development and testing. For production scenarios consult the Deployment documentation. These settings must all be specified with in the [server:main] section.

use

The application server entry point to use.

Default: egg:waitress#main

host

The host to listen at for connections.

Default: 0.0.0.0

port

The port to listen at for connections.

Default: 6543

Logging configuration

The settings in this section are passed on to Python’s default logging configuration engine. Consult the Python logging documentation for details on how to adapt the configuration. The settings span a number of sections, detailed in the Python logging documentation.