plugins/FBConnect/README

   1 This plugin allows you to utilize Facebook Connect with Laconica.
   2 Supported Facebook Connect features:
   3
   4 - Authenticate (register/login/logout -- works similar to OpenID)
   5 - Associate an existing Laconica account with a Facebook account
   6 - Disconnect a Facebook account from a Laconica account
   7
   8 Future planned functionality:
   9
  10 - Invite Facebook friends to use your Laconica installation
  11 - Auto-subscribe Facebook friends already using Laconica
  12 - Share Laconica 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 Laconica 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 Laconica 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 Laconica site.  E.g.:
  34
  35     http://SITE/PATH_TO_LACONICA/
  36
  37 After you application is created and configured, you'll need to add its
  38 API key and secret to your Laconica 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     require_once(INSTALLDIR.'/plugins/FBConnect/FBConnectPlugin.php');
  47     $fbc = new FBConnectPlugin();
  48
  49 To try out the plugin, fire up your browser and connect to:
  50
  51     http://SITE/PATH_TO_LACONICA/main/facebooklogin
  52
  53 or, if you do not have fancy URLs turned on:
  54
  55     http://SITE/PATH_TO_LACONICA/index.php/main/facebooklogin
  56
  57 You should see a page with a blue button that says: "Connect with
  58 Facebook".
  59
  60 Connect/Disconnect existing account
  61 ===================================
  62
  63 If the Facebook Connect plugin is enabled, there will be a new Facebook
  64 Connect Settings tab under each user's Connect menu. Users can connect
  65 and disconnect to their Facebook accounts from it.  Note:  Before a user
  66 can disconnect from Facebook, she must set a normal Laconica password.
  67 Otherwise, she might not be able to login in to her account in the
  68 future.  This is usually only required for users who have used Facebook
  69 Connect to register their Laconica account, and therefore haven't
  70 already set a local password.
  71
  72 Helpful links
  73 =============
  74
  75 Facebook Connect Homepage:
  76 http://developers.facebook.com/connect.php
  77