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
confin the Node.js module directory if you installed with
- in the folder
confafter unpacking the standalone server binary.
In this section you can change general settings for each server in a cluster.
# general configuration with default values serverName: UUID showLogo: true
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.
When starting, a server can show the deepstream logo. This setting is best left enabled.
deepstream can be configured to encrypt connections and you can provide the paths to your SSL key, certificate, and certificate authority file.
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
The path to your SSL key file.
The path to your SSL certificate file.
The path to your SSL certificate authority file.
Connection Endpoint Configuration
Deepstream (v2.3.0 and later) can be configured with custom connection endpoints. A (locally
unique) identifier, typically the transport type, is listed below the
e.g. ‘tcp’. Below that, either a path to the endpoint or a name is listed. Endpoint options can
also be specified.
connectionEndpoints: websocket: name: uws options: port: 6020 host: 0.0.0.0
The special ‘uws’(µWebSockets) endpoint configures the built-in endpoint. To avoid starting it, null the ‘websocket’ key as follows:
The uws endpoint has the following options:
Sets the port for the HTTP healthcheck and Websocket server.
Sets the host for the HTTP healthcheck and Websocket server.
Sets which URL path Websocket connections should connect to.
URL path for HTTP health-checks, GET requests to this path will return 200 if deepstream is alive.
The number of milliseconds between each ping/heartbeat message.
The amount of time a connection can remain open while not being logged in.
Invalid login attempts before the connection is cut.
Controls whether logs should contain the cleartext usernames and passwords of invalid login attempts. Default: false
Sets the maximum message size allowed to be sent to the server (in bytes).
The amount of milliseconds that secondary writes to sockets are buffered. This means
writes that are not realtime critical, which currently are either ACKs or
non critical ERROR messages.
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
If you are using any of the official deepstream connectors, add the name of what the plugin connects to here, for example
Note: You can set
path or name, but not both.
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.
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
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.
Sets at what level and above the server should log messages. Valid levels are
A regular expression that - if it matches a recordname - will prevent the record from being stored
in the database.
A list of prefixes that designate a record for direct writes to storage.
When a correctly permissioned matching record is updated via
setData(), it will be written
directly to the cache and storage without a record transition. This can be up to twice as fast as
updating a normal record using
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
http, each of them having
options which are described in the tutorials on Auth
authentication, and HTTP
#Authentication auth: type: none options: depends
In this section you can configure the
permissioning. The key used for this
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
Set the path to the file that declares permissions. This option is mandatory
default, deepstream ships with a
permissions.yml permitting every action.
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.
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.
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
Sets how long deepstream will wait for a RPC provider to acknowledge receipt of a request.
Sets how long deepstream will wait for RPCs to complete.
Sets how long deepstream will wait when retrieving values from the cache.
Sets how long deepstream will wait when retrieving values from the database.
Sets how long deepstream will wait for dependencies to initialize.