plugins/FacebookBridge/README

   1 Facebook Bridge Plugin
   2
   3 The Facebook Bridge plugin allows you to integrate your StatusNet site
   4 with Facebook. It uses Facebook's new SDKs, the Graph API and OAuth
   5 2.0, and supercedes the previous "Facebook" plugin, which relied on the
   6 Facebook's now deprecated "Old REST API". The other major difference is
   7 the troublesome and confusing Facebook Canvas Application has been
   8 removed.
   9
  10 Note: Do NOT try to run the old Facebook plugin and this plugin at the same
  11 time. It won't work.
  12
  13 Features for the new Facebook Bridge Plugin:
  14
  15 - "Login with Facebook" (AKA single-sign-on using Facebook Connect for
  16   authentication).
  17
  18 - Registration with Facebook Connect, including automatic profile creation
  19   based on users' Facebook accounts.
  20
  21 - Post mirroring -- posting a notice on StatusNet automatically creates a post
  22   on Facebook, deleting it on StatusNet deletes it on Facebook, and faving it
  23   "likes" it on Facebook.
  24
  25
  26 Upgrading from the old Facebook plugin
  27 ======================================
  28
  29 Remove the addPlugin('Facebook') statement for the old Facebook plugin
  30 from your config.php and adjust your existing Facebook application using
  31 the setup instructions below as a guide, then enable the new plugin (also
  32 described below). Existing users who have setup post mirroring shouldn't
  33 have to do anything. The new Facebook Bridge plugin will keep their notices
  34 flowing to Facebook.
  35
  36 Setup
  37 =====
  38
  39 There are two parts configuring the Facebook Bridge plugin -- setup on the
  40 Facebook side, and setup on the StatusNet side.
  41
  42 Setup (Facebook side)
  43 =====================
  44
  45 The first step is to login to Facebook and register a Facebook application
  46 to get an application ID and secret.
  47
  48 Use the handy Facebook application setup wizard:
  49
  50 http://developers.facebook.com/setup/
  51
  52 Once you've set up your application, you'll need to enter the Facebook Developer
  53 dashboard (http://www.facebook.com/developers/editapp.php?app_id=YOUR_APPLICATION_ID)
  54 and customize a few things:
  55
  56 About tab
  57 ---------
  58
  59 Set your logos, application description, etc. as you see fit.
  60
  61 Web Site tab
  62 ------------
  63
  64 Make a note of the "Application ID" and "Application Secret" Facebook generated
  65 for your application. You'll need both of those later.
  66
  67 Make sure "Site URL" points to your StatusNet installation
  68 (e.g.: http://example.net/).
  69
  70 - Special Note for multi-site Status Networks: enter your domain (SLD and TLD)
  71   in the "Site Domain" field. (e.g.: status.net). This will allow a single
  72   Facebook Application to work with all your network subdomains (*.status.net).
  73
  74 Facebook Integration tab
  75 ------------------------
  76
  77 Use the default settings.
  78
  79 Mobile and Devices tab
  80 ----------------------
  81
  82 Use the default settings.
  83
  84 Advanced tab
  85 ------------
  86
  87 In the Authentication section, set the "Deauthorize Callback" to
  88 http://YOURSITE/facebook/deauthorize (e.g.: http://example.net/facebook/deauthorize).
  89
  90 In the Migrations section, ensure that "OAuth 2.0 for Canvas" is set to
  91 "Enabled". It probably already will be, but double check.
  92
  93 The default settings should suffice for everything else.
  94
  95 Setup (StatusNet side)
  96 ======================
  97
  98 To enable the Facebook Bridge plugin, add
  99
 100     addPlugin('FacebookBridge');
 101
 102 to you config.php.
 103
 104 Next login to your StatusNet site as a user with the administrator role, and
 105 navigate to the admin menu. You should see a new tab for the Facebook admin
 106 panel, titled "Facebook".  Enter your Facebook application ID and secret in
 107 that admin panel and hit save. After that, the Facebook Bridge Plugin should
 108 be ready to use.