Edit on GitHub

Configuration

You can make any configuration changes you need for your deepstream setup in the config.yml file. Depending on the installation sources, the configuration can be found in

  • /etc/deepstream/ if you installed on Linux with APT or yum,
  • in the folder conf in the Node.js module directory if you installed with npm, or
  • in the folder conf after unpacking the standalone server binary.

General Configuration

In this section you can change general settings for each server in a cluster.

# general configuration with default values
serverName: UUID
showLogo: true

serverName

Every server in a cluster of servers needs a unique name. You can add your own or set it to UUID to let deepstream auto-generate a unique ID.
Default: UUID

When starting, a server can show the deepstream logo. This setting is best left enabled.
Default: true

Connectivity and Networking

In this section you can change networking details.

# connectivity and network settings with default values
port: 6020
host: 0.0.0.0
urlPath: /deepstream

port

Sets the port for the HTTP and Websocket server.
Default: 6020

host

Sets the host for the HTTP and Websocket server.
Default: 0.0.0.0

urlPath

Sets which URL path Websocket connections should connect to.
Default: /deepstream

SSL Configuration

deepstream can be configured to encrypt connections and you can provide the paths to your SSL key, certificate, and certificate authority file.

Info

  • For performance reasons, we recommend leaving SSL termination to a load balancer, e.g., nginx or HAProxy. The nginx integration tutorial describes this in detail.
# SSL default configuration (no SSL/TLS)
sslKey: null
sslCert: null
sslCa: null

sslKey

The path to your SSL key file.
Default: null

sslCert

The path to your SSL certificate file.
Default: null

sslCa

The path to your SSL certificate authority file.
Default: null

Plugin Configuration

You can extend deepstream with plugins for connectors to other services, these are for logging, storage engines, caching layers, and message systems. To enable a plugin, uncomment the relevant category key underneath the plugins key. Each plugin type has a path or name, and a set of options.

# Plugin example using redis
plugins:
  message:
    name: redis
    options:
       host: localhost
       port: 5672

path

Set a path to a JavaScript file, node module or a folder with an index.js file which exports a constructor.

name

If you are using any of the official deepstream connectors, add the name of what the plugin connects to here, for example redis.

Note: You can set path or name, but not both.

options

Under this key, add sub key/value pairs to set the configuration options that are passed to the plugin. Each plugin should mention what configuration options you can set.

Logger

deepstream uses by default a logger which prints out to stdout (errors and warnings to stderr). You can set these options for the default logger by using the same configuration style for the plugins:

logger:
  name: default
  options:
    colors: true
    logLevel: INFO

colors

Sets whether the server's logs should output in color. This will look great in a console, but will leave color markers in log files if you redirect the output into a file.
Default: true

logLevel

Sets at what level and above the server should log messages. Valid levels are DEBUG, INFO, WARN, ERROR, and OFF.
Default: INFO

Storage Options

storageExclusion

A regular expression that - if it matches a recordname - will prevent the record from being stored in the database.
Default: null

Security

In this section you can configure security settings for access and communication.

# Security options with default values
maxAuthAttempts: 3
logInvalidAuthData: true
maxMessageSize: 1048576

maxAuthAttempts

The number of invalid login attempts before the connection to the server is closed.
Default: 3

logInvalidAuthData

Sets if logs should contain the cleartext usernames and passwords of invalid login attempts.
Default: true

maxMessageSize

Sets the maximum message size allowed to be sent to the server (in bytes).
Default: 1048576

Authentication

In this section you can configure the authentication type the server uses.

You set the authentication type as a subkey the auth key. The available authentication options are none, file, and http, each of them having different options which are described in the tutorials on Auth None, file-based authentication, and HTTP authentication, respectively.

#Authentication
auth:
  type: none
  options: depends

Default: none

Permissioning

In this section you can configure the permissioning. The key used for this section is permission and you can create your own custom permission handler or use a configuration file. To use the former method, select the option type: none and override the permissionHandler with the aid of the NodeJS server API. To use the latter method, set type: config and modify the option values below.

# Permissioning example with default values for config-based permissioning
permission:
  type: config
  options:
    path: ./permissions.yml
    maxRuleIterations: 3
    cacheEvacuationInterval: 60000

path

Set the path to the file that declares permissions. This option is mandatory with type: config. The file can be in JSON, JavaScript, or YAML format. By default, deepstream ships with a permissions.yml permitting every action.

maxRuleIterations

The deepstream permissions model allows for some complex nested actions and queries. To prevent a performance hit you can limit the nesting level with this option.
Default: 3

cacheEvacuationInterval

The results of permission checks are cached to improve performance. Use this setting to change the time interval (in milliseconds) that the cache is regenerated.
Default: 60000

Timeouts (in milliseconds)

In this section you can configure timeout values for a variety of network calls.

# Default timeout values
rpcAckTimeout: 1000
rpcTimeout: 10000
cacheRetrievalTimeout: 1000
storageRetrievalTimeout: 2000
dependencyInitialisationTimeout: 2000

rpcAckTimeout

Sets how long deepstream will wait for a RPC provider to acknowledge receipt of a request.
Default:1000

rpcTimeout

Sets how long deepstream will wait for RPCs to complete.
Default:10000

cacheRetrievalTimeout

Sets how long deepstream will wait when retrieving values from the cache.
Default:1000

storageRetrievalTimeout

Sets how long deepstream will wait when retrieving values from the database.
Default:2000

dependencyInitialisationTimeout

Sets how long deepstream will wait for dependencies to initialize.
Default:2000

Need support, architectural consulting or training? Buy Support