Environment variables¶

The IDLive Doc Server's configuration is managed via environment variables. For Docker use the --env parameter when executing docker run, one for every environment variable:

docker run --env IDLIVEDOC_SERVER_AVAILABLE_PIPELINES=default-pc --env LOGGING_FILE_NAME=/logs/log.log ...

All environment variables are optional. Click on the variable's name for more details.

Variable	Default	Description
`IDLIVEDOC_SERVER_AVAILABLE_PIPELINES`		Comma separated pipelines to use.
License manager
`HASP_LICENSE_FILE`		Path to a license key file.
`HASP_NETWORK_LICENSE_SERVER`		Hostname of a licensing server.
`HASP_ENABLE_RTE`	`true`	Start RTE and use admin mode license.
`HASP_RTE_STARTUP_TIMEOUT`	`3`	Seconds to wait for RTE to start.
Logging
`LOGGING_APPENDER_FILE_LEVEL`		File logging level.
`LOGGING_FILE_NAME`		Path where to write logs.
`LOGSTASH_HOST`		Hostname of ELK server.
`LOGSTASH_PORT`		Port of a ELK server instance.
`LOGGING_APPENDER_BI_LEVEL`		BI logging level.
`LOGGING_PATTERN_CORRELATION`		Logging pattern to use for distributed tracing.
Storage
`IDLIVEDOC_SERVER_STORAGE_TYPE`		Type of the storage used to keep received payloads.
`S3_BUCKET`		Name of S3 bucket.
`S3_REGION`		AWS region with S3 bucket.
`S3_TOKEN`		AWS Access Key ID.
`S3_SECRET`		AWS Secret Access Key.
`S3_PATH`		Optional path in S3 bucket.
`IDLIVEDOC_SERVER_STORAGE_FILE_STORAGE_PATH`		Optional path to directory to save data to.
Security
`IDLIVEDOC_SERVER_AUTHENTICATION`		Server authentication type.
`SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_ISSUER_URI`		Authorization server endpoint.
`SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_JWK_SET_URI`		JWK Set endpoint.
`SPRING_SECURITY_OAUTH2_RESOURCESERVER_JWT_AUDIENCES`		JWT audiences.
`SERVER_SSL_ENABLED`	`false`	Switch HTTP to HTTPS.
`SERVER_SSL_KEY_STORE`		Keystore file.
`SERVER_SSL_KEY_STORE_TYPE`		Type of keystore file.
`SERVER_ALLOW_CORS`		Configure CORS to allow all cross-origin HTTP requests.
System
`SERVER_PORT`	`8080`	HTTP port.