1 ____ Twitter Plugin ____
3 http://diekershoff.homeunix.net/friendika/profile/tobias
4 tobias.diekershoff(at)gmx.net
6 With this addon to Friendica you can give your user the possibility to post
7 their *public* messages to Twitter. The messages will be strapped their rich
8 context and shortened to 140 characters length if necessary. If shortening of
9 the message was performed a link will be added to the Tweet pointing to the
10 original message on your server.
12 The addon can also mirror a users Tweets into the ~friendica wall.
14 There is a similar addon for forwarding public messages to
15 "StatusNet":http://status.net [[StatusNet Plugin]].
17 Online version of this document: http://ur1.ca/35mml
21 To use this plugin you have to register an application for your friendica
22 instance on Twitter with
23 * read and write access
24 * don't set a callback URL
25 * we do not intend to use Twitter for login
26 The registration can be done at twitter.com/apps and you need a Twitter
29 After you registered the application you get an OAuth consumer key / secret
30 pair that identifies your app, you will need them for configuration.
32 The inclusion of a shorturl for the original posting in cases when the
33 message was longer than 140 characters requires it, that you have *PHP5+* and
34 *curl* on your server.
38 In the Friendica git repository /addon/twitter/, this directory contains
39 all required PHP files (including the Twitter OAuth library [1] by Abraham
40 Williams, MIT licensed and the Slinky library [2] by Beau Lebens, BSD license),
41 a CSS file for styling of the user configuration and an image to _Sign in with
44 [1] https://github.com/abraham/twitteroauth
45 [2] http://dentedreality.com.au/projects/slinky/
49 __ Global Configuration __
51 If you enabled an administrator account, please use the admin panel to configure
52 the Twitter relay. If you for any reason prefer to use a configuration file instead
53 of the admin panels, please refer to the Alternative Configuration below.
55 Activate the plugin from the plugins section of your admin panel. When you have
56 done so, add your consumer key and consumer secret in the settings section of the
59 When this is done your user can now configure their Twitter connection at
60 "Settings -> Connector Settings" and enable the forwarding of their *public*
63 __ Alternative Configuration __
65 To activate this addon add @twitter@ to the list of active addons in your
68 $a->config['system']['addon'] = "twitter, ..."
70 Afterwards you need to add your OAuth consumer key / secret pair to it by
71 adding the following two lines
73 $a->config['twitter']['consumerkey'] = 'your consumer KEY here';
74 $a->config['twitter']['consumersecret'] = 'your consumer SECRET here';
77 __ User Configuration __
79 When the OAuth consumer informations are correctly placed into the
80 configuration file and a user visits the "Plugin Settings" page they can now
81 connect to Twitter. To do so one has to follow the _Sign in with Twitter_
82 button (the page will be opened in a new browser window/tab) and get a PIN from
83 Twitter. This PIN has to be entered on the settings page. After submitting the
84 PIN the plugin will get OAuth credentials identifying this user from the
87 If this first step was successful the Twitter configuration will be changed
88 on the "Plugin Settings" page displaying two check boxes. One to enable/disable
89 the forwarding of *all public* postings to Twitter and one to clear the
90 personal configuration from the Twitter credentials.