Config File Reference

A yaml config file can be given using the -c command line option. Note that command line options override config fields.

Fields

interface:
 

Interface to expose the API on

type: str
default: 'localhost'
port:
 

Port to expose the API on

type: int
default: 8080
logfile:
 

File to log to or `None` for no logging

type: str
default: None
redis:
 

Config to use for redis connection

type: dict
default: {'db': 0, 'host': 'localhost', 'password': None, 'port': 6379}
amqp:
 

Config to use for amqp connection

type: dict
default:
{'db': 0,
 'hostname': '127.0.0.1',
 'password': 'guest',
 'port': 5672,
 'username': 'guest',
 'vhost': '/'}
inbound_message_ttl:
 

Maximum time (in seconds) allowed to reply to messages

type: int
default: 600
outbound_message_ttl:
 

Maximum time (in seconds) allowed for events to arrive for messages

type: int
default: 172800
channels:
 

Mapping between channel types and python classes.

type: dict
default: {}
replace_channels:
 

If `True`, replaces the default channels with `channels`. If `False`, `channels` is added to the default channels.

type: bool
default: False
plugins:
 

A list of dictionaries describing all of the enabled plugins. Each item should have a `type` key, with the full python class name of the plugin.

type: list
default: []
metric_window:
 

The size of the buckets (in seconds) used for metrics.

type: float
default: 10.0
logging_path:
 

The path to place log files in.

type: str
default: 'logs/'
log_rotate_size:
 

The maximum size (in bytes) of a log file before it gets rotated.

type: int
default: 1000000
max_log_files:
 

The maximum amount of log files allowed before old files start to get deleted. 0 is unlimited.

type: int
default: 5
max_logs:
 

The maximum amount of logs that is allowed to be retrieved via the API.

type: int
default: 100