doc/Installing-Connectors.md

   1 Installing Connectors (Twitter/GNU Social)
   2 ==================================================
   3
   4 * [Home](help)
   5
   6
   7 Friendica uses addons to provide connectivity to some networks, such as Twitter.
   8
   9 There is also a addon to post through to an existing account on a GNU Social service.
  10 You only need this to post to an already existing GNU Social account, but not to communicate with GNU Social members in general.
  11
  12 All three addons require an account on the target network.
  13 In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server.
  14
  15 Site Configuration
  16 ---
  17
  18 Addons must be installed by the site administrator before they can be used.
  19 This is accomplished through the site administration panel.
  20
  21 Each of the connectors also requires an "API key" from the service you wish to connect with.
  22 Some addons allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (config/local.config.php).
  23 The ways to obtain these keys vary between the services, but they all require an existing account on the target service.
  24 Once installed, these API keys can usually be shared by all site members.
  25
  26 The details of configuring each service follow (much of this information comes directly from the addon source files):
  27
  28 Twitter Addon for Friendica
  29 ---
  30
  31 * Author: Tobias Diekershoff
  32 * tobias.diekershoff@gmx.net
  33 * License: 3-clause BSD license
  34
  35 ### Configuration
  36 To use this addon you need a OAuth Consumer key pair (key & secret).
  37 You can get it from [Twitter](https://twitter.com/apps).
  38
  39 Register your Friendica site as "Client" application with "Read & Write" access.
  40 We do not need "Twitter as login".
  41 When you've registered the app you get a key pair with an OAuth Consumer key and a secret key for your application/site.
  42 Add this key pair to your config/local.config.php:
  43
  44         [twitter]
  45         consumerkey = your consumer_key here
  46         consumersecret = your consumer_secret here
  47
  48 After this, your users can configure their Twitter account settings from "Settings -> Connector Settings".
  49
  50 ### More documentation
  51
  52 Find the author's documentation here: [http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin](http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin)
  53
  54
  55 GNU Social Addon for Friendica
  56 ---
  57
  58 * Author: Tobias Diekershoff
  59 * tobias.diekershoff@gmx.net
  60 * License: 3-clause BSD license
  61
  62 ### Configuration
  63
  64 When the addon is activated the user has to acquire the following in order to connect to the GNU Social account of choice.
  65
  66 * The base URL for the GNU Social API, for quitter.se this is https://quitter.se/api/
  67 * OAuth Consumer key & secret
  68
  69 To get the OAuth Consumer key pair the user has to
  70
  71 1 ask her Friendica admin if a pair already exists or
  72 2 has to register the Friendica server as a client application on the GNU Social server.
  73
  74 This can be done from the account settings under "Settings -> Connections -> Register an OAuth client application -> Register a new application" on the GNU Social server.
  75
  76 During the registration of the OAuth client remember the following:
  77
  78 * Application names must be unique on the GNU Social site, so we recommend a Name of 'friendica-nnnn', replace 'nnnn' with a random number or your website name.
  79 * there is no callback url
  80 * register a desktop client
  81 * with read & write access
  82 * the Source URL should be the URL of your Friendica server
  83
  84 After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with GNU Social.
  85 This is done from the Settings -> Connector Settings page.
  86 Follow the Sign in with GNU Social button, allow access and then copy the security code into the box provided.
  87 Friendica will then try to acquire the final OAuth credentials from the API.
  88
  89 If successful, the addon settings will allow you to select to post your public messages to your GNU Social account (have a look behind the little lock symbol beneath the status "editor" on your Home or Network pages).