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.
tip
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
| Parameter | Sample value | Documentation |
|---|---|---|
sc.app | 01888abcd8e4e5fa301c | The tag of the Service App to be launched. |
sc.production | true | 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.remoteactiontimeout | 20000 | The number of milliseconds after which a remote action will timeout. Increase this value if the Remote Actions have some slow processing. |
defaultHost | myinstance.olympe.io | The 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.vhost | myinstance | The bus vhost to connect to. |
auth.autoLogin | true | Whether to use auth.autoUser and auth.autoPassword for authentication. |
auth.autoUser | username | The username to use to connect to the Olympe Orchestrator. |
auth.autoPassword | password | The password to use to connect to the Olympe Orchestrator. |
The following parameters are available for advanced configurations, to override the defaultHost defaults.
| Parameter | Sample value | Documentation |
|---|---|---|
server.host | myinstance.olympe.io | The hostname or IP address where to reach the Olympe Orchestrator. |
server.port | 443 | The port to be used. |
server.ssl | true | Whether to enable HTTPS / WSS or not. |
bus.host, bus.port, bus.ssl, bus.path | Enable 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. |