MTS/yjs-backend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #42 from openculinary/server/bind-host-variable

Browse Source 
Add HOST environment variable to configure websocket-server bind address
This commit is contained in:
Kevin Jahns 2021-01-06 13:14:43 +01:00 committed by GitHub
commit 3ab927f38a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -85,10 +85,10 @@ wsOpts = {
Start a y-websocket server:
```sh
PORT=1234 npx y-websocket-server
HOST=localhost PORT=1234 npx y-websocket-server
```
Since npm symlinks the `y-websocket-server` executable from your local `./node_modules/.bin` folder, you can simply run npx. The `PORT` environment variable already defaults to 1234.
Since npm symlinks the `y-websocket-server` executable from your local `./node_modules/.bin` folder, you can simply run npx. The `PORT` environment variable already defaults to 1234, and `HOST` defaults to `localhost`.
### Websocket Server with Persistence
@ -97,7 +97,7 @@ Persist document updates in a LevelDB database.
See [LevelDB Persistence](https://github.com/yjs/y-leveldb) for more info.
```sh
PORT=1234 YPERSISTENCE=./dbDir node ./node_modules/y-websocket/bin/server.js
HOST=localhost PORT=1234 YPERSISTENCE=./dbDir node ./node_modules/y-websocket/bin/server.js
```
### Websocket Server with HTTP callback

5
bin/server.js
View File

@ -8,6 +8,7 @@ const http = require('http')
const wss = new WebSocket.Server({ noServer: true })
const setupWSConnection = require('./utils.js').setupWSConnection
const host = process.env.HOST || 'localhost'
const port = process.env.PORT || 1234
const server = http.createServer((request, response) => {
@ -28,6 +29,6 @@ server.on('upgrade', (request, socket, head) => {
wss.handleUpgrade(request, socket, head, handleAuth)
})
server.listen(port)
server.listen({host, port})
console.log('running on port', port)
console.log(`running at '${host}' on port ${port}`)