Installation instructions

This handbook page contains installation instructions for Simple FB Connect version 8.x-3.x. See separate handbook pages for 7.x versions!

Simple Fb Connect 8.x-3-x MUST be installed using Composer

Simple FB Connect module uses Facebook PHP SDK library and uses Composer to download it. The module CAN NOT be installed using the zip or tar.gz file, they are informative only.

Overview of installation steps

1. Step 1: Install Simple FB Connect (and the required Facebook Graph SDK) using Composer.
2. Step 2: Enable Simple FB Connect module.
3. Step 3: Create a Facebook application on https://developers.facebook.com/apps
4. Step 4: Configure Simple FB Connect module.

Step 1: Install Simple FB Connect (and the required Facebook Graph SDK) using Composer

On the the command line of your server, navigate to your Drupal root directory.

Let's inform Composer that we want to use packages.drupal.org/8 as a package repository.
composer config repositories.drupal composer https://packages.drupal.org/8

Now that Composer can search packages from Drupal 8 package repository, let Composer download Simple Fb Connect (and all its dependencies). The following command will download the latest 8.x-3.0 release of Simple FB Connect:

composer require "drupal/simple_fb_connect:~3.0"

If you would like to use the 8.x-3.x-dev instead, use the following command:

composer require "drupal/simple_fb_connect:3.x-dev"

Step 2: Enable Simple FB Connect module

Now that Composer has downloaded the Simple FB Connect module (and the required Facebook Graph SDK library), you can enable Simple FB Connect module normally.

• The module settings can be found at /admin/config/people/simple-fb-connect
• Facebook App ID, App Secret and Graph API version are required. These will be added in step 4.
• You can find Valid OAuth redirect URIs, App Domains and Site URLs for your Facebook App settings. You will need these in step 3 when configuring the Facebook App.

Step 3: Create a Facebook application

• Create a new app on https://developers.facebook.com/apps
• Add Facebook Login to your app on Add Product and add the Valid OAuth redirect URI. Copy-paste the value from Simple FB Connect module settings.
  
• Go to App Basic settings and add Website platform.
  
• Enter your website's URL to Site URL. Copy-paste the value from Simple FB Connect module settings.
• Add your website's domain to App Domains. Copy-paste the value from Simple FB Connect module settings.
• Go to App Review and make your Facebook App live. If you don't want to do this yet, your app will remain in Developer mode which means that you can test the Facebook login with your own Facebook user account but this Facebook app can't be used by anyone else.
  

Step 4: Add App ID, App Secret and API version to Simple FB Connect module settings

Now that you have a Facebook App, you can fill in the App ID, App Secret and API version to Simple FB Connect module settings.

• The module settings can be configured on /admin/config/people/simple-fb-connect
• Add the Facebook App ID, App Secret and API version of your Facebook App to the module settings. These values can be found from the Facebook App Dashboard, see screenshot below.
  • The API version shown on Facebook App Dashboard is the oldest API version that your Facebook App can use but you can also use a newer version of the API.
  • If your Facebook App was created in September 2016, the App Dashboard would show that v2.7 is the oldest API version that you can use and you can configure this version to Simple FB Connect. However, Facebook released v2.8 of their API in October 2016 so you can also choose to use this version and configure v2.8 to Simple FB Connect module settings.
  • Available versions of Facebook API are available at https://developers.facebook.com/docs/apps/changelog
• You probably also want to check your Drupal account settings at /admin/config/people/accounts where you can configure if new accounts need approval by Drupal administrator.

Check installation status and give it a try!

• After you have completed steps 1-4 above, click on the "Facebook Login" tab on the user login page
• Alternatively you can add a link anywhere on the site that points to user/simple-fb-connect

Additional note related to caching

• If your site is using external caching mechanisms suchs as reverse proxies, you need to ensure that the paths /user/simple-fb-connect and /user/simple-fb-connect/return will not get cached.
• If you are using the Drupal 8 core caching mechanisms, there are no additional steps are needed.

Additional information on Composer and Drupal 8

Please refer to https://www.drupal.org/node/2718229 for more information on Drupal 8 and Composer.

If you are having troubles installing this module with Composer, you can try the following steps. The commands are executed on the Drupal root directory. 

1) Make sure that you have the latest version of Composer:
composer self-update

2) Make sure that you clear all Composer caches:
composer clear-cache

3) Update all Drupal dependencies before trying to install Simple FB Connect:
composer update
You should see a lot of Drupal core dependencies being updated to their latest versions.

4) Add packages.drupal.org/8 as another repository so that Simple FB Connect can be downloaded:
composer config repositories.drupal composer https://packages.drupal.org/8

5) Download latest Simple FB Connect 8.x-3.0 release:
composer require "drupal/simple_fb_connect:~3.0"
You should see Simple FB Connect being downloaded now.

6) You should now see that Simple FB Connect and Facebook Graph SDK are installed:
composer show

You should find the following packages from the list:

drupal/simple_fb_connect             3.0.0     Allows users to authenticat...
facebook/graph-sdk                   5.4.2     Facebook SDK for PHP

7) You should also see that Simple FB Connect is downloaded to modules/simple_fb_connect

8) You should also see that Facebook Graph SDK is downloaded to vendor/facebook/graph-sdk

Support requests

• Before posting a support request, carefully read the installation instructions provided on this page and do the setup exactly as instructed here. Please note that Simple Fb Connect can only be installed using Composer. It is not possible to install the module from the .zip or .tar.gz files.
• Before posting a support request, check Recent log entries at admin/reports/dblog
• Once you have done this, you can post a support request at module issue queue. Support requests to the issue queue, please, not to the comments of this documentation page.
• When posting a support request, please inform if you were able to see any errors when you ran Composer or if you have errors in Recent log entries.