. . .

Configurations

The documents in this section contains all guides to configure and fine tune your Enterprise Installation of ApiOmat .

Common service configuration

Most services share common configuration keys for options like the connection to consul or the port settings. The following table can be used for each service referencing this page; the settings are done either in the services configuration file/docker arguments or via environmental variables. All configuration keys can be used in addition to the services own configuration.+

YAMBAS

Configuration mentioned here does not correspond with YAMBAS settings. See the YAMBAS documentation for its configuration.

Yaml key / Docker argument

Environmental variable

Default

Explanation

server.port

SERVER_PORT

Default port of the service. Usually, this value should not be changed.

spring.cloud.consul.enabled

SPRING_CLOUD_CONSUL_ENABLED

true

Switch to turn usage of Consul off. Should only be switched off in testing environments where no discovery service is running or needed.

spring.cloud.consul.host

SPRING_CLOUD_CONSUL_HOST

localhost

Hostname of the consul server. On most setups, there is one Consul running on each host, so this setting can be left as is. If Consul runs on an other host, provide its hostname here.

spring.cloud.consul.port

SPRING_CLOUD_CONSUL_PORT

8500

Default port of Consul. Only change if you know what you do.

spring.zipkin.baseUrl

SPRING_ZIPKIN_BASEURL

If defined, traces are sent to a zipkin installation

spring.sleuth.sampler.probability

SPRING_SLEUTH_SAMPLER_PROBABILITY

0.1

Value between 0.1 (10%) or 1 (100%), which indicates the propability that trace information is sent to zipkin

logging.config

LOGGING_CONFIG

By default, each service picks up the native logback configuration from its internal location, but you can set the location of the config file by using the "logging.config" property. Example:

logging.config=file:/my/path/resources/logback.xml

license.key

LICENSE_KEY

The license key issued for this service; needed for licensed services

license.pubkeyFile

LICENSE_PUBKEYFILE

the resources folder of the service

Place where the public key file is stored; needed for licensed services