settings: document the possibility of using Unix sockets

We have been supporting Unix sockets by ages, because express.listen()
(http://expressjs.com/en/4x/api.html#app.listen_path_callback) re-exposes
net.server.listen() (https://nodejs.org/api/net.html#net_server_listen), which
in turn supports Unix sockets.

The only remaining thing to do was documenting it.

Fixes #3312
This commit is contained in:
John McLear 2020-03-29 22:27:22 +00:00 committed by muxator
parent 85217b55e0
commit fa3e4b146a
4 changed files with 28 additions and 3 deletions

View file

@ -92,7 +92,14 @@
"skinName": "${SKIN_NAME:colibris}",
/*
* IP and port which etherpad should bind at
* IP and port which Etherpad should bind at.
*
* Binding to a Unix socket is also supported: just use an empty string for
* the ip, and put the full path to the socket in the port parameter.
*
* EXAMPLE USING UNIX SOCKET:
* "ip": "", // <-- has to be an empty string
* "port" : "/somepath/etherpad.socket", // <-- path to a Unix socket
*/
"ip": "${IP:0.0.0.0}",
"port": "${PORT:9001}",