statusnet/README.md

   1 GNU Social Connector
   2 ===================
   3 Main authors Tobias Diekershoff and Michael Vogel.
   4
   5 With this addon to friendica you can give your users the possibility to post their *public* messages to GNU Social
   6 and to import their timeline of their legacy GNU Social accounts. The messages will be strapped their rich context
   7 and shortened if necessary.
   8
   9 Requirements
  10 ------------
  11
  12 Due to the distributed nature of the GNU Social network, each user who wishes to
  13 forward public messages to a GNU Social account has to get the OAuth credentials
  14 for themselves, which makes this addon a little bit more user unfriendly than
  15 the Twitter Addon is. Nothing too geeky though!
  16
  17 The inclusion of a shorturl for the original posting in cases when the message
  18 was longer than the maximal allowed notice length requires it, that you have
  19 PHP5+ and curl on your server.
  20
  21 Where to find
  22 -------------
  23
  24 In the friendica addon git repository /statusnet/, this directory contains all
  25 required PHP files (including the [Twitter OAuth library] [1] by Abraham Williams,
  26 MIT licensed and the [Slinky library] [2] by Beau Lebens, BSD license), a CSS file
  27 for styling of the user configuration and an image to Sign in with GNU Social.
  28
  29 [1]:https://github.com/abraham/twitteroauth
  30 [2]:http://dentedreality.com.au/projects/slinky
  31
  32 Configuration
  33 =============
  34
  35 User Configuration
  36 ------------------
  37
  38 When the addon is activated the user has to acquire three things in order to
  39 connect to the GNU Social account of choice.
  40
  41 * the base URL for the GNU Social API, for identi.ca this was https://identi.ca/api/
  42 * OAuth Consumer key & secret
  43
  44 To get the OAuth Consumer key pair the user has to (a) ask her Friendica admin
  45 if a pair already exists or (b) has to register the Friendica server as a
  46 client application on the GNU Social server. This can be done from the account
  47 settings under "Connect -> Connections -> Register an OAuth client application
  48 -> Register a new application".
  49
  50 During the registration of the OAuth client remember the following:
  51
  52 * there is no callback URL
  53 * register a desktop client
  54 * with read & write access
  55 * the Source URL should be the URL of your friendica server
  56
  57 After the required credentials for the application are stored in the
  58 configuration you have to actually connect your friendica account with
  59 GNU Social. To do so follow the Sign in with GNU Social button, allow the access
  60 and copy the security code into the addon configuration. Friendica will then
  61 try to acquire the final OAuth credentials from the API, if successful the
  62 addon settings will allow you to select to post your public messages to your
  63 GNU Social account.
  64
  65 License
  66 =======
  67
  68 The _GNU Social Connector_ is licensed under the [3-clause BSD license][3] see the
  69 LICENSE file in the addons directory.
  70
  71 [3]: http://opensource.org/licenses/BSD-3-Clause