Friendica uses plugins to provide connectivity to some networks, such as Facebook and Twitter.
-There is also a plugin to post through to an existing account on a Status.Net service. You do not require this to communicate with Status.Net members from Friendica - only if you wish to post to an existing account.
+There is also a plugin to post through to an existing account on a StatusNet service.
+You only need this to post to an already existing StatusNet account, but not to communicate with StatusNet members in general.
-All three of these plugins 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.
+All three plugins 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.
-**Site Configuration**
+Site Configuration
+---
-Plugins must be installed by the site administrator before they can be used. This is accomplished through the site administration panel.
+Plugins must be installed by the site administrator before they can be used.
+This is accomplished through the site administration panel.
+Each of the connectors also requires an "API key" from the service you wish to connect with.
+Some plugins allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php).
+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.
-Each of the connectors also requires an "API key" from the service you wish to connect with. Some plugins allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php). The method for obtaining these keys varies greatly - but almost always requires 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 plugin source files):
-
-The details of configuring each service follows (much of this information comes directly from the plugin source files):
-
-**Twitter Plugin for Friendica**
+Twitter Plugin for Friendica
+---
* Author: Tobias Diekershoff
* tobias.diekershoff@gmx.net
+* License: 3-clause BSD license
-* License:3-clause BSD license
-
-Configuration:
-To use this plugin you need a OAuth Consumer key pair (key & secret)
-you can get it from Twitter at https://twitter.com/apps
+###Configuration
+To use this plugin you need a OAuth Consumer key pair (key & secret).
+You can get it from [Twitter](https://twitter.com/apps).
Register your Friendica site as "Client" application with "Read & Write" access.
-We do not need "Twitter as login". When you've registered the app you get the
-OAuth Consumer key and secret pair for your application/site.
+We do not need "Twitter as login".
+When you've registered the app you get a key pair with an OAuth Consumer key and a secret key for your application/site.
+Add this key pair to your global .htconfig.php:
-Add this key pair to your global .htconfig.php
+ $a->config['twitter']['consumerkey'] = 'your consumer_key here';
+ $a->config['twitter']['consumersecret'] = 'your consumer_secret here';
-```
-$a->config['twitter']['consumerkey'] = 'your consumer_key here';
-$a->config['twitter']['consumersecret'] = 'your consumer_secret here';
-```
+After this, your users can configure their Twitter account settings from "Settings -> Connector Settings".
-After this, your user can configure their Twitter account settings
-from "Settings -> Connector Settings".
+###More documentation
-Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin
+Find the author's documentation here: [http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin](http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin)
-**StatusNet Plugin for Friendica**
+StatusNet Plugin for Friendica
+---
* Author: Tobias Diekershoff
* 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 aquire the following in order to connect to the StatusNet account of choice.
* The base URL for the StatusNet API, for identi.ca this is https://identi.ca/api/
* 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
-(a) ask her Friendica admin if a pair already exists or
-(b) has to register the Friendica server as a client application on the StatusNet server.
+1 ask her Friendica admin if a pair already exists or
+2 has to register the Friendica server as a client application on the StatusNet server.
This can be done from the account settings under "Settings -> Connections -> Register an OAuth client application -> Register a new application" on the StatusNet server.
* with read & write access
* 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 StatusNet. This is done from the Settings -> Connector Settings page. Follow the Sign in with StatusNet 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 StatusNet account (have a look behind the little lock symbol beneath the status "editor" on your Home or Network pages).
+After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with StatusNet.
+This is done from the Settings -> Connector Settings page.
+Follow the Sign in with StatusNet 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.
-Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin
+If successful, the addon settings will allow you to select to post your public messages to your StatusNet account (have a look behind the little lock symbol beneath the status "editor" on your Home or Network pages).
+###More documentation
+Find the author's documentation here: [http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin](http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin)
-**Installing the Friendica/Facebook connector**
+The Friendica/Facebook connector
+---
-* register an API key for your site from developer.facebook.com
+###Configuration
-This requires a Facebook account, and may require additional authentication in the form of credit card or mobile phone verification.
+First, register an API key for your site on [Facebook](developer.facebook.com).
+This requires a Facebook account, and may require additional authentication in the form of credit card or mobile phone verification.
-a. We'd be very happy if you include "Friendica" in the application name
-to increase name recognition. The Friendica icons are also present
-in the images directory and may be uploaded as a Facebook app icon.
-Use images/friendica-16.jpg for the Icon and images/friendica-128.jpg for the Logo.
+We'd be very happy if you include "Friendica" in the application name to increase name recognition.
+The Friendica icons are also present in the images directory and may be uploaded as a Facebook app icon.
+Use images/friendica-16.jpg for the Icon and images/friendica-128.jpg for the logo.
-b. The url should be your site URL with a trailing slash.
+The url should be your site URL with a trailing slash.
You **may** be required to provide a privacy and/or terms of service URL.
-c. Navigate to Set Web->Site URL & Domain -> Website Settings. Set Site URL
-to yoursubdomain.yourdomain.com. Set Site Domain to your yourdomain.com.
-
-d. Install the Facebook plugin on your Friendica site at 'admin/plugins'. You should then see a link for Facebook under 'Plugin Features' on the sidebar of the admin panel. Select that.
+Navigate to Set Web->Site URL & Domain -> Website Settings.
+Set Site URL to yoursubdomain.yourdomain.com.
+Set Site Domain to your yourdomain.com.
-e. Enter the App-ID and App Secret that Facebook gave you. Change any other settings as desired.
+Install the Facebook plugin on your Friendica site at 'admin/plugins'.
+You should then see a link for Facebook under 'Plugin Features' on the sidebar of the admin panel.
+Select it.
+Enter the App-ID and App Secret that Facebook gave you.
+Change any other settings as desired.
On Friendica, each member who wishes to use the Facebook connector should visit the Facebook Settings section of their "Settings->Connector Settings" page, and click 'Install Facebook Connector'.
Choose the appropriate settings for your usage and privacy requirements.
-This will ask you to login to Facebook and grant permission to the
-plugin to do its stuff. Allow it to do so.
-
-You're done. To turn it off visit the Connector Settings page again and
-'Remove Facebook posting'.
-
-Videos and embeds will not be posted if there is no other content. Links
-and images will be converted to a format suitable for the Facebook API and
-long posts truncated - with a link to view the full post.
-
-Facebook contacts will also not be able to view "private" photos, as they are not able to authenticate to your site to establish identity. We will address this in a future release.
-
-
+This will ask you to log into Facebook and grant permission to the plugin to do its stuff.
+Allow it to do so.
+You're done.
-
+To turn it off visit the Connector Settings page again and 'Remove Facebook posting'.
+Videos and embeds will not be posted if there is no other content.
+Links and images will be converted to a format suitable for the Facebook API and long posts truncated - with a link to view the full post.
+Facebook contacts will also not be able to view "private" photos, as they are not able to authenticate to your site.
+We will address this in a future release.
projects / friendica.git / commitdiff