Configuration and Launch of GitFlic Runner Agent
Agent Registration
Before launching the agent, it must be registered.
*All commands below should be executed from the agent's working directory!
1. Access the GitFlic web interface: Admin Panel → CI/CD
http(s)://<Web Interface Address>/admin/runners
* For agent registration on GitFlic.ru, go to Company Settings → CI/CD Agents
https://gitflic.ru/company/<company_name>/setting/cicd/runners
2. Copy and save the URL and Token
3. Execute the registration command
java -jar runner.jar register --url <url> --registration-token <token>
| Parameter | Required | Description |
|---|---|---|
--url <url> |
Yes | URL copied in step 2 |
--registration-token <token> or --token <token> |
Yes | Token copied in step 2 |
--name <name> |
No | Agent name |
--tags <tags> |
No | Agent tags (comma-separated) |
--default-config <defaultConfig> |
No | Path to Docker Engine config files |
--docker-image <defaultDockerImage> |
No | Default container image |
--docker-volumes <dockerVolumes>[;<dockerVolumes>...] |
No | Additional container volumes |
--registry-url <registry-url> |
No | Docker Registry URL |
--registry-user <registry-user> |
No | Docker Registry username |
--registry-password <registry-password> |
No | Docker Registry password |
- Upon successful registration, the web interface will show the connected agent.
- A config directory containing application.properties will be created.
4. Add runner.executor (agent type) and logging.file.name (log file) parameters to application.properties
shell
sed -i '1 i\runner.executor=shell\nlogging.file.name=data/log/server.log' config/application.properties
powershell
Add-Content $env:USERPROFILE/gitflic-runner/config/application.properties "runner.executor=powershell" ; Add-Content config/application.properties "logging.file.name=data/log/server.log"
*See parameter description for details.
Launching the Agent
Execute the startup command:
java -jar runner.jar start --config=config/application.properties
--config= specifies the configuration file location.
Automatic Translation!
This page has been translated using automated tools. The text may contain inaccuracies.