statusnet/README

   1 ____ StatusNet Plugin ____
   2 by Tobias Diekershoff
   3    tobias.diekershoff(at)gmx.net
   4
   5 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   6 !! This addon is currently under development. If you have any problem       !!
   7 !! with it, please contact the Author.                                      !!
   8 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
   9
  10 With this addon to Friendica you can give your user the possibility to post
  11 their public messages to any StatusNet instance (like identi.ca for example).
  12 The messages will be strapped their rich context and shortened to to the character
  13 limit of the StatusNet instance in question if necessary. If shortening of the
  14 message was performed a link will be added to the notice pointing to the
  15 original message on your server.
  16
  17 There is a similar plugin to forward public messages to Twitter: Twitter Plugin.
  18
  19 Online version of this document: http://ur1.ca/35mpb
  20
  21 ___ Requirements ___
  22
  23 Due to the distributed nature of the StatusNet network, each user who wishes to
  24 forward public messages to a StatusNet account has to get the OAuth credentials
  25 for themselves, which makes this addon a little bit more user unfriendly than
  26 the Twitter Plugin is. Nothing too geeky though!
  27
  28 The inclusion of a shorturl for the original posting in cases when the message
  29 was longer than the maximal allowed notice length requires it, that you have
  30 PHP5+ and curl on your server.
  31 Where to find
  32
  33 In the Friendica git repository /addon/statusnet/, this directory contains all
  34 required PHP files (including the Twitter OAuth library [1] by Abraham Williams,
  35 MIT licensed and the Slinky library [2] by Beau Lebens, BSD license), a CSS file
  36 for styling of the user configuration and an image to Sign in with StatusNet.
  37
  38 [1] https://github.com/abraham/twitteroauth
  39 [2] http://dentedreality.com.au/projects/slinky
  40
  41 ___ Configuration ___
  42
  43 __ Global Configuration __
  44
  45 If you enabled an administrator account, please use the admin panel to cofigure
  46 the StatusNet relay.
  47
  48 To activate this addon add statusnet to the list of active addons in your
  49 .htconfig.php file
  50     $a->config['system']['addon'] = "statusnet, ...".
  51
  52 __ User Configuration __
  53
  54 When the addon is activated the user has to aquire three things in order to
  55 connect to the StatusNet account of choice.
  56  * the base URL for the StatusNet API, for identi.ca this is
  57    https://identi.ca/api/
  58  * OAuth Consumer key & secret
  59
  60 To get the OAuth Consumer key pair the user has to (a) ask her Friendica admin
  61 if a pair already exists or (b) has to register the Friendica server as a
  62 client application on the StatusNet server. This can be done from the account
  63 settings under "Connect -> Connections -> Register an OAuth client application
  64 -> Register a new application".
  65
  66 During the registration of the OAuth client remember the following:
  67  * there is no callback url
  68  * register a desktop client
  69  * with read & write access
  70  * the Source URL should be the URL of your Friendica server
  71
  72 After the required credentials for the application are stored in the
  73 configuration you have to actually connect your Friendica account with
  74 StatusNet. To do so follow the Sign in with StatusNet button, allow the access
  75 and copy the security code into the plugin configuration. Friendica will then
  76 try to acquire the final OAuth credentials from the API, if successful the
  77 plugin settings will allow you to select to post your public messages to your
  78 StatusNet account.