Configuration with Github

Adding the OAuth2 app in Github

  • Login to Github

  • Go to "Settings" > "Developer Settings" > "OAuth Apps" (https://github.com/settings/developers)

  • Click "new Oauth App"

    • Enter your TYPO3 installation domain as Homepage URL

    • Add the redirect URIs (backend):

      • https://<your-TYPO3-installation>/typo3/

    • Add the redirect URIs (frontend):

      • https://<your-TYPO3-installation>/<callback-slug>

  • Save the application

  • Copy the client secret and client id

TYPO3 OAuth2 Github App Configuration

Adding the OAuth2 Github app in TYPO3

Warning

Please use composer to install the Github provider: composer require "league/oauth2-github:^2.0". If you did not install the specific provider, you can still use the GenericProvider - however, you will need to add the URL configuration yourself.

Add the following configuration to your AdditionalConfiguration.php:

$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['oauth2_client'] = [
    'providers' => [
        'github' => [
            'label' => 'Github',
            'description' => 'Login with your github.com user.',
            'iconIdentifier' => 'oauth2-github',
            'implementationClassName' => \League\OAuth2\Client\Provider\Github::class,
            'scopes' => [
                \Waldhacker\Oauth2Client\Service\Oauth2ProviderManager::SCOPE_BACKEND,
            ],
            'options' => [
                'clientId' => '<your-client-id>',
                'clientSecret' => '<your-client-secret>',
            ],
        ],
    ],
];

Registering the icon (optional)

If you want to use a custom icon, in your site package Configuration/Icons.php register the icon like this:

<?php
   return [
       'oauth2-github' => [
           'provider' => \TYPO3\CMS\Core\Imaging\IconProvider\FontawesomeIconProvider::class,
           'name' => 'github',
       ],
   ];

If you want to use the default icon instead, remove the iconIdentifier from the configuration.