Document MD2HTML FastCGI routing and asset URLs
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# MD2HTML
|
# MD2HTML
|
||||||
|
|
||||||
Koverzia Markdown do HTML, pouzitelne aj pre priame zobrazovanie Markdown suborov pomocou webservera.
|
Konverzia Markdown do HTML, pouzitelne aj pre priame zobrazovanie Markdown suborov pomocou webservera.
|
||||||
|
|
||||||
Zdrojove subory su v adresari `src/`:
|
Zdrojove subory su v adresari `src/`:
|
||||||
|
|
||||||
@@ -8,28 +8,58 @@ Zdrojove subory su v adresari `src/`:
|
|||||||
- `src/markdown.css`: styly vystupneho HTML.
|
- `src/markdown.css`: styly vystupneho HTML.
|
||||||
- `src/toc.js`: interaktivny obsah dokumentu bez externych JS zavislosti.
|
- `src/toc.js`: interaktivny obsah dokumentu bez externych JS zavislosti.
|
||||||
|
|
||||||
Zavislosti sa instaluju cez `composer install` v koreni projektu do `vendor/`.
|
Závislosti nainštaluj príkazom `composer install` v koreni projektu.
|
||||||
Konfiguracia NGINX musi smerovat Markdown poziadavky na `src/md2html.php`.
|
Použi PHP 8 alebo novšie s rozšírením mbstring. Projekt môže byť mimo webového koreňa.
|
||||||
CSS sa nacitava z `//localhost/md2html/src/markdown.css`.
|
|
||||||
|
|
||||||
## Konfiguracia NGINX
|
## Konfigurácia NGINX
|
||||||
|
|
||||||
Do prislusneho bloku `server` pridaj:
|
V existujúcom bloku `server` nahraď pôvodné pravidlo pre Markdown a pridaj
|
||||||
|
dve presné pravidlá pre CSS a JavaScript. Príklad pre vihorlat.tpsoft.org:
|
||||||
|
|
||||||
```nginx
|
```nginx
|
||||||
location ~ \.md$ {
|
root /storage/www;
|
||||||
fastcgi_pass 127.0.0.1:9999;
|
|
||||||
fastcgi_param SCRIPT_FILENAME $document_root/md2html/src/md2html.php;
|
location = /_md2html/markdown.css {
|
||||||
|
alias /storage/tpsoft.org/MD2HTML/src/markdown.css;
|
||||||
|
}
|
||||||
|
|
||||||
|
location = /_md2html/toc.js {
|
||||||
|
alias /storage/tpsoft.org/MD2HTML/src/toc.js;
|
||||||
|
}
|
||||||
|
|
||||||
|
location ~* \.md$ {
|
||||||
include fastcgi_params;
|
include fastcgi_params;
|
||||||
|
fastcgi_param SCRIPT_FILENAME /storage/tpsoft.org/MD2HTML/src/md2html.php;
|
||||||
|
|
||||||
|
# Voliteľné povolenie pre existujúci symlink /storage/www/polyanalyzer
|
||||||
|
fastcgi_param MD2HTML_LINK_PREFIX /polyanalyzer/;
|
||||||
|
fastcgi_param MD2HTML_LINK_ROOT /storage/tpsoft.org/polymarket-analyzer/reports;
|
||||||
|
|
||||||
|
fastcgi_pass unix:/run/php/php8.4-fpm.sock;
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Poziadavky na subory s priponou `.md` sa tak spracuju cez `md2html/src/md2html.php`.
|
Uprav socket podľa použitej verzie PHP-FPM. Súbor `fastcgi_params` musí
|
||||||
Konfiguracia predpoklada projekt v adresari `md2html` pod `root` daneho servera
|
odovzdávať `REQUEST_URI $request_uri` a `DOCUMENT_ROOT $document_root`.
|
||||||
(napr. `D:/www/md2html` pri `root D:/www;`) a PHP FastCGI na `127.0.0.1:9999`.
|
Vo Windows použi napríklad `root D:/www;`, absolútne cesty k projektu
|
||||||
Subor `fastcgi_params` musi byt dostupny v konfiguracii NGINX.
|
pod `D:/apps/md2html/src/` a `fastcgi_pass 127.0.0.1:9999;` podľa nastavenia PHP.
|
||||||
|
|
||||||
Po uprave over konfiguraciu prikazom `nginx -t` a nacitaj ju prikazom `nginx -s reload`.
|
PHP vyberá Markdown podľa cesty v URL. Query string vrátane parametra
|
||||||
|
`file` nemá vplyv na výber súboru. Bežné odkazy môžu smerovať na súbory
|
||||||
|
v rámci webového koreňa. Ak URL pod nastaveným prefixom vedie cez symlink
|
||||||
|
mimo koreňa, jeho výsledný súbor musí ležať v zadanom adresári reportov.
|
||||||
|
Ak externý symlink nepotrebuješ, vynechaj oba parametre
|
||||||
|
`MD2HTML_LINK_*`. Účet PHP musí mať právo prejsť do cieľového adresára
|
||||||
|
a čítať súbory.
|
||||||
|
|
||||||
|
Parsedown spracúva aj surové HTML. Webový koreň, povolený cieľ symlinku
|
||||||
|
a ich nadradené adresáre musia spravovať dôveryhodní používatelia.
|
||||||
|
V sprístupnených adresároch publikuj iba dôveryhodný Markdown. Vo Windows
|
||||||
|
použi lokálne cesty s písmenom jednotky a vyhni sa sieťovým UNC cestám
|
||||||
|
a bodom pripojenia zväzkov v publikovanom strome.
|
||||||
|
|
||||||
|
Po úprave over konfiguráciu príkazom `nginx -t` a načítaj ju príkazom
|
||||||
|
`nginx -s reload`.
|
||||||
|
|
||||||
## Obsah dokumentu
|
## Obsah dokumentu
|
||||||
|
|
||||||
@@ -45,9 +75,10 @@ Bez JavaScriptu zostava dokument citatelny, navigacne ovladanie je skryte.
|
|||||||
|
|
||||||
## Testovanie
|
## Testovanie
|
||||||
|
|
||||||
Testy vyzaduju PHP s DOM rozsirenim, nainstalovane Composer zavislosti a Node.js
|
Ak máš lokálnu sadu `tests/`, testy vyžadujú PHP s DOM rozsirenim, nainstalovane Composer zavislosti a Node.js
|
||||||
s podporou `node:test` a `--test-isolation=none`. Nepouzivaju prehliadac ani dalsie balicky.
|
s podporou `node:test` a `--test-isolation=none`. Nepouzivaju prehliadac ani dalsie balicky.
|
||||||
V PowerShelli z korena projektu spusti:
|
PHP fixture musí nastaviť `DOCUMENT_ROOT` a `REQUEST_URI` a očakávať URL
|
||||||
|
pod `/_md2html/`. V PowerShelli z koreňa projektu spusti:
|
||||||
|
|
||||||
```powershell
|
```powershell
|
||||||
php -l src/md2html.php
|
php -l src/md2html.php
|
||||||
|
|||||||
Reference in New Issue
Block a user