Hermes Console is served by Hermes Management and can be configured via
application property files
under console
property.
If you want to see console default config then take a look on application-local.yaml file.
Option | Description |
---|---|
console.title | what to display in left upper corner, next to Hermes logo |
dashboard.metrics | link to metrics dashboard, available on Console home page |
dashboard.docs | link to documentation, available on Console home page |
Hermes Console can be integrated with Metric Store. This means, that metrics shown in Console can link to actual graphs plotted by Metric Store. At the moment only Graphite is supported.
Option | Description |
---|---|
metrics.type | type of metrics storage to link to (currently only graphite is supported) |
metrics.graphite.url | URL to graphite |
metrics.graphite.prefix | prefix to graphite metrics |
Hermes Console supports two types of authorization, which can be enabled at the same time (OAuth > headers):
Authorization
header with the tokenNote none of above mentioned authorization methods are available in Management out of box at the moment, you need to provide the implementation.
Option | Description |
---|---|
auth.oauth.enabled | enable OAuth support |
auth.oauth.url | url to OAuth authorization endpoint |
auth.oauth.clientId | OAuth client id |
auth.oauth.scope | assigned scope |
auth.headers.enabled | enable simple authorization support |
auth.headers.adminHeader | name of header to bear admin password |
Option | Description |
---|---|
topic.messagePreviewEnabled | show message preview tab on topic view; enable only if message preview is enabled in Frontend |
topic.offlineClientsEnabled | show offline clients section on topic view; enable only if offline readers integration in management module is turned on |
Option | Description |
---|---|
subscription.endpointAddressResolverMetadata | extend subscription address resolver configuration with specified metadata fields |
Example:
"subscription": {
"endpointAddressResolverMetadata": {
"exampleEntryEnabled": {
"title": "Example boolean entry",
"type": "boolean"
},
"exampleTextEntry": {
"title": "Example text entry",
"type": "text",
"placeholder": "You should write something here",
"hint": "This should help somehow..."
},
"exampleSelectEntry": {
"title": "Example select entry",
"type": "select",
"options": {
"": "<clear>",
"a": "An option",
"b": "Another option"
}
}
}
}
This will add 3 additional fields to subscription configuration, all optional.
Option | Description |
---|---|
owner.sources | a list of owner sources customizations |
Example:
"owner": {
"sources": [
{"name": "Plaintext", "placeholder": "this will display as placeholder in the owner input"}
]
}