plugins/FBConnect/README

   1 This plugin allows you to utilize Facebook Connect with StatusNet.
   2 Supported Facebook Connect features:
   3
   4 - Authenticate (register/login/logout -- works similar to OpenID)
   5 - Associate an existing StatusNet account with a Facebook account
   6 - Disconnect a Facebook account from a StatusNet account
   7
   8 Future planned functionality:
   9
  10 - Invite Facebook friends to use your StatusNet installation
  11 - Auto-subscribe Facebook friends already using StatusNet
  12 - Share StatusNet favorite notices to your Facebook stream
  13
  14 To use the plugin you will need to configure a Facebook application
  15 to point to your StatusNet installation (see the Installation section
  16 below).
  17
  18 Installation
  19 ============
  20
  21 If you don't already have the built-in Facebook application configured,
  22 you'll need to log into Facebook and create/configure a new application.
  23 Please follow the instructions in the section titled, "Setting Up Your
  24 Application and Getting an API Key," on the following page of the
  25 Facebook developer wiki:
  26
  27     http://wiki.developers.facebook.com/index.php/Connect/Setting_Up_Your_Site
  28
  29 If you already are using the build-in StatusNet Facebook application,
  30 you can modify your existing application's configuration using the
  31 Facebook Developer Application on Facebook.  Use it to edit your
  32 application settings, and under the 'Connect' tab, change the 'Connect
  33 URL' to be the main URL for your StatusNet site.  E.g.:
  34
  35     http://SITE/PATH_TO_STATUSNET/
  36
  37 After you application is created and configured, you'll need to add its
  38 API key and secret to your StatusNet config.php file:
  39
  40     $config['facebook']['apikey'] = 'APIKEY';
  41     $config['facebook']['secret'] = 'SECRET';
  42
  43 Finally, to enable the plugin, add the following stanza to your
  44 config.php:
  45
  46     addPlugin('FBConnect');
  47
  48 To try out the plugin, fire up your browser and connect to:
  49
  50     http://SITE/PATH_TO_STATUSNET/main/facebooklogin
  51
  52 or, if you do not have fancy URLs turned on:
  53
  54     http://SITE/PATH_TO_STATUSNET/index.php/main/facebooklogin
  55
  56 You should see a page with a blue button that says: "Connect with
  57 Facebook".
  58
  59 Connect/Disconnect existing account
  60 ===================================
  61
  62 If the Facebook Connect plugin is enabled, there will be a new Facebook
  63 Connect Settings tab under each user's Connect menu. Users can connect
  64 and disconnect to their Facebook accounts from it.  Note:  Before a user
  65 can disconnect from Facebook, she must set a normal StatusNet password.
  66 Otherwise, she might not be able to login in to her account in the
  67 future.  This is usually only required for users who have used Facebook
  68 Connect to register their StatusNet account, and therefore haven't
  69 already set a local password.
  70
  71 Helpful links
  72 =============
  73
  74 Facebook Connect Homepage:
  75 http://developers.facebook.com/connect.php
  76