sedex Client Configuration Parameters¶
On this page you find the typical configuration parameters of the sedex Client Docker container.
Enabling the Messaging REST API (since version 7)¶
To enable or disable the Messaging Rest API, the following keys can be used:
# If enabled, messages can be sent and received via sedex messaging REST API. The OpenAPI spec is available at: https://hostname:port/swagger-ui.html
# Note: Messaging REST API is only available when wsproxy is started (see wsproxy.start).
messaging.interface.rest-api.enabled=true
# Defines, if the incoming messages should be delivered to the well known file-system interface or the newly available rest-interface.
# Possible values of the parameter: "file-system" or "rest-api".
# More specific rules for certain sedexIds or messageTypes can be configured in "sedex-incoming-message-interface-rules.conf".
messaging.interface.selector.rule.default=rest-api
Internet Access via HTTP Proxy¶
If an HTTP proxy is required to access the Internet, such a proxy server can be added as a custom configuration:
# Proxy settings: Set these values only if you reach the Internet in your network only through a proxy
# Example: host=proxy.example.ch port=8080 user=example-user password=1234
outgoing-web-proxy.host=proxy.example.ch
outgoing-web-proxy.port=8080
outgoing-web-proxy.user=example-user
outgoing-web-proxy.password=1234
You have no username/password?
Leave the user/password parameters blank if proxy server authentication is not required.
Disable WebSocket Protocol¶
By default, to reduce message round trip times, the sedex Server notifies the Client using the WebSocket protocol.
In extremely rare cases (approx. 1% of all clients), the WebSocket protocol can cause communication problems with network components on the client side. If such a problem is detected, the use of WebSocket can manually be deactivated. As a result, the client can only use the so-called polling mode, which leads to longer message round trip times (about 10 minutes instead of a few seconds), but the sedex Client can still offer the basic functionality without WebSocket if required.
If disabling WebSocket is required, this can be achieved by adding the following custom configuration:
websocket.enabled=false
Disable WebSocket communication only if it is really necessary.
Normally the WebSocket communication should not be disabled, as this has a negative impact on sedex's performance.
Disable sedex Webservice Proxy¶
By default, the sedex Client is starting the sedex Webservice Proxy functionality. If not used, the sedex Webservice Proxy can be disabled in order to save some resources (CPU, memory).
Disable the sedex Webservice Proxy by adding the following custom configuration:
wsproxy.start=false