Configuration

All config is loaded through the config service

SSL

SSL can be enabled through the ssl property of the express service configuration.

 "express": {
   "port": "3001",
   "ssl": {
     "key": "certs/server.key",
     "cert": "certs/server.crt",
     "passphrase": "devmode"
   }
 }

It supports any of the options supported by Node's TLS server. Any file-based options, e.g. key, cert, ca, are resolved relative to the appl ication's root directory.

HTTP Server Timeouts

Express Timeouts can be configured through the httpServer property of the express service configuration.

"express": {
    "httpServer": {
      "timeout": 111111,
      "keepAliveTimeout": 222222,
      "headersTimeout": 333333
    }
  }

For more details on the meaning of these values, see the Node HTTP Server docs.

Note, the version of Node you're running affects which options are available to BlueOak Server:

• timeout is effective when running Node v0.9.12 and later
• keepAliveTimeout is effective when running Node v8.0.0 and later
• headersTimeout is effective when running Node v11.3.0 and later

Middleware

Express middleware config

Clustering

Clustering is supported out of the box. The number of workers can be configured. A value of 1 (default) is recommended during development.

{
  "cluster": {
    "maxWorkers": 1
  }
}

If maxWorkers is negative, the number of workers will be set to the number of cpus/cores on the system, which is recommended in production.

Swagger

Swagger config

Logger

Logger config

Crash Dumps

Crash dump config

Session

Session config