https://github.com/yggverse/next
PHP 8 Server for Nex Protocol
https://github.com/yggverse/next
1900 composer nex nex-php nex-protocol nex-server next
Last synced: 5 months ago
JSON representation
PHP 8 Server for Nex Protocol
- Host: GitHub
- URL: https://github.com/yggverse/next
- Owner: YGGverse
- License: mit
- Created: 2024-04-26T14:42:57.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-26T15:00:46.000Z (over 1 year ago)
- Last Synced: 2024-04-26T16:06:28.960Z (over 1 year ago)
- Topics: 1900, composer, nex, nex-php, nex-protocol, nex-server, next
- Homepage:
- Size: 1.95 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# next
PHP 8 server for different protocols
Based on [Ratchet](https://github.com/ratchetphp/Ratchet) asynchronous socket library
## Features
* Async socket
* Multi-host
* Multi-protocol:
* [x] [NEX](https://nightfall.city/nex/info/specification.txt)
* [ ] [Gemini](https://geminiprotocol.net)
* Multi-mode:
* [x] Static file hosting
* [x] filesystem navigation on directory request
* [x] optional `gemfeed` file modification date
* [x] unicode filenames support
* [x] filter hidden context (started with dot)
* [ ] sort order settings (currently dir first, asc)
* [x] custom index file name
* [x] custom failure template
* [x] custom data directory location
* [x] KevaCoin storage browser
* [ ] Custom application
* [ ] Reverse proxy
* [ ] Stream server
* Connection event log
* Simple and flexible server configuration by CLI arguments
## Install
### Environment
``` bash
apt install git composer php-fpm php-mbstring
```
* for `kevacoin` server `mode`, also required `php-curl` extension
### Stable
Project under development, use [repository](#repository) version!
### Repository
* `git clone https://github.com/YGGverse/next.git`
* `cd next` - navigate into the project directory
* `composer update` - grab latest dependencies
## Launch
### Start
Create as many servers as wanted by providing different `type`, `host`, `port`, `type`, `mode` and other arguments!
* for security reasons, file server prevents any access to the hidden files (started with dot)
* also, clients can't access any data out the `root` path, that defined on server startup
#### Startup example
``` bash
php src/server.php host=127.0.0.1 port=1900 type=nex mode=fs root=/target/dir
```
* `host` and `port` - optional arguments, read [Arguments documentation](#arguments) for details!
#### Arguments
Optional arguments auto-defined by server protocol `type` selected
Some arguments also defined in [default.json](https://github.com/YGGverse/next/blob/main/default.json) - do not change it without understanding, use [CLI](#cli) instead!
##### CLI
Provide arguments in `key=value` format, separated by space
Children nodes dependent of parent arguments defined and would be skipped in other combinations!
Following list explains `key` dependencies and it `value` options (started with `=`)
* `type` - required, server protocol, also auto-defines default `port`, supported options:
* = `nex` - [NEX Protocol](https://nightfall.city/nex/info/specification.txt)
* `mode` - optional, server implementation variant, `fs` (filesystem) by default
* = `fs` - static files hosting for the `root` location
* `root` - **absolute path** to the public directory, where browser navigation starting from
* `file` - **file name** that server try to open on directory path requested, disabled by default
* `list` - show listing in directory requested (on index `file` not found), enabled by default
* `date` - show file modification date (as gemfeed) in directory listing, disabled by default
* = `kevacoin` - [KevaCoin](https://github.com/kevacoin-project) storage browser by RPC connection to the wallet (see `kevacoin.conf`)
* `rpcscheme` - required, for example `http`
* `rpcport` - required, default is `9992`
* `rpchost` - required, remote or `localhost`
* `rpcuser` - required
* `rpcpassword` - required
* `namespace` - required, remote or local namespace for data listing (started with `N`)
* `host` - optional, default is `127.0.0.1` e.g. `localhost` connections only
* `port` - optional, default value depends of server `type` selected e.g. `1900` for `nex` or `1965` for `gemini`
* `fail` - optional, **absolute path** to the failure template (e.g. `/path/to/error.gmi`), disabled by default
* `dump` - optional, `enable` or `disable` server debug feature, enabled by default
### Autostart
#### systemd
Following example mean you have `next` server installed into home directory of `next` user (`useradd -m next`)
``` next.service
# /etc/systemd/system/next.service
[Unit]
After=network.target
[Service]
Type=simple
User=next
Group=next
ExecStart=/usr/bin/php /home/next/next/src/server.php type=nex mode=fs root=/home/next/public
StandardOutput=file:/home/next/debug.log
StandardError=file:/home/next/error.log
Restart=on-failure
[Install]
WantedBy=multi-user.target
```
* `systemctl daemon-reload` - reload systemd configuration
* `systemctl enable next` - enable service on system startup
* `systemctl start next` - start server