view mod_pubsub_twitter.wiki @ 502:3c81d8a9f1e2

Documentation for the new mod_admin_message module.
author mikael.berthe@gmail.com
date Sun, 25 Jan 2015 19:07:33 +0000
parents 528721aaea46
children
line wrap: on
line source

#summary Subscribe to Twitter search queries over pubsub
#labels Stage-Alpha

= Introduction =

Twitter has an open 'realtime' search API, but it requires polling (within their rate limits). This module allows Prosody to poll for you, and push new results to subscribers over XMPP.

= Configuration =

This module must be loaded on a Prosody pubsub component. Add it to `modules_enabled` and configure like so:

{{{
Component "pubsub.example.com" "pubsub"
    modules_enabled = { "pubsub_twitter" }

    twitter_searches = {
        realtime = "xmpp OR realtime";
        prosody = "prosody xmpp";
    }
}}}

This example creates two nodes, 'realtime' and 'prosody' that clients can subscribe to using [http://xmpp.org/extensions/xep-0060.html XEP-0060]. Results are in [http://atomenabled.org/ ATOM 1.0 format] for easy consumption.

|| *Option* || *Description* ||
|| twitter_searches || A list of virtual nodes to create and their associated Twitter search queries. ||
|| twitter_pull_interval || Number of minutes between polling for new results (default 20) ||
|| twitter_search_url || URL of the JSON search API, default: "http://search.twitter.com/search.json" ||

= Compatibility =
|| 0.9 || Works ||