gnu-social/plugins/FBConnect/README

77 lines
2.7 KiB
Plaintext
Raw Normal View History

2009-08-26 08:33:43 +01:00
This plugin allows you to utilize Facebook Connect with StatusNet.
Supported Facebook Connect features:
- Authenticate (register/login/logout -- works similar to OpenID)
2009-08-26 08:33:43 +01:00
- Associate an existing StatusNet account with a Facebook account
- Disconnect a Facebook account from a StatusNet account
Future planned functionality:
2009-08-26 08:33:43 +01:00
- Invite Facebook friends to use your StatusNet installation
- Auto-subscribe Facebook friends already using StatusNet
- Share StatusNet favorite notices to your Facebook stream
To use the plugin you will need to configure a Facebook application
2009-08-26 08:33:43 +01:00
to point to your StatusNet installation (see the Installation section
below).
Installation
============
If you don't already have the built-in Facebook application configured,
you'll need to log into Facebook and create/configure a new application.
Please follow the instructions in the section titled, "Setting Up Your
Application and Getting an API Key," on the following page of the
Facebook developer wiki:
http://wiki.developers.facebook.com/index.php/Connect/Setting_Up_Your_Site
2009-08-26 08:33:43 +01:00
If you already are using the build-in StatusNet Facebook application,
you can modify your existing application's configuration using the
Facebook Developer Application on Facebook. Use it to edit your
application settings, and under the 'Connect' tab, change the 'Connect
2009-08-26 08:33:43 +01:00
URL' to be the main URL for your StatusNet site. E.g.:
2009-08-26 08:33:43 +01:00
http://SITE/PATH_TO_STATUSNET/
After you application is created and configured, you'll need to add its
2009-08-26 08:33:43 +01:00
API key and secret to your StatusNet config.php file:
$config['facebook']['apikey'] = 'APIKEY';
$config['facebook']['secret'] = 'SECRET';
Finally, to enable the plugin, add the following stanza to your
config.php:
addPlugin('FBConnect');
To try out the plugin, fire up your browser and connect to:
2009-08-26 08:33:43 +01:00
http://SITE/PATH_TO_STATUSNET/main/facebooklogin
or, if you do not have fancy URLs turned on:
2009-08-26 08:33:43 +01:00
http://SITE/PATH_TO_STATUSNET/index.php/main/facebooklogin
You should see a page with a blue button that says: "Connect with
Facebook".
Connect/Disconnect existing account
===================================
If the Facebook Connect plugin is enabled, there will be a new Facebook
Connect Settings tab under each user's Connect menu. Users can connect
and disconnect to their Facebook accounts from it. Note: Before a user
2009-08-26 08:33:43 +01:00
can disconnect from Facebook, she must set a normal StatusNet password.
Otherwise, she might not be able to login in to her account in the
future. This is usually only required for users who have used Facebook
2009-08-26 08:33:43 +01:00
Connect to register their StatusNet account, and therefore haven't
already set a local password.
Helpful links
=============
Facebook Connect Homepage:
http://developers.facebook.com/connect.php