Configuration
Configuration properties
Axon Server connection
| Property | Environment Variable | Default value | Description |
|---|---|---|---|
synapse.server-list |
SYNAPSE_SERVER_LIST |
|
Comma-separated list of Axon Servers |
synapse.client-id |
SYNAPSE_CLIENT_ID |
JVM process name |
Synapse instance identifier |
synapse.component-name |
SYNAPSE_COMPONENT_NAME |
|
Synapse component name as seen by the Axon Server |
synapse.client-component-name |
SYNAPSE_CLIENT_COMPONENT_NAME |
|
Synapse client component name as seen by the Axon Server |
synapse.use-tls |
SYNAPSE_USE_TLS |
|
Whether Axon Server connection is TLS encrypted |
synapse.certificate-chain |
SYNAPSE_CERTIFICATE_CHAIN |
Path to the file with a certificate |
|
synapse.connection-timeout |
SYNAPSE_CONNECTION_TIMEOUT |
|
Duration of inactivity, after which Synapse closes connection to the Axon Server |
synapse.default-context |
SYNAPSE_DEFAULT_CONTEXT |
|
The name of the default Axon Server context. It’s applied when the environment doesn’t provide context listing, for example, AS SE or AxonIQ Cloud. |
Access control
| Property | Environment Variable | Default value | Description |
|---|---|---|---|
synapse.http-endpoints |
SYNAPSE_HTTP_ENDPOINTS |
Comma-separated list of Axon Server’s REST endpoints (applies for AS before 2023.0.0) |
|
synapse.internal.context |
SYNAPSE_INTERNAL_CONTEXT |
|
Context this synapse instance connects to |
synapse.internal.client-id |
SYNAPSE_INTERNAL_CLIENT_ID |
|
Client id used by this synapse instance. Important if using multiple synapse instances. |
synapse.internal.component-name |
SYNAPSE_INTERNAL_COMPONENT_NAME |
|
Component name used when contacting Axon Server. Should be the same for all synapse instances. |
synapse.auth.enabled |
SYNAPSE_AUTH_ENABLED |
|
Whether Synapse configuration APIs expect clients to provide username/password combination or token |
synapse.auth.token |
SYNAPSE_AUTH_TOKEN |
Axon Server access control token |
|
synapse.auth.sensitive-data-encryption-key |
SYNAPSE_AUTH_SENSITIVE_DATA_ENCRYPTION_KEY |
Encryption key for securing sensitive data |
|
synapse.security.cors-allowed-origins |
SYNAPSE_SECURITY_CORS_ALLOWED_ORIGINS |
|
Allowed origins as defined in Cross-Origin Resource Sharing (CORS) |