Make optional arguments for getNoticeIds explicit

[quix0rs-gnu-social.git] / plugins / Meteor / README

diff --git a/plugins/Meteor/README b/plugins/Meteor/README
index 4abd40af7ae18bbb3e350559ac7d2ab1fd888e46..f21828cdc5e7f9c07b922d031f7ae1a43c2123e7 100644 (file)
--- a/plugins/Meteor/README
+++ b/plugins/Meteor/README
@@ -1,26 +1,24 @@
-This is a plugin to automatically load notices in the browser no
-matter who creates them -- the kind of thing we see with
-search.twitter.com, rejaw.com, or FriendFeed's "real time" news.
+This is a plugin to automatically load notices in the browser no matter who
+creates them -- the kind of thing we see with search.twitter.com, rejaw.com, or
+FriendFeed's "real time" news.
 
-NOTE: this is an insecure version; don't roll it out on a production
-server.
+It requires a meteor server.
 
-It requires a cometd server. I've only had the cometd-java server work
-correctly; something's wiggy with the Twisted-based server.
+   http://meteorserver.org/
 
-After you have a cometd server installed, just add this code to your
-config.php:
+Note that the controller interface needs to be accessible by the Web server, and
+the subscriber interface needs to be accessible by your Web users. You MUST
+firewall the controller interface from users; otherwise anyone will be able to
+push any message to your subscribers. Not good!
 
-    require_once(INSTALLDIR.'/plugins/Comet/CometPlugin.php');
-    $cp = new CometPlugin('http://example.com:8080/cometd/');
+You can enable the plugin with this line in config.php:
 
-Change 'example.com:8080' to the name and port of the server you
-installed cometd on.
+addPlugin('Meteor', array('webserver' => 'meteor server address'));
 
-TODO:
-
-* Needs to be tested with Ajax submission. Probably messes everything
-  up.
-* Add more timelines: personal inbox and tags would be great.
-* Add security. In particular, only let the PHP code publish notices
-  to the cometd server. Currently, it doesn't try to authenticate.
+Available parameters:
+* webserver: Web server address. Defaults to site server.
+* webport: port to connect to for Web access. Defaults to 4670.
+* controlserver: Control server address. Defaults to webserver.
+* controlport: port to connect to for control. Defaults to 4671.
+* channelbase: a base string to use for channels. Good if you have
+  multiple sites using the same meteor server.