Nocheto HTTP API v 0.3/0.4 / Příklad 0.4
Toto je příklad pro HTTP API verze 0.3 (Nocheto 2.8.0) a verze 0.4 (Nocheto 3.3.0). API v 0.3 je limitováno funkcionalitou Nocheta 2.X, proto ne všechny funkce z tohoto příkladu fungují s touto verzí API.
Příklad v 0.42.8.0 and 2.3.0
Download: http_0.4.zip (Soubor lze stáhnout po přihlášení).
Instalace
Rozbalte zip soubor a přesuňte adresář http/ do adresáře ~/.nocheto/.
Použití
Spusťte nocheto s volbou --future a pak spusťte příkaz
http.
Otevřete http://localhost:8080/ ve svém webovém prohlížeči.
Konfigurace
Toto je popis sekce [http] konfigurace
pro Nocheto 3.3.0.
Pro Nocheto 2.8.0 použijte prosím konfiguraci z
příkladu v 0.3.
Přidejte následující sekci do vašeho konfiguračního souboru
(např. ~/.nocheto/config/nocheto.ini).
Section [http]2.4.0
[http]
port = 8080
address = "127.0.0.1"
whitegrouplist="game;sheet;edit;navigate;properties;analyze;help"
whitelist = "treenumber;quit;listboards;listthemes;listipv4;sync;echo;error"
blacklist = "pgn;pgn+;save;save!;printpgn;printpgn!;printsheet;printsheet!;autoboard;abo;setautoboard;switchsounds;setsounds;aliases"
rootdir = "/home/<your home dir>/.nocheto/http/"
authentication = ""
requestlogfile = ""
Nyní můžete spustit http příkaz a otevřít odpovídající
URL ve vašem internetovém prohlížeči (například http://127.0.0.1:8080/).
port2.4.0
port="8080"
Číslo portu kde bude nocheto očekávat HTTP spojení.
address2.4.0
address="127.0.0.1"
IP adrea kde bude nocheto přijímat HTTP spojení.
Použijte 0.0.0.0 k povolení všech dostupných adres.
whitelist2.4.0
whitelist = "treenumber;quit;listboards;listthemes;listipv4;sync;echo;error"
Seznam povolených příkazů které bude nocheto akceptovat skrze HTTP API.
whitegrouplist3.3.0
whitegrouplist = "game;sheet;edit;navigate;properties;analyze;help"
Seznam skuplin příkazů které bude nocheto akceptovat skrze HTTP API.
Viz příkaz help který vypíše seznam skupin a jejich příkazů.
Poznámka: Tato volba není v Nochetu 2.7.X!.
blacklist3.3.0
blacklist = "pgn;pgn+;save;save!;printpgn;printpgn!;printsheet;printsheet!;autoboard;abo;setautoboard;switchsounds;setsounds;aliases"
Seznam zakázaných příkazů které nebudou akceptovány nochetem skrze HTTP API
i když jsou v whitelist nebo ve skupině v whitegrouplist.
Poznámka: Tato volba není v Nochetu 2.7.X!.
rootdir2.4.0
rootdir = "<$HOME>/.nocheto/http/"
Kořenový adresář pro soubory poskytované nochetem skrze HTTP API.
Defaultní je adresář ~/.nocheto/http/.
authentication3.0.0
authentication = ""
HTTP authentikace v base64 kódování.
Defaultní hodnota je bm9jaGV0bzpub2NoZXRv (=base64('nocheto:nocheto'))
requestlogfile3.0.0
requestlogfile=""
Cesta k souboru do kterého bude nocheto logovat HTTP požadavky (pokud je nastaveno).