Skip to content

Latest commit

 

History

History
115 lines (81 loc) · 6.49 KB

ProductionDeploy.md

File metadata and controls

115 lines (81 loc) · 6.49 KB
Raw

Production deploy

Produkční nasazení není organizováno pomocí Docker kompozice, ale přímo "nativně" (tzn. v Apache + PHP).

Předpoklady

Nezbytné předpoklady jsou:

  • Základní programátorské IT vzdělání, bez toho se nemá smysl do tohoto pouštět.
  • GIT
  • PHP alespoň ve verzi 7.4
  • MySQL databázi ve verzi alespoň 5.6 (např. MariaDB 10)
  • Nainstalovaný balíčkovací nástroj Composer na PATH.

Postup instalace

  1. Naklonujte si repozitář:
    git checkout [email protected]:InstruktoriBrno/tmou-web.git
  2. Nainstalujte závislosti spuštěním composer install --no-dev --optimize-autoloader --no-progress --no-interaction --no-suggest v rootu webu.
  3. Získejte údaje pro připojení do databáze (adresa server, port, jméno, heslo, jméno databáze).
    Pokud databázi nemáte, vytvořte si ji s kódování utf8mb4-czech!
  4. Nastavte možnost zápisu do adresářů temp a log: chmod -R 777 temp log payments (ujistěte se, že oprávnění má i proces webového serveru).
  5. Vytvořte lokální konfiguraci App/Config/local.neon, viz local.neon.template, zde nastavte údaje pro přístup k databázi, recaptchu, adresu na které web poběží, maily...
  6. Smažte obsah adresáře temp/cache.
  7. Spusťe databázové migrace pro zajištění aktuálnosti databáze: php bin/console migrations:migrate a DB proxy objektů pro líné načítání z databáze php bin/console orm:generate-proxies (a případně php bin/console orm:clear-cache:metadata).
  8. Nakonfigurujte Apache tak, aby používal správnou verzi PHP a DocumentRoot směřoval do složky www.
  9. Přistupte skrze prohlížeč na nakonfigurovanou doménu a otestujte základní funkčnost webu.
  10. Ověřte, že citlivé soubory nejsou dostupné zvenčí, obzvláště soubor App/Config/local.neon.
  11. Nastavte CRON pro automatické párování plateb, viz samostatná sekce níže.
  12. Ověřte, že ve složce /www/storage nelze přistupovat soubory .php ani .phtml, protože tato složka slouží k nahrávání obsahu, který by neměl být za žádných okolností spouštěn. (Mělo by být nastaveno automaticky v /www/storage/.htaccess.)
  13. Ověřte, že nastavení PHP, že je nastaveno alespoň post_max_size=20M a upload_max_filesize=20M. (Mělo být nastaveno automaticky v /.htaccess.)

Postup aktualizace

  1. Odstavte web (viz níže Režim údržby).
  2. Zazálujte celou databázi před začátkem aktualzace.
  3. Aktualizujte repozitář na požadovanou verzi (pozor na neverzované změny!)
  4. Doinstalujte a aktualizujte závislosti dle požadavku dané verze pomocí composer install --no-dev --optimize-autoloader --no-progress --no-interaction --no-suggest.
  5. Smažte obsah adresáře temp/cache, v produkčním režimu se keš sama přegenerovává jen pokud chybí! (Bez toho by aplikace nemusela vůbec naběhnout, nebo by fungovala jako ve staré verzi.)

Režim údržby

Web má připravený režim údržby (via .htaccess v kořenové složce projektu), pro jeho zapnutí stačí vytvořit v kořenové složce projektu soubor pojmenovaný UNDER_MAINTENANCE, který zapříčiní zobrazení .maintenance.php na všechny požadavky.

Pro přístup během údržby je potřeba ve svém prohlížeči a na správné adrese vytvořit ve svém prohlížeči ve vývojářských nástrojích cookie s názvem SKIP_MAINTENANCE a hodnotu true. Po obnovení stránky by se web měl zobrazit, pokud ne, zkontrolujte přesnou shodu domény, platnost cookie a parametry ohledně její striktnosti.

Pro ukončení stačí soubor UNDER_MAINTENANCE odstranit.

Composer

Pokud nemáte composer na PATH, nebo v systému máte příliš starý, můžete vyřešit problém lokální instalací (resp. stažením souboru PHAR a jeho spouštěním), viz návod.

Poté namísto composer <action> spouštíte php composer.phar <action>. Oba způsoby jsou ekvivalentní.

Keycloak

Je třeba vytvořit tmou-web klienta, správně nastavit:

  • Root URL
  • Valid Redirect URL
  • Base URL (jako absolutní cestu bez hostname)
  • Admin URL
  • Web origins

Taktéž je potřeba změnit Access Type na confidential. V Mappers je potřeba vytvořit Groups mapper, který bude do tokenů přidávat pod klíčem groups informace o skupinách uživatele.

Uživatelům, kteří mají mít přístup do TMOU webu je potřeba přidat zařazení do skupiny Organizátoři TMOU nebo tmou_org (přesná shoda).

Automatizovaná aktualizace výsledků kvalifikace

Systém obsahuje kešovaný výpočet výsledků kvalifikace, což umožňuje ho případně během hry zobrazovat hráčům, aniž by to zatěžovalo databázi. Tento výpočet je potřeba spouštět pravidelně, ideálně každých 5 minut. Pro jednoduchost je připraven skript bin/console update-qualification-scoreboards, který je potřeba spouštět pravidelně.

* * * * * /path/to/project/bin/console update-qualification-scoreboards >/dev/null 2>&1

Automatické párování plateb

Systém obsahuje automatizované párování plateb, tomu je potřeba zajistit automatizované spouštění, nejlépe via CRON:

# Run payment matching at 3:35 (AM) every day for the previous day
YESTERDAY=`php -r "echo date('Y-m-d', time() - 60 * 60 * 24);"`
CRON_KEY=<CRON_KEY>
35 3 * * * wget "https://www.tmou.cz/cron/payments?apiKey=$CRON_KEY&start=$YESTERDAY&end=$YESTERDAY" >/dev/null 2>&1

Pro jednoduchost (a kompatibilitu s různými nástroji CRON) také připraven skript payments/match-previous-day-payments.sh a tedy stačí použít

35 3 * * * bash <PROJECT_PATH>/payments/match-previous-day-payments.sh >/dev/null 2>&1

Pro správnou funkčnost je potřeba v souboru local.latte nastavit hodnotu cron.key, kterou použijete v příkazu výše a fio.token, jejíž hodnotu získáte od správce příslušného účtu (stačí token pouze ke čtení).

Po nasazení ručně spusťte období, které chcete dopárovat, ideálně nepřekrývající se s budoucími běhy automtaického párování.

Více informací o fungování najdete v párování plateb.

Zasílání e-mailů na selhání

Logovací systém (Tracy) umí zasílat při selhání e-mail, pro zapnutí této funkcionality je potřeba do App/Config/local.neon přidat následující kód (nebo přidat do již existující sekce):

tracy:
    email:
        - [email protected]
        - [email protected]