ansible роль gitea/forgejo

Эта роль устанавливает и управляет gitea или forgejo. Это удобный и безболезненный самохостинг Git-сервис. Gitea - это управляемое сообществом легковесное решение для хостинга кода, написанное на Go. Forgejo - это его форк. Исходный код и скриншоты gitea. Исходный код forgejo. Эта роль также является частью Ansible-коллекции l3d.git. .

Зеркала

Роль доступна на следующих ресурсах:

• Github: github.com/roles-ansible/ansible_role_gitea
• Gitea: git.l3d.ch/ansible/ansible_role_gitea Подробнее об этом можно узнать на ansible.l3d.space

Пример использования в плейбуке

Следующий код был протестирован с последней стабильной версией Debian и должен работать и на Ubuntu, и на RedHat.

# ansible-galaxy role install l3d.gitea

- name: "Установить gitea"
  hosts: git.example.com
  roles:
    - {role: l3d.gitea, tags: gitea}
  vars:
    # Предполагаем, что мы находимся за обратным прокси, который
    # будет обрабатывать HTTPS для нас, поэтому мы подключаемся к localhost:3000 по HTTP
    # см. https://docs.gitea.io/en-us/reverse-proxies/#nginx
    gitea_fqdn: 'git.example.com'
    gitea_root_url: 'https://git.example.com'
    gitea_protocol: http
    gitea_start_ssh: true

Выбор между встроенным SSH Gitea и SSH-сервером хоста

Gitea имеет встроенный SSH-сервер, который работает на порту 2222 (чтобы не конфликтовать с сервером SSH хоста, который обычно работает на порту 22). Этот сервер используется по умолчанию в этой роли и приводит к SSH URL клонирования вида gitea@<fqdn>:2222:<user>/<repo>.git, где gitea - это пользователь по умолчанию.

Часто возникает желание иметь "чистый" SSH URL, например, git@<fqdn>:<user>/<repo>.git. Это возможно, если использовать сервер SSH хоста с помощью следующей конфигурации переменных:

gitea_ssh_port: 22 # предполагаем, что сервер SSH хоста работает на порту 22
gitea_user: git # иначе будут проблемы с правами доступа
gitea_start_ssh: false # чтобы не запускать встроенный SSH сервер

Вышеуказанная конфигурация работает из коробки для новых установок. При миграции с работающей инстанции с уже существующими SSH-ключами от встроенного SSH-сервера к SSH-серверу хоста, необходимо убедиться, что сервер SSH хоста работает и что gitea_user имеет необходимые права доступа к данным репозитория и ключам (хранятся в <gitea_home>/.ssh/)

Примечание: Чтобы использовать git@, как описано выше, gitea_user должен быть установлен в git, и недостаточно установить gitea_ssh_user: git. Смотрите эту проблему для получения дополнительной информации.

Переменные

Вот более подробный взгляд на переменные этой роли gitea. Для точного функционала некоторых переменных и возможности добавления дополнительных параметров мы рекомендуем ознакомиться с этим cheat sheet.

Выбор между gitea и forgejo

Существует форк gitea, который называется forgejo. Почему? Читайте вопросы и ответы forgejo. У вас есть возможность выбирать между gitea и forgejo, изменяя переменную gitea_fork.

Механизм обновления gitea

Чтобы определить, какую версию gitea установить, вы можете выбрать между двумя вариантами. Либо вы точно указываете, какое обновление хотите установить. Либо вы используете опцию latest, чтобы всегда устанавливать последнюю версию из релизов gitea.

Механизм обновления Forgejo

Рекомендуется точно определить, какую версию Forgejo вы хотите установить. Смотрите релизы Forgejo для правильного значения, которое нужно использовать в gitea_version, например, v1.21.5.

Это связано с тем, что проект Forgejo поддерживает как stable, так и old stable релизы, а тег latest будет относиться к самой недавней версии независимо от того, является ли она stable или old stable. Это может привести к ситуации, когда latest будет ссылаться на более старую версию, чем версия, которую вы установили.

Обновление gitea

gitea в мире linux

В целом (DEFAULT)

Репозиторий (repository)

Репозиторий - Загрузка (repository.upload)

Репозиторий - Подпись (repository.signing)

CORS (cors)

UI (ui)

UI - Мета (ui.meta)

Сервер (server)

База данных (database)

Индексатор (indexer)

Безопасность (security)

Служба (service)

Отправка почты (mailer)

Сессия (session)

Изображение (picture)

Вложения к проблемам и запросам на объединение (attachment)

Лог (log)

Метрики (metrics)

OAuth2 (oauth2)

Федерация (federation)

Пакеты (packages)

LFS (lfs)

Действия (actions)

Прочее (other)

дополнительная конфигурация gitea

Конфигурация Fail2Ban

Если включено, это развернет фильтр fail2ban и конфигурацию заключения для Gitea, как описано в Документации Gitea.

Так как это будет только развертывание файлов конфигурации, fail2ban уже должен быть установлен, иначе роль завершится с ошибкой.

Локальные пользователи gitea

Опциональные настройки

Вы можете опционально настроить свой gitea, используя эту ansible роль. Мы получили информацию о настройках с docs.gitea.io/en-us/customizing-gitea. Чтобы развернуть несколько файлов, мы создали переменную gitea_custom_search, которая может ссылаться на путь, где вы разместили пользовательские файлы gitea (по умолчанию"files/host_files/{{ inventory_hostname }}/gitea").

• ЛОГОТИП:
  • Установите gitea_customize_logo в true
  • Мы ищем:
    • logo.svg - Используется для фавикона, значка сайта, значка приложения
    • logo.png - Используется для Open Graph
    • favicon.png - Используется в качестве резервного варианта для браузеров, которые не поддерживают SVG фавиконы
    • apple-touch-icon.png - Используется на устройствах iOS для закладок
  • Мы ищем в (с использованием first_found):
    • {{ gitea_custom_search }}/gitea_logo/
    • files/{{ inventory_hostname }}/gitea_logo/
    • files/{{ gitea_http_domain }}/gitea_logo/
    • files/gitea_logo/
• НИЖНИЙ КОЛОНТИТУЛ:
  • Установите gitea_customize_footer в true
  • Мы ищем, используя first_found в:
    • "{{ gitea_custom_search }}/gitea_footer/extra_links_footer.tmpl"
    • "files/{{ inventory_hostname }}/gitea_footer/extra_links_footer.tmpl"
    • "files/{{ gitea_http_domain }}/gitea_footer/extra_links_footer.tmpl"
    • 'files/gitea_footer/extra_links_footer.tmpl'
    • 'files/extra_links_footer.tmpl'
• ПОЛЬЗОВАТЕЛЬСКИЕ ФАЙЛЫ:
  • Установите gitea_customize_files в true
  • Создайте каталог с файлами, которые вы хотите развернуть.
  • Укажите gitea_customize_files_path на этот каталог. (По умолчанию {{ gitea_custom_search }}/gitea_files/)
• ПОЛЬЗОВАТЕЛЬСКИЕ ТЕМЫ:
  • Установите gitea_custom_themes в список URL для пользовательских файлов CSS тем. Обычно вы хотите три отдельных файла на тему. Пример:

    gitea_custom_themes:
      - https://example.com/theme-custom-auto.css
      - https://example.com/theme-custom-dark.css
      - https://example.com/theme-custom-light.css
    

  • Установите переменную gitea_themes и включите названия новых тем. Чтобы сохранить существующие, вам нужно указать все названия тем, например, auto,gitea,arc-green,<custom-auto>,<custom-light>,<custom-dark>

Требования

Эта роль использует сборки ansible.builtin и community.general ansible. Для загрузки последнего релиза forgejo/gitea мы используем json_query. Это требует наличия jmespath.

Python пакеты

• jmespath

Galaxy Collections

• community.general

Пример установки требований

ansible-galaxy collection install --update --role-file requirements.yml
pip3 install --update jmespath

Вклад

Не стесняйтесь создавать запрос на изменение, и если у вас есть сомнения, вы можете связаться со мной на Mastodon @[email protected].

Я с радостью исправлю любые проблемы, которые вы поднимете, или, что еще лучше, рассмотрю ваши запросы на изменения :)

История этой роли

эта ansible роль изначально разрабатывалась на github.com/thomas-maurice/ansible-role-gitea. Поскольку там есть некоторые проблемы, такие как значения по умолчанию для расположения репозиториев gitea, а слияние запросов на слияние обычно занимает несколько месяцев, был создан форк роли, который предлагает то же самое. Только аккуратнее и с намерением быстрее реагировать на проблемы и запросы на слияние. Это теперь также является частью коллекции l3d.git.