Mercurial > prosody-modules

comparison mod_pubsub_twitter/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents
children
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: Subscribe to Twitter search queries over pubsub
5 ...
6
7 Introduction
8 ------------
9
10 Twitter has an open 'realtime' search API, but it requires polling
11 (within their rate limits). This module allows Prosody to poll for you,
12 and push new results to subscribers over XMPP.
13
14 Configuration
15 -------------
16
17 This module must be loaded on a Prosody pubsub component. Add it to
18 `modules_enabled` and configure like so:
19
20 Component "pubsub.example.com" "pubsub"
21 modules_enabled = { "pubsub_twitter" }
22
23 twitter_searches = {
24 realtime = "xmpp OR realtime";
25 prosody = "prosody xmpp";
26 }
27
28 This example creates two nodes, 'realtime' and 'prosody' that clients
29 can subscribe to using
30 [XEP-0060](http://xmpp.org/extensions/xep-0060.html). Results are in
31 [ATOM 1.0 format](http://atomenabled.org/) for easy consumption.
32
33 Option Description
34 ------------------------- --------------------------------------------------------------------------------
35 twitter\_searches A list of virtual nodes to create and their associated Twitter search queries.
36 twitter\_pull\_interval Number of minutes between polling for new results (default 20)
37 twitter\_search\_url URL of the JSON search API, default: "http://search.twitter.com/search.json"
38
39 Compatibility
40 -------------
41
42 ----- -------
43 0.9 Works
44 ----- -------