Doradus_REST_API_Parameters

Table of Contents | Previous | Next | Index

Doradus Configuration and Operation : Doradus Configuration Files : Configuration Parameters in doradus.yaml : Doradus REST API Parameters

---

Doradus REST API Parameters

These parameters configure the Doradus REST API.

restaddr: 0.0.0.0

By default, the Doradus REST API binds to address 0.0.0.0, which means it accepts connections directed to any of the host’s IP addresses (including “localhost”). Change this value if you want the REST API to accept connections on a specific IP address instead.

restport: 1123

This is the REST port that Doradus listens to. Change this to accept REST API connections on a different port.

maxconns: 200

This is the maximum number of connections that the Doradus server will service at one time. If more than this number of connections is received, each additional connection is queued but not serviced until an existing connection is closed. This value also controls the maximum size of the REST server thread pool.

tls: false

tls_cipher_suites:

- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA

...

clientauthentication: false

keystore: config/keystore

keystorepassword: changeit

truststore: config/truststore

truststorepassword: password

As described in the section 0 Doradus Security Options, these parameters should be set to configure TLS/SSL for the Doradus REST API and to restrict connections to authenticated clients.

max_request_size: 52428800

This parameter determines the maximum size of an input requested that is accepted. Requests larger than this are rejected and the socket is closed. The default is 50MB.