Configurations

Pebbles is configured with a number of variables.

These variables come, in the order of precedence from

• environment variables
• a configuration file
• built-in defaults

Naming convention is UPPERCASE_WORDS_WITH_UNDERSCORES.

To see the complete list check out pebbles.config that houses the object. Only some have been documented.

The idea is that you could have a single docker container with multiple entry points. All containers can (or should) see the same configuration file and then at start-up time environment variables can be set to e.g. differentiate workers to run a particular driver.

BaseConfig

class pebbles.config.BaseConfig

Stores the default key, value pairs for the system configuration. Rendered with a decorator which considers any environment variables, then the system level config file and finally the default values, in that order of precedence.

BRAND_IMAGE

An image URL for branding the installation

DEBUG

Controls debug mode

HAKA_INSTITUTION_LIST

Dictionary of institution types and corresponding domains

INSTANCE_NAME_PREFIX

all spawned instance names will have this prefix

M2M_CREDENTIAL_STORE

Where to find the M2M credentials file

PLUGIN_WHITELIST

A whitespace-separated case-sensitive list of all enabled plugins

PUBLIC_IPV4

used by Docker Driver to create access urls so FQDN is actually expected in production