Crossbar Configuration

System Configs

The following table outlines the configs that can be found in the system_config database, crossbar document:

KeyTypeDefaultDescription
api_auth_tokensinteger()35Default token cost of creating an auth token via API key
autoload_moduleslist(string())See hereThe list of Crossbar modules initially started
cache_ttlinteger()300Cache TTL, in seconds
cleanup_timerinteger()86400Time, in seconds, to run the cleanup routines
compress_response_bodyboolean()trueWhether to compress the response body before sending
default_allow_anonymous_quickcallsboolean()trueWhether to allow unauthenticated quickcall API requests
default_languagestring()en-USThe default language, if none are defined on the account
magic_path_patternslist(string())See hereMagic path templates
max_upload_sizeinteger()8000000 bytes (8Mb)Max upload size for request bodies
maximum_rangeinteger()2682000Maximum range, in seconds, for time-based view queries
pagination_page_sizeinteger()50Default page size when paginating
portinteger()8000Port to listen for unencrypted traffic
pretty_metricsboolean()truePretty-print metrics in logs
request_timeout_msinteger()10000Time, in milliseconds, for requests to timeout
reset_id_sizeinteger()250Password-reset ID length
schema_strict_validationboolean()falseToggles whether to perform type conversions on client data when validating
soft_delete_pause_msinteger()10000Time, in milliseconds, to pause between deletions
ssl_ca_certstring()undefinedPath to CA cert file
ssl_certstring()/path/to/crossbar/priv/ssl/crossbar.crtPath to cert file
ssl_keystring()/path/to/crossbar/priv/ssl/crossbar.keyPath to key file
ssl_passwordstring()""Cert password
ssl_portinteger()8443Port to listen for SSL traffic
ssl_workersinteger()100Number of SSL listeners to start
token_costsinteger()1Default token cost of an API request
trace_pathstring()/tmpPath to put trace files when profiling API requests
use_plaintextboolean()trueWhether to start unencrypted listener (port 8000 traffic, typically)
use_sslboolean()falseWhether to start an SSL listener
user_auth_tokensinteger()35Default token cost of creating an auth token via username
workersinteger()100Number of TCP listeners to start

Additional Configs

Some modules use the crossbar namespace to create a specific system_config document for settings as well.

crossbar.accounts
crossbar.auth
crossbar.braintree
crossbar.callflows
crossbar.cdrs
crossbar.devices
crossbar.fax
crossbar.media
crossbar.notifications
crossbar.port_requests
crossbar.presence
crossbar.queues
crossbar.resource_selectors
crossbar.resource_templates
crossbar.resources
crossbar.services
crossbar.sms
crossbar.token_restrictions

On this page