Misleading documentation for Websockets via .createServer #349

merged 2 commits into from Mar 9, 2013


None yet

3 participants


It's said its handled automatically, however from my experience this isn't the whole story, and to save someone else a headache this should be remedied in the docs.

Just some background I had a connect middleware for no-www, and options..

var options = {
    hostnameOnly: true,
    router: {
        'api.[snip]': '',
        '[snip]': ''

var server = httpProxy.createServer(

server.listen(80, function() {
  console.log('proxy up');

The websockets connections aren't made automatically because I was using middleware, so you need to add..

server.on('upgrade', function(req, socket, head) {
    server.proxy.proxyWebSocketRequest(req, socket, head);

This should just be documented somewhere is all. It would have saved me the hour of "hmm, why is this falling back to xhr-polling?" time and source-reading lines to see the "magic"

if (!callback) {
  proxy.proxyWebSocketRequest(req, socket, head);

But, more than willing to give up that hour for the total amount of time you've saved me 👍


👍 i'm not using any middleware and still had to manually listen for 'upgrade'


@jamie-stackhouse @aeosynth A documentation pull-request would be welcomed.

@thegingerbloke thegingerbloke referenced this pull request in MadeByLoosers/noise-box Feb 27, 2013

Sort websocket proxying #43

@indexzero indexzero merged commit c686ac7 into nodejitsu:master Mar 9, 2013

1 check passed

default The Travis build passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment