Skip to main content
Version: Next

Configuring and Monitoring Service Apps

Service Apps typically read there configuration from their oConfig.json file. The default setup provides such a sample file in res/oConfigNode.json. When building the service app, the file is copied into the dist folder, and renamed to oConfig.json.


Parameters can be set either in the oConfig.json file, or on the command line parameter using the -- syntax. The two examples below are therefore equivalent:

  • oConfig.json syntax: "myparameter": "somevalue"
  • command line parameter: npm run serve:node -- myparameter=somevalue
ParameterSample valueDocumentation
sc.app01888abcd8e4e5fa301cThe tag of the Service App to be launched.
sc.productiontrue Set to true to enable some optimizations relevant in production. In particular, when true apps no longer subscribe to changes to the application graph (which is not supposed to happen in production).
sc.remoteactiontimeout20000The number of milliseconds after which a remote action will timeout. Increase this value if the Remote Actions have some slow processing.
defaultHostmyinstance.olympe.ioThe instance to connect to, with good default values for the server, bus and data parameters (see below for more details). For front-ends, the default value of defaultHost is the hostname of the URL, for backends, it is localhost.
bus.vhostmyinstanceThe bus vhost to connect to.
auth.autoLogintrueWhether to use auth.autoUser and auth.autoPassword for authentication.
auth.autoUserusernameThe username to use to connect to the Olympe Orchestrator.
auth.autoPassword passwordThe password to use to connect to the Olympe Orchestrator.

The following parameters are available for advanced configurations, to override the defaultHost defaults.

ParameterSample valueDocumentation
server.hostmyinstance.olympe.ioThe hostname or IP address where to reach the Olympe Orchestrator.
server.port443The port to be used.
server.ssltrueWhether to enable HTTPS / WSS or not., bus.port, bus.ssl, bus.pathEnable configuring the connection to the message broker used for UI App - Service App and Service App - Service App communications.
data.httpHost, data.httpPort, data.httpSSL, data.httpPath  For advanced datasource configuration.