diff --git a/config/config.example.js b/config/config.example.js index 1fb702519..2b5bc687d 100644 --- a/config/config.example.js +++ b/config/config.example.js @@ -97,15 +97,17 @@ module.exports = { httpUnsafeOrigin: domain, - /* your server's websocket url is configurable - * (default: '/cryptpad_websocket') + /* Your CryptPad server will share this value with clients + * via its /api/config endpoint. * - * websocketPath can be relative, of the form '/path/to/websocket' - * or absolute, specifying a particular URL + * If you want to host your API and asset servers on different hosts + * specify a URL for your API server websocket endpoint, like so: + * wss://api.yourdomain.com/cryptpad_websocket * - * 'wss://cryptpad.fr:3000/cryptpad_websocket' + * Otherwise, leave this commented and your clients will use the default + * websocket (wss://yourdomain.com/cryptpad_websocket) */ - websocketPath: '/cryptpad_websocket', + //externalWebsocketPath: 'wss://api.yourdomain.com/cryptpad_websocket /* CryptPad can be configured to send customized HTTP Headers * These settings may vary widely depending on your needs diff --git a/server.js b/server.js index e086a0596..8a9a98a41 100644 --- a/server.js +++ b/server.js @@ -166,7 +166,7 @@ app.get('/api/config', function(req, res){ }, removeDonateButton: (config.removeDonateButton === true), allowSubscriptions: (config.allowSubscriptions === true), - websocketPath: config.websocketPath, + websocketPath: config.externalWebsocketPath, httpUnsafeOrigin: config.httpUnsafeOrigin.replace(/^\s*/, ''), adminEmail: config.adminEmail, adminKeys: admins, @@ -234,7 +234,7 @@ var nt = nThen(function (w) { log = config.log = _log; })); }).nThen(function (w) { - if (config.useExternalWebsocket) { + if (config.externalWebsocketPath) { // if you plan to use an external websocket server // then you don't need to load any API services other than the logger. // Just abort.