GitFlic

https://docs.gitflic.ru/latest/
Admin
GitFlic is a DevOps and source code collaboration platform that provides Git repository management,...
Tokens:894,726
Snippets:4,148
Trust Score:9.9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install Composer utility

Source: https://docs.gitflic.ru/latest/registry/composer

Install Composer using the official setup script if it is not already installed.

```bash
php composer-setup.php --install-dir=bin --filename=composer
```

--------------------------------

### Start pipeline response example

Source: https://docs.gitflic.ru/latest/api/cicd

Example JSON response for the POST /project/{ownerAlias}/{projectAlias}/cicd/pipeline/start endpoint.

```json
{

        "pipeline_uuid": "c5d94105-aaaa-aaaa-aaaa-f88a6e947b4e"

        }
```

--------------------------------

### Install Maven (Ubuntu/Debian)

Source: https://docs.gitflic.ru/latest/registry/maven

Installs Maven if the 'mvn --version' check fails. Use this command to proceed with the registry setup.

```bash
sudo apt install maven

```

--------------------------------

### GET request example

Source: https://docs.gitflic.ru/latest/project/scripts/scripts

Example of a GET request to the GitFlic REST API with authorization headers.

```javascript
const url = '${baseurl}/user/me'
req = http.get(url,{ headers: { "Authorization": `token ${gitflicApiToken}` }});

console.log(JSON.stringify(req))
req.code
```

--------------------------------

### Install Tantor SE

Source: https://docs.gitflic.ru/latest/setup/gitflic_app/astra_setup_and_start

Steps to copy the package, install it, initialize the database, and manage the service.

```bash
scp tantor-*.deb <username>@<ip>:~/ 
```

```bash
sudo apt install ./tantor-*.deb
```

```bash
sudo -iu postgres
/opt/tantor/db/14/bin/initdb -D /var/lib/postgresql/tantor-se-14/data/
exit
```

```bash
systemctl start tantor-*.service
systemctl enable tantor-*.service
```

```bash
sudo systemctl status tantor-*.service
```

--------------------------------

### GET /user Response Example

Source: https://docs.gitflic.ru/latest/api/user

Example JSON response for the GET /user endpoint, which returns a paginated list of users.

```json
{
    "_embedded": {
        "userList": [
            {
                "id": "7cda0fdc-aaaa-aaaa-aaaa-6b0bfe8bbddf",
                "username": "user1",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/4427cf28-aaaa-aaaa-aaaa-8ee5e6b3a467.jpg",
                "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
            },
            {
                "id": "166e63d7-aaaa-aaaa-aaaa-e46b43e29c21",
                "username": "user2",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/197869df-aaaa-aaaa-aaaa-d2442372699c.jpg",
                "cover": "/upload/img/33fxd0r1-aaaa-aaaa-aaaa-9e7er56jtdbb.jpg"
            },
            {
                "id": "03105a7f-aaaa-aaaa-aaaa-e87cd6ee60b2",
                "username": "user3",
                "name": "name",
                "surname": "surname",
                "fullName": "name surname",
                "avatar": "https://gitflic.ru/upload/img/17e7bcfe-aaaa-aaaa-aaaa-aabce41d7259.jpg",
                "cover": "/upload/img/23d7g0d1-aaaa-aaaa-aaaa-tf45gd7ftd6b.jpg"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 3,
        "totalPages": 1,
        "number": 0
    }
}
```

--------------------------------

### Initialize module and download with go get

Source: https://docs.gitflic.ru/latest/registry/go

Initialize a new Go module and download a package from a GitFlic repository using go get.

```bash
go mod init mynewproject
go get <выбранный url репозитория>

```

--------------------------------

### Get pipeline artifacts response example

Source: https://docs.gitflic.ru/latest/api/cicd

Example JSON response for the GET /project/{ownerAlias}/{projectAlias}/cicd/pipeline/{localId}/artifacts endpoint.

```json
{
    "_embedded": {
        "restPipelineJobArtifactModelList": [
            {
                "id": "g4i6tfl6-aaaa-aaaa-aaaa-i4t0707fl194",
                "fileType": "metadata",
                "size": 125667,
                "expireAt": "2023-06-13T15:40:26.145095Z",
                "fileName": "d00c197c-aaaa-aaaa-aaaa-a902b51f230f.log",
                "downloadUrl": "api.gitflic.ru/project/username/projectname/cicd/job/1/artifact/g4i6tfl6-aaaa-aaaa-aaaa-i4t0707fl194/download",
                "jobLocalId": 1
            }
        ]
    },
    "page": {
        "size": 1,
        "totalElements": 1,
        "totalPages": 1,
        "number": 0
    }
}
```

--------------------------------

### Use the installed package

Source: https://docs.gitflic.ru/latest/registry/julia

Commands to load and use the HelloWorld package.

```julia
using HelloWorld
HelloWorld.greeting()

```

--------------------------------

### Application startup log output

Source: https://docs.gitflic.ru/latest/setup/cli

Example of the log output indicating the application has successfully started and is ready for input.

```text
2024-02-22 14:36:32.630  INFO 7 --- [           main] o.s.i.channel.PublishSubscribeChannel    : Channel 'application.errorChannel' has 1 subscriber(s).
2024-02-22 14:36:32.631  INFO 7 --- [           main] o.s.i.endpoint.EventDrivenConsumer       : started bean '_org.springframework.integration.errorLogger'
shell:>
```

--------------------------------

### Get SSH Key Response Example

Source: https://docs.gitflic.ru/latest/api/admin

Example JSON response for a successful GET request to retrieve a user's SSH key information.

```json
{
            "uuid":"0dee836e-aaaa-aaaa-aaaa-65318059de1f"
            "publicKey":"ssh-ed25519 AAAAC3NzaC1lZFHNRPTE5AAAAIDkxja/2VmTEsJDTtf3bI4XYDpb58fvKfSjy7/u8EZeI your_email@gitflic.ru"
            "title":"Название ключа"
            "expiresAt":"2020-10-10T10-10-10Z"
            "userUuid":"f1a94466-aaaa-aaaa-aaaa-744ec3bbd60c"
        }
```

--------------------------------

### Response example for getting a repository by UUID

Source: https://docs.gitflic.ru/latest/api/registry-repository

Example JSON response for a successful (200) request to get a single repository by its UUID. Contains the repository details.

```json
{
    "title": "generic-local",
    "repositoryType": "LOCAL",
    "repositoryUuid": "b24769db-aaaa-aaaa-aaaa-a3006f0271f6",
    "packageType": "generic",
    "description": "Локальный репозиторий generic реестра",
}
```

--------------------------------

### Install Go with apt

Source: https://docs.gitflic.ru/latest/registry/go

Install the Go programming language on a Debian-based system using the apt package manager.

```bash
sudo apt install golang-go

```

--------------------------------

### Create project: POST /project response JSON

Source: https://docs.gitflic.ru/latest/api/project

Example response for creating a project. Contains project details including id, title, alias, defaultBranch, workBranch, owner, language, and transport URLs.

```json
{
    "id": "2f58c38f-aaaa-aaaa-aaaa-3819c74b2c36",
    "title": "my project",
    "description": "description",
    "alias": "example",
    "defaultBranch": "master",
    "workBranch": "master",
    "siteUrl": null,
    "owner": {
        "alias": "example-user",
        "type": "USER"
    },
    "language": "java",
    "forEducation": false,
    "forkedFromId": null,
    "pullMirrorUrl": null,
    "allowedMemory": "4GB",
    "forkUrl": null,
    "httpTransportUrl": "https://gitflic.ru/project/example-user/example.git",
    "sshTransportUrl": "git@gitflic.ru:example-user/example.git",
    "topics": [
        "gitflic"
    ],
    "private": true,
    "mirror": false
}
```

--------------------------------

### GET /team/{teamAlias} response example

Source: https://docs.gitflic.ru/latest/api/team

Example JSON response for the GET /team/{teamAlias} endpoint, which returns the details of a specific team identified by its alias.

```json
{
                "id": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "alias": "gitflic",
                "title": "gitflic",
                "description": "description",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/065abe2c-aaaa-aaaa-aaaa-3ffebd3a4f28.jpg",
                "private": false,
                "selectorTitle": "gitflic",
                "selectorId": "2bee3ea6-aaaa-aaaa-aaaa-2d98d59e71f7",
                "selectorOwnerAlias": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null,
                "hexColor": null
            }
```

--------------------------------

### GET /user/me Response Example

Source: https://docs.gitflic.ru/latest/api/user

Example JSON response for the GET /user/me endpoint, which returns the details of the currently authenticated user including their email address.

```json
{
    "id": "fbc3d462-aaaa-aaaa-aaaa-6990c978d786",
    "username": "user1",
    "name": "name",
    "email": "email@email.ru"
    "surname": "surname",
    "fullName": "name surname",
    "avatar": "https://gitflic.ru/upload/img/2731a61f-aaaa-aaaa-aaaa-a5ac13429653.jpg",
    "cover": "/upload/img/3b7780f1-aaaa-aaaa-aaaa-97e55d7bbdbb.jpg"
}
```

--------------------------------

### Response for GET package file list

Source: https://docs.gitflic.ru/latest/api/registry-repository

Example JSON response showing a list of repository package files with metadata and pagination details.

```json
{
    "_embedded": {
        "repositoryPackageFileModelList": [
            {
                "id": "f54229e0-aaaa-aaaa-aaaa-7b28d4cba269",
                "name": "package-name-1.0.0",
                "size": 5000,
                "hashMd5": "99bad348daaaaaaaaaaaa8bfd64a6b36",
                "hashSHA1": "eff19953294243aaaaaaaaaaaa198276da1d6b08",
                "hashSHA256": "d7a08a99b2502f0bb68cd4e1f9aaaaaaaaaaaad3208bd0f73366c03fc3548a42",
                "hashSHA512": "ec795b2f32982c1af8dccef57553aa9d959c13ee829aebd6459ba22b4eaaaaaaaaaaaaa89f63ad2f0d8c45d59cd020a15cd976ddb4bf20f1044b492a406e029e",
                "packageUploadType": "TRANSPORT",
                "createdAt": "2025-01-01T12:00:00.000000",
                "nodeUuid": "5b359e3a-aaaa-aaaa-aaaa-66ea4c74f3f3"
            },
            {
                "id": "0d66c254-aaaa-aaaa-aaaa-a629539389a4",
                "name": "package-name-1.0.1",
                "size": 5005,
                "hashMd5": "2abd6856baaaaaaaaaaaadfb52f4df68",
                "hashSHA1": "4a2b7185be9155aaaaaaaaaaaaef2f15e0f4fffd",
                "hashSHA256": "fa68451ea830572ed43ffe51d7aaaaaaaaaaaa65a602a51f49d6be02063a65f3",
                "hashSHA512": "e1c4acc68f7114cd501754d07e51a9345bc1106623ea9e38cd6d40b188aaaaaaaaaaaa27da9d71da608b6691ef1f9d75d11253567350fbb4a949770a1cb7023e",
                "packageUploadType": "TRANSPORT",
                "createdAt": "2025-01-10T12:00:00.000000",
                "nodeUuid": "ab2ca6ba-aaaa-aaaa-aaaa-d733290b6f7d"
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}
```

--------------------------------

### GET release by UUID - Example Response

Source: https://docs.gitflic.ru/latest/api/release

Example JSON response for GET /project/{ownerAlias}/{projectAlias}/release/{releaseUuid} with status 200. Contains release details including attachment files with hashes.

```json
{
    "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
    "title": "Название",
    "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
    "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
    "description": "Описание",
    "tagName": "2.14.5",
    "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
    "createdAt": "2024-05-17T09:59:30.635513Z",
    "updatedAt": "2024-05-17T09:59:30.635515Z",
    "attachmentFiles":[
        {
            "name": "file.zip",
            "uuid": "8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
            "link": "https://gitflic.ru/project/user/test_project/release/d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680/file/8b8bdd4e-aaaa-aaaa-aaaa-1f95b8fae217",
            "size": 158267,
            "hashMd5": "fff118534ecd753fc31ffh8ccb48e4c4",
            "hashSha1": "d3b911c9ccdffc0de2c5ge8ae4907aa5ef00aa86",
            "hashSha256": "33645ddcc7d5add5df70d27e59cef069d52887d6f3d41eec104eda3d1e7221b7",
            "hashSha512": "261c9efed1f692f16127r6c02c045ae3779da7c7cf8c8f20ef81f9988e7f6b4414630cc2020011bcfe2aab2372d4cb7ded9985433cd68da42e571b83526c48c6"
        }
    ],
    "preRelease": true
}
```

--------------------------------

### Get Pipeline Lifetime Settings Response

Source: https://docs.gitflic.ru/latest/api/cicd

Example JSON response returned by the GET pipeline-lifetime endpoints.

```json
{
    "lifetime": 90,
    "ownerType": "COMPANY",
    "uuid": "986313a5-aaaa-aaaa-aaaa-56f719abb3a0",
    "enabled": true
}
```

--------------------------------

### Get OAuth Application Response

Source: https://docs.gitflic.ru/latest/api/settings

Example JSON response returned by the GET /user/settings/oauth/{id} endpoint.

```json
{
  "id": "7f8933c7-aaaa-aaaa-aaaa-dbc99a7cd104",
  "name": "Название",
  "description": "Описание",
  "clientId": "649947ce-aaaa-aaaa-aaaa-b4efb56bf198",
  "clientSecret": "650e54fa-aaaa-aaaa-aaaa-de6665173bf0",
  "homepageUrl": "https://example.com",
  "authCallbackUrl": "https://example.com",
  "standalone": false
}
```

--------------------------------

### Example import-tfs command

Source: https://docs.gitflic.ru/latest/services/tfs_migration

A concrete example of the import-tfs command using a specific archive path.

```bash
import-tfs \
--archive-path ./gitflic-tfs-migration-700000000.zip \
--owner-email test@test.ru
```

--------------------------------

### POST create release - Example Response

Source: https://docs.gitflic.ru/latest/api/release

Example JSON response for POST /project/{ownerAlias}/{projectAlias}/release with status 200. Contains release details with attachmentFiles set to null.

```json
{
    "id": "d7750f4a-aaaa-aaaa-aaaa-954eeb8e3680",
    "title": "Название",
    "projectId": "c94aedd2-aaaa-aaaa-aaaa-67fbf1112a82",
    "authorId": "8473a25a-aaaa-aaaa-aaaa-3e5c9e0a4b51",
    "description": "Описание",
    "tagName": "2.14.5",
    "commitId": "59de8c0611304aaaaaaaaaaaaac05f90483c6dfb",
    "createdAt": "2024-05-17T09:59:30.635513Z",
    "updatedAt": "2024-05-17T09:59:30.635515Z",
    "attachmentFiles": null,
    "preRelease": true
}
```

--------------------------------

### GET /company Response Example

Source: https://docs.gitflic.ru/latest/api/company

Example JSON response for a successful request to retrieve a list of public companies.

```json
{
    "_embedded": {
        "companyList": [
            {
                "id": "7c7e495a-aaaa-aaaa-aaaa-68becefbde5f",
                "alias": "testovaya-kompaniya",
                "title": "тестовая компания",
                "description": "Пример описания",
                "url": "test1.com",
                "contactPhone": null,
                "contactEmail": "user@gitflic.ru",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/6c482659-aaaa-aaaa-aaaa-d4086f2d8251.jpg",
                "private": false,
                "selectorTitle": "тестовая компания",
                "selectorId": "7c7e495a-aaaa-aaaa-aaaa-68becefbde5f",
                "selectorOwnerAlias": null,
                "hexColor": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null,
            },
            {
                "id": "f931a10b-aaaa-aaaa-aaaa-16f4d4decda1",
                "alias": "publichnaya-kompaniya",
                "title": "публичная компания",
                "description": "Пример описания",
                "url": null,
                "contactPhone": "+79991234567",
                "contactEmail": "user@gitflic.ru",
                "ownerAlias": "user1",
                "avatar": "https://gitflic.ru/upload/img/4b0fab04-aaaa-aaaa-aaaa-ec70560fcae2.jpg",
                "private": false,
                "selectorTitle": "публичная компания",
                "selectorId": "f931a10b-aaaa-aaaa-aaaa-16f4d4decda1",
                "selectorOwnerAlias": null,
                "hexColor": null,
                "selectorAlias": null,
                "selectorColor": null,
                "selectorHash": null,
            }
        ]
    },
    "page": {
        "size": 10,
        "totalElements": 2,
        "totalPages": 1,
        "number": 0
    }
}
```

--------------------------------

### Загрузка пакета целиком для уровня проекта

Source: https://docs.gitflic.ru/latest/registry/cran

Команда install.packages для установки пакета из реестра GitFlic на уровне проекта. В URL подставьте значения переменных: packageName, username, транспортный токен, домен gitflic, ownerAlias, projectAlias.

```r
install.packages('{packageName}', repos='https://{username}:{транспортный токен}@{домен gitflic}/project/{ownerAlias}/{projectAlias}/package/-/cran')

```

--------------------------------

### Configure Project.toml

Source: https://docs.gitflic.ru/latest/registry/julia

Example Project.toml configuration for the generated package. Replace uuid, authors, and version as needed.

```toml
[package]
name = "MyNewPackage"
uuid = "уникальный-uuid-модуля"
authors = ["username <contactEmail>"]
version = "0.1.0"

[compat]
julia = "1.10"

```

--------------------------------

### GET Merge Request Method Response Example

Source: https://docs.gitflic.ru/latest/api/mergeRequest

Example response returned when querying the merge request method type.

```json
"MERGE_COMMIT"
```

--------------------------------

### POST create release - Request Body Example

Source: https://docs.gitflic.ru/latest/api/release

Example JSON body for POST /project/{ownerAlias}/{projectAlias}/release. Includes title, description, tagName, preRelease, attachProjectArchive, and projectArchiveFormat (zip).

```json
{
    "title": "Название",
    "description": "Описание",
    "tagName": "2.14.5",
    "preRelease": true,
    "attachProjectArchive": true,
    "projectArchiveFormat": zip
}
```

--------------------------------

### Get Merge Request Templates Response

Source: https://docs.gitflic.ru/latest/api/mergeRequest

Example JSON response for the GET request to retrieve merge request templates.

```json
{
    "mergeCommitMessage": "Сообщение для merge commit",
    "squashCommitMessage": "Сообщение для squash commit",
    "mergeRequestDescriptionTemplate": "Стандартный текст для описания запроса на слияние",
    "canEditMergeCommitMessage": true
}
```

--------------------------------

### Get Merge Request Discussion Response Example

Source: https://docs.gitflic.ru/latest/api/mergeRequestDiscussion

Example JSON response returned when successfully retrieving a merge request discussion.

```json
{
    "discussionUuid": null,
    "baseCommit": "e07892271de5c4aaaaaaaaaaaa5d1913c453d45d",
    "targetCommit": "e07892271de5c4aaaaaaaaaaaa5d1913c453d45d",
    "startCommit": "8ab2acb852f4beaaaaaaaaaaaa3b0f9cf1b4943c",
    "createdAt": "2025-01-01T12:00:00.00000Z",
    "newLine": 10,
    "oldLine": 10,
    "initialNewLine": 10,
    "newPath": "README.md",
    "oldPath": "README.md",
    "rawMessage": "Поправить здесь",
    "message": "Поправить здесь",
    "resolved": true,
    "resolvable": null,
    "mergeRequestUuid": "b7741169-aaaa-aaaa-aaaa-88714b46c558",
    "type": "MERGE_REQUEST_COMMENT",
    "author": {
        "id": "6736240a-aaaa-aaaa-aaaa-cab026562172",
        "username": "adminuser",
        "name": "Admin user",
        "surname": null,
        "fullName": "Admin user",
        "avatar": "https://gitflic.ru/static/image/avatar.jpg",
        "cover": "https://gitflic.ru/static/image/user-cover.png"
    },
    "uuid": "a6bd97a8-aaaa-aaaa-aaaa-2729e030844f",
    "formatedDate": "1 час назад"
}
```
Tokens:
Raw