Environment variables¶

The IDLive Face 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 IDFACE_SERVER_PIPELINE=theia --env SERVER_SSL_ENABLED=true ...

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

Variable	Default	Description
`IDFACE_SERVER_PIPELINE`	`astraea`	Default pipeline to use.
`IDFACE_SERVER_AVAILABLE_PIPELINES`		Comma-separated list of additional pipelines to load.
Validation
`FACESDK_ENABLE_FACE_OCCLUSION_DETECTION`	`1`	Validate if a face is not occluded.
`FACESDK_ENABLE_CLOSED_EYES_DETECTION`	`0`	Validate if eyes on a face were not closed.
Logging
`LOGGING_FILE_NAME`		Path to a log file. If not set the logs won't be saved to a file.
`LOGSTASH_HOST`		Hostname or IP of a Logstash instance.
`LOGSTASH_PORT`		Port of a Logstash instance.
`LOGSTASH_TLS`	`false`	Set to `true` if Logstash uses TLS.
`IDFACE_SERVER_BI_LOGS_PATH`	`/logs`	Directory for Business Intelligence logs.
`IDFACE_SERVER_BI_LOGS_TOTAL_SIZE_CAP`	`2GB`	Total size of Business Intelligence logs.
`LOGGING_LEVEL_BI`		Log level for Business Intelligence logs to be send to a log stream.
Storage
`IDFACE_SERVER_STORAGE_TYPE`		Type of the storage used to keep received images.
`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.
Security
`SERVER_SSL_ENABLED`	`false`	Switch HTTP to HTTPS.
`SERVER_SSL_KEY_STORE`		Keystore file.
`SERVER_SSL_KEY_STORE_TYPE`	`PEM.MOD`	Type of keystore file.
`IDFACE_SERVER_AUTHENTICATION`		Authentication mode.
License manager
`HASP_LICENSE_FILE`		Path to a license key file.
`HASP_ENABLE_RTE`	`true`	Start RTE and use admin mode license.
`HASP_RTE_STARTUP_TIMEOUT`	`3`	Seconds to wait for RTE to start.
`HASP_NETWORK_LICENSE_SERVER`		Hostname of a licensing server.
System
`SERVER_ALLOW_CORS`	`false`	Configure CORS to allow all cross-origin HTTP requests.
`MANAGEMENT_SERVER_PORT`	`8080`	Port for system endpoints.
`FACESDK_SERVER_MEM_FACTOR`	`8`	Memory limit tweak for a native memory allocator.