Friendica Communications Platform (please note that this is a clone of the repository at github, issues are handled there)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

89 lines
4.0 KiB

10 years ago
10 years ago
  1. Installing Connectors (Twitter/GNU Social)
  2. ==================================================
  3. * [Home](help)
  4. Friendica uses addons to provide connectivity to some networks, such as Twitter.
  5. There is also a addon to post through to an existing account on a GNU Social service.
  6. You only need this to post to an already existing GNU Social account, but not to communicate with GNU Social members in general.
  7. All three addons require an account on the target network.
  8. In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server.
  9. Site Configuration
  10. ---
  11. Addons must be installed by the site administrator before they can be used.
  12. This is accomplished through the site administration panel.
  13. Each of the connectors also requires an "API key" from the service you wish to connect with.
  14. 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).
  15. The ways to obtain these keys vary between the services, but they all require an existing account on the target service.
  16. Once installed, these API keys can usually be shared by all site members.
  17. The details of configuring each service follow (much of this information comes directly from the addon source files):
  18. Twitter Addon for Friendica
  19. ---
  20. * Author: Tobias Diekershoff
  21. *
  22. * License: 3-clause BSD license
  23. ### Configuration
  24. To use this addon you need a OAuth Consumer key pair (key & secret).
  25. You can get it from [Twitter](
  26. Register your Friendica site as "Client" application with "Read & Write" access.
  27. We do not need "Twitter as login".
  28. When you've registered the app you get a key pair with an OAuth Consumer key and a secret key for your application/site.
  29. Add this key pair to your config/local.config.php:
  30. [twitter]
  31. consumerkey = your consumer_key here
  32. consumersecret = your consumer_secret here
  33. After this, your users can configure their Twitter account settings from "Settings -> Connector Settings".
  34. ### More documentation
  35. Find the author's documentation here: [](
  36. GNU Social Addon for Friendica
  37. ---
  38. * Author: Tobias Diekershoff
  39. *
  40. * License: 3-clause BSD license
  41. ### Configuration
  42. When the addon is activated the user has to acquire the following in order to connect to the GNU Social account of choice.
  43. * The base URL for the GNU Social API, for this is
  44. * OAuth Consumer key & secret
  45. To get the OAuth Consumer key pair the user has to
  46. 1 ask her Friendica admin if a pair already exists or
  47. 2 has to register the Friendica server as a client application on the GNU Social server.
  48. 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.
  49. During the registration of the OAuth client remember the following:
  50. * 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.
  51. * there is no callback url
  52. * register a desktop client
  53. * with read & write access
  54. * the Source URL should be the URL of your Friendica server
  55. After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with GNU Social.
  56. This is done from the Settings -> Connector Settings page.
  57. Follow the Sign in with GNU Social button, allow access and then copy the security code into the box provided.
  58. Friendica will then try to acquire the final OAuth credentials from the API.
  59. 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).