Rola Ansible gitea/forgejo

Ta rola instaluje i zarządza gitea lub forgejo. Jest to prosta, samodzielnie hostowana usługa Git. Gitea to rozwiązanie do hostingu kodu, zarządzane przez wspólnotę, napisane w Go. Forgejo to jego fork.
Źródło kodu i zrzuty ekranu gitea.
Źródło kodu forgejo.
Ta rola jest częścią kolekcji Ansible l3d.git.

Lustra

Rola jest lustrzana w:

• Github: github.com/roles-ansible/ansible_role_gitea
• Gitea: git.l3d.ch/ansible/ansible_role_gitea
  Więcej informacji na ansible.l3d.space

Przykładowe użycie w playbooku

Poniższy kod został przetestowany na najnowszym Debian Stable i powinien działać również na Ubuntu i RedHat.

# ansible-galaxy role install l3d.gitea

- name: "Zainstaluj gitea"
  hosts: git.example.com
  roles:
    - {role: l3d.gitea, tags: gitea}
  vars:
    gitea_fqdn: 'git.example.com'
    gitea_root_url: 'https://git.example.com'
    gitea_protocol: http
    gitea_start_ssh: true

Wybór między wbudowanym SSH Gitea a serwerem SSH gospodarza

Gitea ma wbudowany serwer SSH, który działa na porcie 2222 (aby nie kolidował z serwerem SSH gospodarza, który zwykle działa na porcie 22). Domyślnie jest on używany w tej roli, co skutkuje SSH URL klonowania w postaci gitea@<fqdn>:2222:<user>/<repo>.git, ponieważ gitea jest domyślnym użytkownikiem RUN_AS.

Często jednak chcemy mieć „czysty” adres URL SSH, np. git@<fqdn>:<user>/<repo>.git. Można to osiągnąć, używając serwera SSH gospodarza z następującą konfiguracją zmiennych:

gitea_ssh_port: 22 # zakładając, że serwer SSH gospodarza działa na porcie 22
gitea_user: git # w przeciwnym razie wystąpią problemy z uprawnieniami
gitea_start_ssh: false # aby nie uruchamiać wbudowanego serwera SSH

Powyższa konfiguracja działa od razu w nowych instalacjach. Podczas migracji z działającego serwera z istniejącymi kluczami SSH z wbudowanego serwera SSH do serwera SSH gospodarza, musisz upewnić się, że serwer SSH gospodarza działa oraz że gitea_user ma odpowiednie uprawnienia do dostępu do danych repozytoriów i kluczy (przechowywanych w <gitea_home>/.ssh/).

Zwróć uwagę: Aby używać git@ jak opisano powyżej, gitea_user musi być git i nie wystarczy ustawić gitea_ssh_user: git. Zobacz ten problem po więcej informacji.

Zmienne

Oto bliższe spojrzenie na zmienne tej roli gitea. Aby poznać dokładne funkcje niektórych zmiennych oraz możliwość dodania większej ilości opcji, zalecamy zapoznanie się z tym arkuszem oszustw.

Wybór między gitea a forgejo

Istnieje fork gitea nazwany forgejo. Dlaczego? Przeczytaj FAQ forgejo.
Możesz wybrać między gitea a forgejo, modyfikując zmienną gitea_fork.

mechanizm aktualizacji gitea

Aby określić, którą wersję gitea zainstalować, możesz wybierać między dwiema wersjami.
Możesz dokładnie określić, którą wersję zainstalować lub użyć opcji latest, aby zainstalować najnowszą wersję z wydań gitea.

mechanizm aktualizacji Forgejo

Zaleca się dokładne określenie, którą wersję Forgejo chcesz zainstalować. Zobacz Wydania Forgejo po poprawną wartość do użycia w gitea_version, np. v1.21.5.
Dzieje się tak, ponieważ projekt Forgejo utrzymuje zarówno wersje stable, jak i old stable, a znacznik latest będzie odnosił się do najnowszego wydania bez względu na to, czy jest to stable, czy old stable. Może to prowadzić do sytuacji, w której latest odnosi się do starszego wydania niż wersja, którą masz zainstalowaną.

aktualizacja gitea

gitea w światzie linuxa

Ogólnie (DOMYŚLNE)

Repozytorium (repozytorium)

Repozytorium - Przesyłanie (repository.upload)

Repozytorium - Podpisywanie (repository.signing)

CORS (cors)

UI (ui)

UI - Meta (ui.meta)

Serwer (server)

Baza danych (database)

Indeksator (indexer)

Bezpieczeństwo (security)

Usługa (service)

Mailer (mailer)

Sesja (session)

Obrazek (picture)

Załączniki do zgłoszeń i pull requestów (attachment)

Dziennik (log)

Metryki (metrics)

OAuth2 (oauth2)

Federacja (federation)

Pakiety (packages)

LFS (lfs)

Akcje (actions)

Inne (other)

dodatkowa konfiguracja gitea

Konfiguracja Fail2Ban

Jeśli włączone, to wdroży filtr fail2ban oraz konfigurację więzienia dla Gitea, jak opisano w Dokumentacji Gitea.

Ponieważ wdroży to tylko pliki konfiguracyjne, fail2ban musi być już zainstalowany, w przeciwnym razie rola zakończy się niepowodzeniem.

lokalni użytkownicy gitea

opcjonalne dostosowanie

Możesz opcjonalnie dostosować swój gitea, używając tej roli ansible. Informacje o dostosowaniach uzyskaliśmy z docs.gitea.io/en-us/customizing-gitea.
Aby wdrożyć wiele plików, utworzyliśmy zmienną gitea_custom_search, która może wskazać na ścieżkę, w której umieściłeś własne pliki gitea (domyślnie "files/host_files/{{ inventory_hostname }}/gitea").

• LOGO:
  • Ustaw gitea_customize_logo na true
  • Szukamy:
    • logo.svg - Używane jako favicon, ikona strony, ikona aplikacji
    • logo.png - Używane w Open Graph
    • favicon.png - Używane jako fallback dla przeglądarek, które nie obsługują symboli SVG
    • apple-touch-icon.png - Używane w urządzeniach iOS jako zakładki
  • Szukamy w (używając first_found):
    • {{ gitea_custom_search }}/gitea_logo/
    • files/{{ inventory_hostname }}/gitea_logo/
    • files/{{ gitea_http_domain }}/gitea_logo/
    • files/gitea_logo/
• STOPKA:
  • Ustaw gitea_customize_footer na true
  • Szukamy używając first_found w:
    • "{{ 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'
• WŁASNE PLIKI:
  • Ustaw gitea_customize_files na true
  • Utwórz katalog z plikami, które chcesz wdrożyć.
  • Wskaź gitea_customize_files_path na ten folder. (Domyślny {{ gitea_custom_search }}/gitea_files/)
• WŁASNE MOTYWY:
  • Ustaw gitea_custom_themes jako listę z adresami URL dla plików CSS własnych motywów. Zwykle chcesz trzech indywidualnych plików na motyw. Przykład:

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

  • Ustaw zmienną gitea_themes i uwzględnij nazwy nowych motywów. Aby zachować istniejące, musisz przekazać wszystkie nazwy motywów, np. auto,gitea,arc-green,<custom-auto>,<custom-light>,<custom-dark>

Wymagania

Ta rola korzysta z kolekcji ansible.builtin i community.general. Aby pobrać najnowsze wydanie forgejo/gitea, korzystamy z json_query. To wymaga, aby jmespath było dostępne.

Pakiety Pythona

• jmespath

Kolekcje Galaxy

• community.general

Przykład instalacji wymagań

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

Wnieś wkład

Nie wahaj się stworzyć pull requesta, a jeśli masz wątpliwości, możesz skontaktować się ze mną na Mastodon @[email protected].

Będę zadowolony, że naprawię wszelkie problemy, które zgłosisz, a co lepsze, przejrzę twoje pull requesty :)

Historia tej roli

Ta rola ansible została pierwotnie opracowana na github.com/thomas-maurice/ansible-role-gitea. Ponieważ ta rola ma pewne problemy, takie jak domyślne wartości dla lokalizacji repozytoriów gitea, a scalanie pull requestów zwykle trwa kilka miesięcy, stworzono fork roli, który oferuje podobne funkcje. Tyle że w bardziej uporządkowany sposób i stara się szybciej reagować na problemy i pull requesty. Jest ona teraz częścią kolekcji l3d.git.