Differences
This shows you the differences between two versions of the page.
| docs:installing-connectors [2020-09-20 19:19] – external edit 127.0.0.1 | docs:installing-connectors [2022-06-24 14:49] (current) – Tobias | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | Installing Connectors (Twitter/ | + | ====== |
| - | ================================================== | + | |
| - | + | ||
| - | * [Home](help) | + | |
| Friendica uses addons to provide connectivity to some networks, such as Twitter. | Friendica uses addons to provide connectivity to some networks, such as Twitter. | ||
| - | There is also a addon to post through to an existing account on a GNU Social service. | + | There is also a addon to post through to an existing account on a GNU Social service. You only need this to post to an already existing GNU Social account, but not to communicate with GNU Social members in general. |
| - | You only need this to post to an already existing GNU Social account, but not to communicate with GNU Social members in general. | + | |
| - | All three addons require an account on the target network. | + | All three addons require an account on the target network. In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server. |
| - | In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server. | + | |
| - | Site Configuration | + | ===== Site Configuration |
| - | --- | + | |
| - | Addons must be installed by the site administrator before they can be used. | + | Addons must be installed by the site administrator before they can be used. This is accomplished through the site administration panel. |
| - | This is accomplished through the site administration panel. | + | |
| - | Each of the connectors also requires an "API key" | + | Each of the connectors also requires an “API key” from the service you wish to connect with. Some addons allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (config/ |
| - | Some addons allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (config/ | + | |
| - | The ways to obtain these keys vary between the services, but they all require an existing account on the target service. | + | |
| - | Once installed, these API keys can usually be shared by all site members. | + | |
| The details of configuring each service follow (much of this information comes directly from the addon source files): | The details of configuring each service follow (much of this information comes directly from the addon source files): | ||
| - | Twitter Addon for Friendica | + | ===== Twitter Addon for Friendica |
| - | --- | + | |
| - | + | ||
| - | * Author: Tobias Diekershoff | + | |
| - | * tobias.diekershoff@gmx.net | + | |
| - | * License: 3-clause BSD license | + | |
| - | ### Configuration | + | * Author: Tobias Diekershoff |
| - | To use this addon you need a OAuth Consumer key pair (key & secret). | + | * tobias.diekershoff@gmx.net |
| - | You can get it from [Twitter](https:// | + | * License: 3-clause BSD license |
| - | Register your Friendica site as " | + | ==== Configuration ==== |
| - | We do not need " | + | |
| - | When you've registered the app you get a key pair with an OAuth Consumer key and a secret key for your application/ | + | |
| - | Add this key pair to your config/ | + | |
| - | [twitter] | + | To use this addon you need a OAuth Consumer key pair (key & secret). You can get it from [[https://twitter.com/ |
| - | consumerkey = your consumer_key here | + | |
| - | consumersecret = your consumer_secret here | + | |
| - | After this, your users can configure their Twitter | + | Register |
| - | ### More documentation | + | < |
| + | [twitter] | ||
| + | consumerkey = your consumer_key here | ||
| + | consumersecret = your consumer_secret here | ||
| + | </ | ||
| + | After this, your users can configure their Twitter account settings from “Settings -> Connector Settings”. | ||
| - | Find the author' | + | ==== More documentation |
| + | Find the author’s documentation here: http:// | ||
| - | GNU Social Addon for Friendica | + | ===== GNU Social Addon for Friendica |
| - | --- | + | |
| - | * Author: Tobias Diekershoff | + | |
| - | * tobias.diekershoff@gmx.net | + | * tobias.diekershoff@gmx.net |
| - | * License: 3-clause BSD license | + | * License: 3-clause BSD license |
| - | ### Configuration | + | ==== Configuration |
| When the addon is activated the user has to acquire the following in order to connect to the GNU Social account of choice. | When the addon is activated the user has to acquire the following in order to connect to the GNU Social account of choice. | ||
| - | * The base URL for the GNU Social API, for quitter.se this is https:// | + | |
| - | * OAuth Consumer key & secret | + | * OAuth Consumer key & secret |
| To get the OAuth Consumer key pair the user has to | To get the OAuth Consumer key pair the user has to | ||
| - | 1 ask her Friendica admin if a pair already exists or | + | 1 ask her Friendica admin if a pair already exists or 2 has to register the Friendica server as a client application on the GNU Social server. |
| - | 2 has to register the Friendica server as a client application on the GNU Social server. | + | |
| - | This can be done from the account settings under "Settings -> Connections -> Register an OAuth client application -> Register a new application" | + | 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. |
| During the registration of the OAuth client remember the following: | During the registration of the OAuth client remember the following: | ||
| - | * Application names must be unique on the GNU Social site, so we recommend a Name of 'friendica-nnnn', replace | + | |
| - | * there is no callback url | + | * there is no callback url |
| - | * register a desktop client | + | * register a desktop client |
| - | * with read & write access | + | * with read & write access |
| - | * the Source URL should be the URL of your Friendica server | + | * the Source URL should be the URL of your Friendica server |
| - | After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with GNU Social. | + | After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with GNU Social. This is done from the Settings -> Connector Settings page. Follow the Sign in with GNU Social button, allow access and then copy the security code into the box provided. Friendica will then try to acquire the final OAuth credentials from the API. |
| - | This is done from the Settings -> Connector Settings page. | + | |
| - | Follow the Sign in with GNU Social button, allow access and then copy the security code into the box provided. | + | |
| - | Friendica 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 GNU Social account (have a look behind the little lock symbol beneath the status | + | 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 |