moon
/
enigma-bbs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Formatting

This commit is contained in:
Bryan Ashby 2020-06-07 11:34:33 -06:00
parent 571c8b7b64
commit fd86293dbe
No known key found for this signature in database
GPG Key ID: B49EB437951D2542
1 changed files with 25 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
docs/servers/websocket.md
View File

@ -6,11 +6,9 @@ title: Web Socket / Web Interface Server
The WebSocket Login Server provides **secure** (wss://) as well as non-secure (ws://) WebSocket login access. This is often combined with a browser based WebSocket client such as VTX or fTelnet. The WebSocket Login Server provides **secure** (wss://) as well as non-secure (ws://) WebSocket login access. This is often combined with a browser based WebSocket client such as VTX or fTelnet.
# VTX Web Client # VTX Web Client
ENiGMA supports the VTX websocket client for connecting to your BBS from a web page. Example usage can be found at ENiGMA supports the VTX websocket client for connecting to your BBS from a web page. Example usage can be found at [Xibalba](https://xibalba.l33t.codes) and [fORCE9](https://bbs.force9.org/vtx/force9.html) amongst others.
[Xibalba](https://l33t.codes/vtx/xibalba.html) and [fORCE9](https://bbs.force9.org/vtx/force9.html).
## Before You Start ## Before You Start
There are a few things out of scope of this document: There are a few things out of scope of this document:
- You'll need a web server for hosting the files - this can be anywhere, but it obviously makes sense to host it - You'll need a web server for hosting the files - this can be anywhere, but it obviously makes sense to host it
@ -27,31 +25,31 @@ There are a few things out of scope of this document:
1. Enable the websocket in ENiGMA, by adding `webSocket` configuration to the `loginServers` block in `config.hjson` (create it if you 1. Enable the websocket in ENiGMA, by adding `webSocket` configuration to the `loginServers` block in `config.hjson` (create it if you
don't already have it defined). don't already have it defined).
````hjson ````hjson
loginServers: { loginServers: {
webSocket : { webSocket : {
ws: { ws: {
// non-secure ws:// // non-secure ws://
port: 8810 port: 8810
enabled: true enabled: true
// optional bind address // optional bind address
address: 127.0.0.1 address: 127.0.0.1
} }
wss: { wss: {
// secure-over-tls wss:// // secure-over-tls wss://
port: 8811 port: 8811
enabled: true enabled: true
certPem: /path/to/https_cert.pem certPem: /path/to/https_cert.pem
keyPem: /path/to/https_cert_key.pem keyPem: /path/to/https_cert_key.pem
} }
// set proxied to true to allow TLS-terminated proxied connections // set proxied to true to allow TLS-terminated proxied connections
// containing the "X-Forwarded-Proto: https" header to be treated // containing the "X-Forwarded-Proto: https" header to be treated
// as secure // as secure
proxied: true proxied: true
} }
} }
```` ````
2. Restart ENiGMA and check the logs to ensure the websocket service starts successfully, you'll see something like the 2. Restart ENiGMA and check the logs to ensure the websocket service starts successfully, you'll see something like the
following: following: