Конфигурация application.properties
В данном разделе находится информация о параметрах application.properties файла.
Конфигурация сервера
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| server.port | да | 8080 | порт, на котором будет запущено приложение Gitflic. |
| server.address | да | localhost | IP-адрес, на котором будет доступно приложение Gitflic |
| ssh.server.port | да | 22 | порт, на котором будет запущен ssh сервер для обращения по remote-url |
| spring.servlet.multipart.maxFileSize | нет | 500MB | размер загружаемых файлов в формах и запросах api |
| spring.servlet.multipart.maxRequestSize | нет | 500MB | отвечает за размер запроса |
Конфигурация баз данных
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| spring.datasource.url | да | jdbc:postgresql://localhost/gitflic | url для подключения к postgres |
| spring.datasource.username | да | gitflic | имя пользователя для аутентификации в postgres |
| spring.datasource.password | да | gitflic | пароль пользователя для аутентификации в postgres |
| spring.redis.host | да | localhost | адрес, на котором запущен redis |
| spring.redis.port | да | 6379 | порт, на котором запущен redis |
| spring.redis.username | нет | имя пользователя для аутентификации в redis | |
| spring.redis.password | нет | пароль для аутентификации в redis | |
| spring.redis.database | нет | 0 | номер базы данных в redis |
| spring.redis.ssl | нет | false | использование https протокола для обращения к redis |
| spring.redis.url | нет | указать полный URL для соединения с Redis. Если указан URL для соединения, то параметры spring.redis.host, spring.redis.port, и spring.redis.password будут перезаписаны из URL.Параметр user будет проигнорирован. |
Настройки директорий, используемых для работы приложения
*Пути к директориям должны заканчиваться на /
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| ssh.server.cert | да | /opt/gitflic/cert/key.pem | отвечает за путь к сертификату(с указанием имени файла), который используется для ssh транспорта |
| repository.dir | да | /var/gitflic/repo/ | директория, где должны храниться репозитории git |
| image.upload.dir | да | /var/gitflic/img/ | директория, где должны храниться аватары и иные медиафайлы |
| releases.upload.dir | да | /var/gitflic/releases/ | директория, где должны храниться файлы, которые приложены к релизу на основе тегов git |
| cicd.pipeline.dir | да | /var/gitflic/cicd/ | директория, которая используется CI/CD агентом |
| gitflic.registry.package.dir | да | /var/gitflic/registry/ | директория, где должны находиться файлы реестра пакетов |
| audit.event-log.dir | нет | {путь_до_директории_с_gitflic.jar}/audit | директория, где должны находиться файлы логов аудита |
Настройка SMTP сервера
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| spring.mail.host | да | smtp.foo.bar | адрес SMTP сервера |
| spring.mail.port | да | 587 | порт SMTP сервера |
| spring.mail.username | да | foo@bar.net | имя пользователя для аутентификации на SMTP сервере |
| spring.mail.password | да | Superp@$$word | пароль для аутентификации на SMTP сервере |
| smtp.sender.name | нет | foobar | имя отправителя письма |
| smtp.sender.email | нет | foo@noreply.bar | email отправителя письма |
| spring.mail.properties.mail.smtp.starttls.enable | нет | false | использовать tls |
| spring.mail.properties.mail.smtp.ssl.enable | нет | false | использовать ssl |
| spring.mail.properties.mail.smtp.auth | нет | false | использование аутентификации |
Общие свойства приложения
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| gitflic.system.dashboard.enabled | нет | true | Отключение анализа системы в панели администратора Доступно в версии 3.0.0 и выше |
| gitflic.base.url | да | http://localhost:8080 | отвечает за генерацию ссылок для внешних источников, например для ссылок в письмах. При отсутствии протокола передачи данных по умолчанию будет использоваться https:// |
| gitflic.transport.url | да | http://localhost:8080 | отвечает за генерацию ссылки, которая отображается на странице каждого проекта и приходит в данных из методов API и в данных вебхуков |
| gitflic.coordinator.url | нет | совпадает с gitflic.base.url | переопределяет протокол, домен и порт которые используются для генерации ссылок на регистрацию для агентов CI/CD, используется если развернут отдельный координатор |
| gitflic.defaultPackSize | нет | 100MB | ограничивает максимальный размер пакета, который гит может отправить во время пуша в репозиторий. Возможны следующие суффиксы KB, MB, GB, TB. |
| gitflic.limitPackSize | нет | false | |
| gitflic.limitProjectSize | нет | false | |
| logging.file.name | нет | /var/log/gitflic/server.log | директория (с указанием имени файла), где хранится файл с логами |
| logging.level.root | нет | INFO | Уровень логирования* |
| gitflic.ci-cd.config-processing.max-job-variable-count | нет | 1000 | Максимальное количество переменных для задачи, включая предопределенные |
| gitflic.ci-cd.config-processing.job-variables-size-limit-characters | нет | 262144 | Ограничение на общее количество символов переменных (ключ + значение), включая предопределенные |
| gitflic.ci-cd.runners.global-properties.enabled | нет | false | Разрешение изменения параметров агента true или false (для нижеследующих свойств) |
| gitflic.ci-cd.runners.global-properties.log-limit-kilobytes | нет | 100 | Максимальный размер логов для всех агентов в килобайтах. Возможны значения от 10 до 25600 КБ. Настройка активна только при указании значения true для параметра gitflic.ci-cd.runners.global-properties.enabled |
| gitflic.ci-cd.runners.global-properties.job-variables-size-limit-characters | нет | нет | Ограничение на общее количество символов переменных (ключ + значение) для всех агентов. Настройка активна только при указании значения true для параметра gitflic.ci-cd.runners.global-properties.enabled |
*Таблица уровней логирования
| Параметр | Значение |
|---|---|
| OFF | логирование выключено |
| ERROR | показывает ошибки значительной важности, которые мешают нормальному выполнению программы |
| WARN | показывает предупреждения |
| INFO | показывает информационные сообщения, которые могут иметь смысл для конечных пользователей и системных администраторов, сопровождая ход работы приложения |
| DEBUG | показывает детальное отслеживание, используемое разработчиками приложений |
| ALL | вывод всех сообщений |
Конфигурация RabbitMQ
Используется в enterprise medium/full сборке.
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| spring.rabbitmq.host | нет | localhost | адрес RabbitMQ сервера |
| spring.rabbitmq.port | нет | 5672 | порт RabbitMQ сервера |
| spring.rabbitmq.username | нет | имя пользователя для аутентификации в RabbitMQ | |
| spring.rabbitmq.password | нет | пароль пользователя для аутентификации в RabbitMQ |
*Дополнительные настройки для соединения с RabbitMQ можно посмотреть по данной ссылке
Конфигурация Elasticsearch
Используется в enterprise full сборке.
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| elasticsearch.rest | нет | localhost:9200 | адрес соединения с Elasticsearch |
| elasticsearch.useSsl | нет | false | использование протоколом SSL сертификата |
| elasticsearch.username | нет | имя пользователя для аутентификации в Elasticsearch | |
| elasticsearch.password | нет | пароль пользователя для аутентификации в Elasticsearch | |
| elasticsearch.connection-timeout | нет | 1 | установка времени таймаута на соединение |
| elasticsearch.read-timeout | нет | 30 | установка времени таймаута на чтение |
Конфигурация Telegram интеграции
| Параметр | Обязательный | Значение по умолчанию | Описание |
|---|---|---|---|
| telegram.webhook.host | нет | URL-адрес для Telegram webhook, используемый при регистрации бота | |
| telegram.bot.token | нет | Токен доступа Telegram бота | |
| secret.telegram.token | нет | Токен обеспечивающий безопасный доступ к вашему Telegram боту |