README 3.4 KB

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