mirror of
https://github.com/YGGverse/next.git
synced 2025-03-11 21:21:05 +00:00
update readme
This commit is contained in:
parent
01c6825b92
commit
832d40c6a3
42
README.md
42
README.md
@ -5,20 +5,40 @@ PHP 8 Server for [Nex Protocol](nex://piclog.blue/nex/info/specification.txt), b
|
||||
## Install
|
||||
|
||||
* `git clone https://github.com/YGGverse/next.git`
|
||||
* `cd next`
|
||||
* `composer update`
|
||||
* `cd next` - navigate the server directory
|
||||
* `composer update` - get latest dependencies
|
||||
|
||||
## Start
|
||||
## NEX
|
||||
|
||||
Optimal to serve static files
|
||||
|
||||
For security reasons, next server prevents any access to the hidden files (started with dot)
|
||||
|
||||
### Start
|
||||
|
||||
Create as many servers as wanted by providing separated `host` and `port` using optional arguments
|
||||
|
||||
``` bash
|
||||
php src/nex.php\
|
||||
host=127.0.0.1\
|
||||
port=1900\
|
||||
path=/path/to/dir
|
||||
php src/nex.php host=127.0.0.1 port=1900 path=/target/dir
|
||||
```
|
||||
|
||||
### Options
|
||||
#### Arguments
|
||||
|
||||
* `host` - optional string, `127.0.0.1` by default
|
||||
* `port` - optional int, `1900` by default
|
||||
* `path` - required string, destination files location (public folder)
|
||||
##### Required
|
||||
|
||||
* `path` - **absolute path** to the public directory
|
||||
|
||||
##### Optional
|
||||
|
||||
* `host` - `127.0.0.1` by default
|
||||
* `port` - `1900` by default
|
||||
* `file` - index **file name** that server try to open in path requested, disabled by default
|
||||
* `fail` - failure **file path** that contain template (e.g. `error.gmi`) for the error handler, `fail` text by default
|
||||
* `list` - show content listing in the requested directory (when index file not found or not defined), enabled by default
|
||||
* `size` - limit request length in bytes, `1024` by default
|
||||
* `dump` - dump server queries, keep argument value blank to disable, default mask: `[{time}] [{code}] {host}:{port} {path}`
|
||||
* `{time}` - event time in `c` format
|
||||
* `{code}` - formal response code: `1` - found, `0` - not found
|
||||
* `{host}` - peer host
|
||||
* `{port}` - peer port
|
||||
* `{path}` - path requested
|
||||
|
Loading…
x
Reference in New Issue
Block a user