Nastavení status.php stránky pre sledovaní funkcií FormFlow

Na adrese WEB_ROOT/status.php je pripravená status stránka, ktorá pri načítaní vykoná čiastkové kontroly fungovania FormFlow a zobrazí ako výsledky týchto kontrol, tak celkový stav, ktorý bude strážený systémom Nagios.

Kompletné informácie o stave FormFlow sa zobrazia iba špeciálnemu používateľovi „nagios“ pre ktorého sa generuje prístupové heslo – viď Nastavenie prístupových údajov.

Pokiaľ dôjde k zisteniu chybového stavu, stavová stránka status.php vyhodnotí tento stav tým, že zobrazí informáciu o probléme a následne ešte odošle upozornenie na nastavený email.

image223

Nastavenie prístupových údajov

Stavová stránka status.php, ktorú kontroluje Nagios, je basic autentizovaná. Ako používateľské meno sa vo všetkých prípadoch používa „nagios“, heslo je nastavené pre každú inštaláciu FormFlow zvlášť a je v šifrovanej podobe uložené v databáze FormFlow.

Nastavenie hesla (aj opakovane) sa vykonáva pomocou skriptu utils\set_nagios_pass.php. Používa sa nasledovne:

php set_nagios_pass.php [dĺžka hesla]

Parameter [dĺžka hesla] je nepovinný. Pokiaľ nie je zadaný, vygeneruje sa heslo s dĺžkou 32 znakov. Je možné vygenerovať heslo v rozmedzí 16–128 znakov. Ak je zadaná dĺžka kratšia ako 16 znakov, generuje sa heslo s minimálnou povolenou dĺžkou 16 znakov. Ak je zadaná dĺžka väčšia ako 128 znakov, generuje sa heslo s maximálnou povolenou dĺžkou 128 znakov. Od 15.7.2021 sa pre jednoduchšie použitie heslo novo generuje iba z alfanumerických znakov.

Po vygenerovaní je heslo v šifrovanej podobe uložené do databázy a je zobrazené používateľovi nešifrovane. Je vhodné si takto zobrazené heslo bezpečne uložiť. Po zatvorení konzolového okna už nie je možné heslo opätovne zobraziť. V prípade potreby je možné vygenerovať rovnakým postupom nové heslo.

Zapnutie / vypnutie jednotlivých kontrol

Štandardne sa vykonávajú všetky implementované kontroly a ich výsledok sa zobrazí po úspešnej autentizácii na stavovej stránke status.php. Nastavením parametrov v htdocs\config.php je možné vykonávanie jednotlivých kontrol potlačiť – nastavením jednotlivých parametrov na hodnotu false.

Príklady použitia:

  • Vypnutie kontroly databázovej schémy:
    define('XMLGW_STP_CHECK_DB_SCHEMA', false);

  • Vypnutie kontroly behu master služby: define('XMLGW_STP_CHECK_MASTER_SERVICE', false);

  • Vypnutie kontroly behu služieb podriadených master službe: define('XMLGW_STP_CHECK_SERVICES', false);

  • Vypnutie kontroly certifikátov: define('XMLGW_STP_CHECK_CERTIFICATES', false);

  • Vypnutie kontroly FAS: define('XMLGW_STP_CHECK_FAS', false);

  • Vypnutie kontroly SFLF: define('XMLGW_STP_CHECK_SFLF', false);

  • Vypnutie kontroly elektronických schránok: define('XMLGW_STP_CHECK_DS', false);

  • Vypnutie kontroly voľného miesta v úložisku: define('XMLGW_STP_CHECK_DISC_SPACE', false);

  • Vypnutie kontroly webových služieb (konverzia dokumentov a SecuSign ws): define('XMLGW_STP_CHECK_WS', false);

Všetky tieto parametre majú implicitnú hodnotu true, pokiaľ nie je v config.php nastavené inak, a teda vykonávanie jednotlivých kontrol je v implicitnom stave zapnuté.

Zmena 15.7.2021 – voľné miesto je strážené na všetkých diskoch, ktoré FormFlow využíva. Bola pridaná možnosť nastaviť úroveň voľného miesta na disku pre varovanie a ohlásenie chyby. Implicitne sa nastavuje stav WARNING, pokiaľ na niektorom z diskov zostáva menej ako 10 GB voľného priestoru. Pri poklese pod 5 GB je nastavený stav ERROR. Tieto úrovne je možné nastaviť pomocou konfiguračných parametrov:

  • Úroveň pre level WARNING (v GB): define('XMLGW_STP_DISC_SPACE_LEVEL_WARNING', 50);

  • Úroveň pre level ERROR (v GB): define('XMLGW_STP_DISC_SPACE_LEVEL_WARNING', 20);

Nastavenie emailovej adresy pre zasielanie notifikácii – pre ladenie

Ak je počas kontroly konverzie dokumentov a funkčnosti SecuSign SDK nájdená chyba, dochádza k automatickému odoslaniu notifikácie o nájdenej chybe na emailové adresy administrátorov FormFlow. Pre ladenie a testovanie je možné v config.php nastaviť testovaciu emailovú adresu. Ak je táto adresa nastavená, notifikácie o nájdenej chybe sa odosielajú iba na uvedenú adresu a neobťažujú administrátorov FormFlow. Po ukončení ladenia a testovania je vhodné tento parameter s config.php zmazať – odosielanie notifikácií bude opäť prebiehať na emailové adresy všetkých administrátorov FormFlow.

Príklad nastavenia testovacej emailovej adresy pre notifikácie o chybách konverzie a SecuSign SDK:

define('XMLGW_WS_CHECKER_DEBUG_NOTIF_MAIL_ADDRESS', 'nejaká+adresa@602.cz');