Nastavení Web API

Konfigurace jednotlivých komponent jsou uloženy v souborech ve formátu JSON v adresáři, kde se komponenty nacházejí. Ve výchozím stavu po instalaci nejsou konfigurační soubory k dispozici. V instalačním adresáři IS FLORES jsou v podadresáři ..\Doc\webapi šablony konfiguračních souborů, které slouží ke konfiguraci Web API. Vzorové šablony konfiguračních souborů je nutné nakopírovat do adresáře v instalačním adresáři IS FLORES, přejmenovat je (resp. odstranit koncovku tmpl) a případně je dle potřeby upravit.

Dále je uvedeno, jak konfigurovat jednotlivé části:

ClosedKonfigurace operačního systému

V hostitelském OS je nutno nastavit bránu firewall tak, aby byly dostupné všechny porty, na kterých jednotlivé komponenty Web API naslouchají.

ClosedKonfigurace Workera

Je nutné šablonu vzorového konfiguračního souboru Workera \Doc\webapi\WebAPIWorker.cfg.tmpl přejmenovat (resp. odstranit koncovku tmpl) a nakopírovat do instalačního adresáře systému IS FLORES (tj. např. \IS FLORES\WebAPIWorker.cfg).

Konfigurační direktivy

Jednotlivé direktivy odpovídají názvům vlastností konfiguračního JSON dokumentu. Většinu direktiv je možné měnit pomocí parametrů spuštění souboru, které mají před nastavením v konfiguračním souboru přednost. V konfiguračním JSON dokumentu je nutné dodržet typy parametrů.

Tabulka A1 - Worker - Kořenový konfigurační objekt
Název directivy Typ Parametr spuštění Popis
connection String --connection nebo -c

Název nebo alias výchozího spojení.

Tato direktiva je velmi důležitá - Worker se nespustí, pokud by byl nakonfigurován neplatný název spojení.
username String --username nebo -u

Přihlašovací jméno k výchozímu spojení.

Správnost zadání direktiv username a password naopak již není pro spuštění Workera podstatná, tyto direktivy budou časem odstraněny.
password String --password nebo -p Heslo k výchozímu spojení.
port Integer --port nebo -a

Port, na kterém je služba dostupná.
auth_token String --auth-token nebo -t

Autorizační token systémových požadavků (doporučuje se změnit).
context_timeout Integer --context-timeout

Timeout přihlášení, po kterém dochází k revalidaci přihlašovacího údajů. Udává se v sekundách.
context_clear _period Integer --context-clear-period

Při přihlašování různých uživatelů a přepínání mezi spojeními jsou tyto informace cachovány, tato direktiva ovlivňuje periodu, po které jsou čištěny nepoužívané záznamy. Udává se v sekundách.
roll_cache Boolean  

Zapnutí (true) nebo vypnutí (false) cache číselníků.
ClosedKonfigurace Supervisora

Je nutné šablonu vzorového konfiguračního souboru Supervisora \Doc\webapi\WebAPISupervisor.cfg.tmpl přejmenovat (resp. odstranit koncovku tmpl) a nakopírovat do instalačního adresáře systému IS FLORES (tj. např. \ISFLORES\WebAPISupervisor.cfg).

Supervisor přiřazuje spuštěným Workerům porty, na kterých naslouchají. Pokud je tedy např. nastaven výchozí port 8000 a počet Workerů na 4, je nutno povolit ve firewallu porty 8000-8003.

Konfigurační direktivy

Jednotlivé direktivy odpovídají názvům vlastností konfiguračního JSON dokumentu. Většinu direktiv je možné měnit pomocí parametrů spuštění souboru, které mají před nastavením v konfiguračním souboru přednost. V konfiguračním JSON dokumentu je nutné dodržet typy parametrů.

Tabulka B1 - Supervisor - Kořenový konfigurační objekt
Název directivy Typ Parametr spuštění Popis
  String --config Cesta ke konfiguračnímu souboru (pouze parametr spuštění).
port Integer --port nebo -a

Port, na kterém je Supervisor dostupný.
host_name String --hostname nebo -h

 
min_instances Integer --min-instances

Minimální počet Workerů, které Supervisor udržuje spuštěné.
max_instances Integer --max-instances

Maximální počet Workerů, které Supervisor udržuje spuštěné.
auth_token String --auth-token

Autorizační token systémových požadavků na Supervisora (doporučuje se změnit).
monitor_frequency Integer --monitor-frequency

Perioda monitorování dostupnosti Workerů. Udává se v sekundách.
Worker Object  

Objekt nastavení parametrů spouštěných Workerů – jeho vlastnosti viz Tabulka B2 - Supervisor - Konfigurační objekt Worker.
main_server Object  

Objekt nastavení hlavního serveru (oznamování dostupnosti Workerů), viz Tabulka B3 - Supervisor - Konfigurační objekt main_server.

 

Tabulka B2 - Supervisor - Konfigurační objekt Worker
Název directivy Typ Parametr spuštění Popis
start_port Integer --Worker-start-port Počáteční port přiřazovaný jednotlivým Workerům.
auth_token String --Worker-auth-token Autorizační token systémových požadavků na Workera (změnit podle auth_token Workera).
shutdown_timeout Integer --Worker-shutdown-timeout Čas, po který Supervisor čeká po nitifikaci vypnutí Workera na jeho zastavení; po jeho uplynutí je proces Workera ukončen "natvrdo" (kill). Udává se v sekundách.

 

Tabulka B3 - Supervisor - Konfigurační objekt main_server
Název directivy Typ Parametr spuštění Popis
auth_token String --mainserver-auth-token Autorizační token systémových požadavků na hlavní server (změnit podle auth_token hlavního serveru).
address String --mainserver-address Adresa hlavního serveru (včetně protokolu a portu, např.: http://mainserver.local:80)

 

ClosedKonfigurace serveru

Je nutné šablonu vzorového konfiguračního souboru \Doc\webapi\WebAPIServer.cfg.tmpl přejmenovat (resp. odstranit koncovku tmpl) a nakopírovat do instalačního adresáře systému IS FLORES (tj. např. \ISFLORES\WebAPIServer.cfg).

Konfigurační direktivy

Jednotlivé direktivy odpovídají názvům vlastností konfiguračního JSON dokumentu. Většinu direktiv je možné měnit pomocí parametrů spuštění souboru, které mají před nastavením v konfiguračním souboru přednost. V konfiguračním JSON dokumentu je nutné dodržet typy parametrů.

Tabulka C1 - Server - Kořenový konfigurační objekt
Název directivy Typ Parametr spuštění Popis
  String --cfg-file nebo -c Cesta ke konfiguračnímu souboru (pouze parametr spuštění).
inet_listen String  

IP, na které je server k dispozici.
port Integer  

Port, na kterém server naslouchá.
max_connection Integer  

Maximum otevřených spojení.
connections_per_worker Integer  

Počet spojení navázaných na downstream server (Worker).
auth_token String  

Autorizační token systémových požadavků (doporučuje se změnit).
Supervisors Array  

Pole obsahující konfigurační objekty jednotlivých Supervisorů, viz Tabulka C2 - Konfigurační objekt Supervisors.
hosts_enabled Array  

Pole obsahující konfigurační objekty protokolů domén, viz Tabulka C3 - Konfigurační objekt hosts_enabled.
proxy_connection Array   Pole obsahující konfigurační objekty timeoutů přeposílání, viz Tabulka C4 - Server - Konfigurační objekt proxy_connection.

 

Tabulka C2 - Server - Konfigurační objekt Supervisors
Název Typ Parametr spuštění Popis
url String   URL Supervisora.
auth_token String   Autorizační token systémových požadavků daného Supervisora.

 

Tabulka C3 - Server - Konfigurační objekt hosts_enabled
Název Typ Parametr spuštění Popis
host String   Název domény.
cert_pfx String   Cesta k souboru certifikátu ve formátu PFX.
cert_pem String   Cesta k souboru certifikátu ve formátu PEM.
cert_pem_keyfile String   Cesta k souboru s privátním klíčem certifikátu (při použití certifikátu ve formátu PEM).
cert_ca String   Cesta k souboru certifikační autority (při použití certifikátu ve formátu PEM).
cert_password String   Heslo k certifikátu (privátnímu klíči), společné pro oba formáty certifikátů.

 

Tabulka C4 - Server - Konfigurační objekt proxy_connection
Název Typ Parametr spuštění Popis
timeout integer   Doba vypršení spojení při nečinnosti (v ms); defaultně 60000
connect_timeout integer   Doba vypršení inicializace TCP spojení (v ms); defaultně 100
response_timeout integer   Doba čekání na odpověď (nebo dílčí část odpovědi) (v ms); defaultně 30000
worker_connection_retrieve_timeout integer   Doba čekání na uvolnění spojení pro Workera (v ms); defaultně 5000
ClosedKonfigurace HTTPS

Pro zapnutí HTTPS je třeba v konfiguraci Serveru uvést certifikát, který má být při komunikaci použit. Nastavuje se na objektu Hosta, viz Tabulka C3 - Server - Konfigurační objekt hosts_enabled.

Pozor, pokud není řečeno jinak, předpokládá se, že HTTPS servery naslouchají na portu 443 (nastavuje se direktivou "port" v hlavním objektu konfigurace Serveru, viz Tabulka C1 - Server - Kořenový konfigurační objekt).

Při použití HTTPS je na Serveru možné provozovat pouze jednoho Hosta (doménu).