mirror of
https://github.com/kevachat/npsapp.git
synced 2025-01-29 16:24:17 +00:00
update readme
This commit is contained in:
parent
f09e3c0ec4
commit
782db626c2
38
README.md
38
README.md
@ -30,25 +30,6 @@ To read messages, use KevaChat [webapp](https://github.com/kevachat/webapp), [ge
|
|||||||
|
|
||||||
* `php src/app.php name.json` - where `name.json` argument is any config, placed at `config` folder
|
* `php src/app.php name.json` - where `name.json` argument is any config, placed at `config` folder
|
||||||
|
|
||||||
## Proxy
|
|
||||||
|
|
||||||
Like [NEX protocol](https://nightfall.city/nex/info/specification.txt), NPS data could be simply passed using any proxy server that support TCP forwarding
|
|
||||||
|
|
||||||
### Nginx
|
|
||||||
|
|
||||||
* `sudo nano /etc/nginx/nginx.conf`
|
|
||||||
|
|
||||||
``` /etc/nginx/nginx.conf
|
|
||||||
stream {
|
|
||||||
server {
|
|
||||||
listen 1915;
|
|
||||||
proxy_pass 127.0.0.1:1915;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
* `sudo service nginx restart`
|
|
||||||
|
|
||||||
### Autostart
|
### Autostart
|
||||||
|
|
||||||
Launch server as the `systemd` service
|
Launch server as the `systemd` service
|
||||||
@ -80,6 +61,25 @@ WantedBy=multi-user.target
|
|||||||
3. `sudo systemctl enable npsapp` - enable `npsapp` service on system startup
|
3. `sudo systemctl enable npsapp` - enable `npsapp` service on system startup
|
||||||
4. `sudo systemctl start npsapp` - start `npsapp` server
|
4. `sudo systemctl start npsapp` - start `npsapp` server
|
||||||
|
|
||||||
|
## Proxy
|
||||||
|
|
||||||
|
Like [NEX Protocol](https://nightfall.city/nex/info/specification.txt), NPS data could be simply passed using any proxy server that support TCP forwarding
|
||||||
|
|
||||||
|
### Nginx
|
||||||
|
|
||||||
|
* `sudo nano /etc/nginx/nginx.conf`
|
||||||
|
|
||||||
|
``` /etc/nginx/nginx.conf
|
||||||
|
stream {
|
||||||
|
server {
|
||||||
|
listen 1915;
|
||||||
|
proxy_pass 127.0.0.1:1915;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
* `sudo systemctl restart nginx`
|
||||||
|
|
||||||
## Clients
|
## Clients
|
||||||
|
|
||||||
* `nc 127.0.0.1 1915` - IPv4 only, install `netcat-openbsd` to add IPv6 support
|
* `nc 127.0.0.1 1915` - IPv4 only, install `netcat-openbsd` to add IPv6 support
|
||||||
|
Loading…
x
Reference in New Issue
Block a user