Skip to content

Installation and Running in a Docker Container

Running Using Docker Compose

  1. Install the Docker Compose plugin for Docker Engine.

  2. Navigate to the GitFlic web interface -> Admin Panel -> CI/CD:

    GitFlic -> Admin Panel -> CI/CD 

    http(s)://<Web interface address>/admin/runners

    Company Settings -> CI/CD Agents* 

    https://gitflic.ru/company/<company_name>/setting/cicd/runners

  3. Copy and save the URL and Token.

    Obtaining the token

  4. Create a docker-compose.yaml file and populate it with the required information: 

    services:  
    runner:  
        container_name: <Container name>  
        image: registry.gitflic.ru/company/gitflic/runner:<Agent version>  
        environment:  
            DOCKER_REGISTRY_USERNAME: "" # Username for Docker registry access  
            DOCKER_REGISTRY_PASSWORD: "" # Password for Docker registry access  
            DOCKER_REGISTRY_URL: "" # Docker registry login URL, e.g., https://registry.gitflic.ru/  
            REG_URL: "" # URL obtained from the GitFlic application  
            REG_TOKEN: "" # Token obtained from the GitFlic application  
            NAME: "" # Sets the agent name. If empty or missing, a random name will be assigned  
            TAGS: "" # Sets tags. If empty or missing, no tags will be applied  
            LOG_LEVEL: INFO # Sets the logging level  
            IN_SESSION: true # Enables or disables script execution in a single context  
            DIDENABLE: false # Enables or disables Docker-in-Docker  
        volumes:  
            - /var/run/docker.sock:/var/run/docker.sock # Mounts the Docker Engine socket  
            - runner-config-additional:/gitflic-runner/etc # Volume for storing agent settings  
        network_mode: host # Docker network mode. Using 'host' is recommended to avoid issues with self-signed certificates  
        restart: always # Container restart policy  
volumes:  
    runner-config-additional:

  5. Start the agent: 

    docker compose -p gitflic-runner -f ./docker-compose.yaml up -d

Running Without Docker Compose

Execute the following command to start the agent: 

docker run \
  --env "REG_URL=<URL obtained from the GitFlic application>" \
  --env "REG_TOKEN=<Agent registration token obtained from the GitFlic interface>" \
  --volume runner-config-additional:/gitflic-runner/etc \
  --volume //var/run/docker.sock://var/run/docker.sock \
  --detach \
  registry.gitflic.ru/company/gitflic/runner:latest

Execute the following command to start the agent: 

docker run \
  --env "REG_URL=<URL obtained from the GitFlic application>" \
  --env "REG_TOKEN=<Agent registration token obtained from the GitFlic interface>" \
  --volume runner-config-additional:/gitflic-runner/etc \
  --volume //var/run/docker.sock://var/run/docker.sock \
  --detach \
  registry.gitflic.ru/company/gitflic/runner:latest

Automated translation!

This page has been automatically translated. The text may contain inaccuracies.