Social Auth Discord 2.x - Installation instructions

Last updated on

8 May 2020

Social Auth Discord module depends on The League OAuth2 Discord library and uses Composer to download it. Composer can automatically download the correct version of the SDK for you.

Overview of installation steps

Step 1: Create a Discord application and get credentials by going to https://discordapp.com/developers/applications and then clicking on "New Application".
Step 2: Download Social Auth Discord and The League OAuth2 Discord library using Composer.
Step 3: Enable and configure Social Auth Discord module.

Step 1: Create a project

Create a new application on https://discordapp.com/developers/applications after signing in and then clicking on "New Application".
For redirect URI, enter the full URL to your drupal project + /user/login/discord/callback. For example, consider that your domain is http://www.example.com but your drupal project is at http://www.example.com/drupal. In this case, you should enter http://www.example.com/drupal/user/login/discord/callback

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

Let Composer download Social Auth Discord (and all its dependencies). The following command will download the latest 2.x release of Social Auth Discord:

composer require "drupal/social_auth_discord:^2.0"

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

composer require "drupal/social_api:2.x-dev" "drupal/social_auth:2.x-dev" "drupal/social_auth_discord:2.x-dev"

Social Auth Discord dev versions are usually only compatible with Social Auth and Social API dev versions. The command above installs the dev branch of all these modules.

Composer will automatically download wohali/oauth2-discord-new

Now that Composer has downloaded the Discord API PHP Client library and other dependencies, you can enable Social Auth Discord.

The module settings can be configured on /admin/config/social-api/social-auth/discord
Add your Client ID and Client Secret (from step 1) to the module settings
You probably also want to check your Drupal account settings at /admin/config/people/accounts, making sure that visitors can create accounts

Check the installation status and give it a try!

After you have completed steps 1-3 above, verify that you can see that Composer has downloaded The League OAuth2 Discord library to vendor/wohali/oauth2-discord-new directory of your Drupal installation.
Add a Social Auth Login block to any region. If you already have added a block before installing this module and nothing is shown, try rebuilding the cache
Click on the "Discord" logo
Alternatively, you can add a link anywhere on the site that points to user/login/discord

Support requests

Before posting a support request, carefully read the installation instructions provided on this page and do the setup in this order.
Once you have done this, you can post a support request at the module's issue queue. Support requests to the issue queue, please, not to the comments on this documentation page.
When posting a support request, please inform if you were able to see any errors in Recent log entries.

By clicking here, you'll find the list of all available scopes that you can enter in /admin/config/social-api/social-auth/discord and their respective descriptions. By default, the scopes identify, email, connections, guilds, guilds.join are already added. If you want to learn more about the Discord API and want to tweak the code itself, you can read the Discord OAuth API Guide.