Skip to content

Missing documentation for options of separate live query server #3355

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
dpoetzsch opened this issue Jan 11, 2017 · 1 comment
Closed

Missing documentation for options of separate live query server #3355

dpoetzsch opened this issue Jan 11, 2017 · 1 comment

Comments

@dpoetzsch
Copy link

The wiki page for Parse LiveQuery proposes a setup for a scalable live query. However, when separating the live query server from the parse server it is important to specify at least appId, masterKey and serverURL. If this information is missing the live query server will start up and allow connections but will silently not push any changes to the clients. For me the only way to find that out was to dig through the code. At the moment I could not even find documentation that these additional options exist.

A working setup looks like this:

var express = require('express');
var ParseServer = require('parse-server').ParseServer;

var app = express();

var port = process.env.PORT;
var httpServer = require('http').createServer(app);
httpServer.listen(port, function() {
    console.log('live query server running on port ' + port + '.');
});

ParseServer.createLiveQueryServer(httpServer, {
    appId: process.env.APP_ID,
    masterKey: process.env.MASTER_KEY,
    serverURL: process.env.SERVER_URL,
    redisURL: process.env.REDIS_URL
});

I cannot edit the wiki page, but I believe it would be helpful if this information would be integrated into the documentation.

@flovilmart
Copy link
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants