From b8629a03182410abc0463865d29774e42e41810d Mon Sep 17 00:00:00 2001 From: Tobias Diekershoff Date: Tue, 8 Feb 2011 19:04:39 +0100 Subject: added README files for the piwik, twitter and statusnet addon --- addon/statusnet/README | 75 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) create mode 100644 addon/statusnet/README (limited to 'addon/statusnet/README') diff --git a/addon/statusnet/README b/addon/statusnet/README new file mode 100644 index 000000000..8d5e27297 --- /dev/null +++ b/addon/statusnet/README @@ -0,0 +1,75 @@ +____ StatusNet Plugin ____ +by Tobias Diekershoff + tobias.diekershoff(at)gmx.net + +!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! +!! This addon is currently in under development. If you have any problem !! +!! with it, please contact the Author. !! +!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +With this addon to Friendika you can give your user the possibility to post +their public messages to any StatusNet instance like identi.ca for example. The +messages will be strapped their rich context and shortened to to the character +limit of the StatusNet instance in question if necessary. If shortening of the +message was performed a link will be added to the notice pointing to the +original message on your server. + +There is a similar plugin to forward public messages to Twitter Twitter Plugin. + +Online version of this document: http://ur1.ca/35mpb + +___ Requirements ___ + +Due to the distributed nature of the StatusNet network, each user who wishes to +forward public messages to a StatusNet account has get the OAuth credentials +for themselves, which makes this addon a little bit more user unfriendly then +the Twitter Plugin is. Nothing to geeky though! + +The inclusion of a shorturl for the original posting in cases when the message +was longer then the maximal allowed notice length requires it, that you have +PHP5+ and curl on your server. +Where to find + +In the Friendika git repository /addon/statusnet/, this directory contains all +required PHP files (including the Twitter OAuth library [1] by Abraham Williams, +MIT licensed and the Slinky library [2] by Beau Lebens, BSD license), a CSS file +for styling of the user configuration and an image to Sign in with StatusNet. + +[1] https://github.com/abraham/twitteroauth +[2] http://dentedreality.com.au/projects/slinky + +___ Configuration ___ + +__ Global Configuration __ + +To activate this addon add statusnet to the list of active addons in your +.htconfig.php file + $a->config['system']['addon'] = "statusnet, ...". + +__ User Configuration __ + +When the addon is activated the user has to aquire three things in order to +connect to the StatusNet account of choice. + * the base URL for the StatusNet API, for identi.ca this is + https://identi.ca/api/ + * OAuth Consumer key & secret + +To get the OAuth Consumer key pair the user has to (a) ask her Friendika admin +if a pair already exists or (b) has to register the Friendika server as a +client application on the StatusNet server. This can be done from the account +settings under "Connect -> Connections -> Register an OAuth client application +-> Register new application". + +During the registration of the OAuth client remember the following: + * there is no callback url + * register a desktop client + * with read & write access + * the Source URL should be the URL of your Friendika server + +After the required credentials for the application are stored in the +configuration you have to actually connect your Friendika account with +StatusNet. To do so follow the Sign in with StatusNet button, allow the access +and copy the security code into the addon configuration. Friendika will then +try to acquire the final OAuth credentials from the API, if successful the +addon settings will allow you to select to post your public messages to your +StatusNet account. -- cgit v1.2.3