Browse Source

update readme

main
yggverse 7 months ago
parent
commit
ae5d349f35
  1. 4
      README.md

4
README.md

@ -45,7 +45,7 @@ php src/server.php type=nex host=127.0.0.1 port=1900 root=/target/dir
##### Required ##### Required
* `type` - server protocol, usually auto-define default `port`, available protocols: * `type` - server protocol, also auto-defines default `port`, supported options:
* `nex` - [NEX Protocol](https://nightfall.city/nex/info/specification.txt) * `nex` - [NEX Protocol](https://nightfall.city/nex/info/specification.txt)
* `root` - **absolute path** to the public directory, where browser navigation starting from * `root` - **absolute path** to the public directory, where browser navigation starting from
@ -55,7 +55,7 @@ php src/server.php type=nex host=127.0.0.1 port=1900 root=/target/dir
* `port` - default value depends of server `type` selected, for example `1900` for `nex` or `1965` for `gemini` * `port` - default value depends of server `type` selected, for example `1900` for `nex` or `1965` for `gemini`
* `file` - index **file name** that server try to open on directory path requested, disabled by default * `file` - index **file name** that server try to open on directory path requested, disabled by default
* `list` - show content listing in the requested directory (when index `file` not found), enabled by default * `list` - show content listing in the requested directory (when index `file` not found), enabled by default
* `time` - show file modification time as the alt text in directory listing, disabled by default * `time` - show file modification time as the alt text in directory listing (useful for gemfeed), disabled by default
* `fail` - **absolute path** to the failure template (e.g. `/path/to/error.gmi`), disabled by default * `fail` - **absolute path** to the failure template (e.g. `/path/to/error.gmi`), disabled by default
* `dump` - `enable` or `disable` query log, `enable` by default * `dump` - `enable` or `disable` query log, `enable` by default

Loading…
Cancel
Save