Skip to content

application.properties Configuration


This section contains information about application.properties file parameters.

General Settings

Parameter Mandatory Default Value Description
runner.executor Yes Specifies the agent type
runner.id Yes Automatically assigned during agent registration Agent ID
runner.gitflic-host Yes Automatically assigned during agent registration GitFlic host address
runner.registrationToken Yes Automatically assigned during agent registration Token obtained from GitFlic application
runner.workingDir No $HOME/gitflic-runner (Unix)
%USERPROFILE%/gitflic-runner (Windows)
Absolute path to agent working directory
Available in agent version 2.0.x and above
runner.helperDir No $HOME/gitflic-runner (Unix)
%USERPROFILE%/gitflic-runner (Windows)
Absolute path to directory containing helper.jar, helper.sh/helper.bat files
Available in agent version 2.0.x and above
runner.job-variables-size-limit-characters No 262144 Maximum character limit for all agent variables (key + value), including predefined ones

Logging Settings

Parameter Mandatory Default Value Description
logging.level.root No INFO Logging level (same as GitFlic settings)
logging.file.name Yes $HOME/gitflic-runner/data/log/server.log Path to log file (same as GitFlic settings)
runner.log-limit-kilobytes No 100 Maximum agent log size in kilobytes (10-25600 KB range)

Docker Agent Type Parameters

* These parameters are ignored for non-Docker agent types

Parameter Mandatory Default Value Description
runner.helperImage No gitflic/gitflic-runner-helper Docker image for helper container
Available in agent version 2.0.0 and above
docker.host Yes unix:///var/run/docker.sock Path to Docker Engine socket
docker.tls-verify Yes false Enable TLS certificate validation
docker.cert-path Yes ~/docker/certs Path to Docker Engine certificates
docker.registry-username Yes Docker Registry username
docker.registry-password Yes Docker Registry password
docker.registry-url Yes Docker Registry URL
docker.registry-email No Docker Registry email
docker.docker-config No Path to Docker Engine configuration files
docker.didEnable No false Enable Docker-in-Docker mode
docker.default-image No docker:latest Default image used when no other image is specified in task or pipeline
docker.volumes[0] No Additional volumes to mount to container. Uses same syntax as Docker -v flag. Example: docker.volumes[0]=/Users/admin/docs:/builds/adminuser/test/docs. Square brackets contain volume numbering index.
docker.volume-driver No local Volume driver to use when creating volumes
docker.volume_driver_ops No Additional options for volume driver
docker.cache_dir No Absolute path to directory for anonymous volumes
docker.disable_cache No false When true, disables local cache for anonymous volumes
docker.privileged No false When true, runs all containers in privileged mode

* Learn more about volume mounting functionality on this page

To work with multiple Docker Registries, specify authorization data as an array:

docker.registries[0].url={URL_1}
docker.registries[0].username={username_1}
docker.registries[0].password={password_1}
docker.registries[1].url={URL_2}
docker.registries[1].username={username_2}
docker.registries[1].password={password_2}

Automatic Translation!

This page has been translated using automated tools. The text may contain inaccuracies.