keycloak-scim/docbook/auth-server-docs/reference/en/en-US/modules/social-github.xml

<!--
  ~ Copyright 2016 Red Hat, Inc. and/or its affiliates
  ~ and other contributors as indicated by the @author tags.
  ~
  ~ Licensed under the Apache License, Version 2.0 (the "License");
  ~ you may not use this file except in compliance with the License.
  ~ You may obtain a copy of the License at
  ~
  ~ http://www.apache.org/licenses/LICENSE-2.0
  ~
  ~ Unless required by applicable law or agreed to in writing, software
  ~ distributed under the License is distributed on an "AS IS" BASIS,
  ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  ~ See the License for the specific language governing permissions and
  ~ limitations under the License.
  -->

<section id="social-github">
    <title>GitHub</title>
    <para>
        To enable login with GitHub you first have to create an application in
        <link xlink:href="https://github.com/settings/applications">GitHub Settings</link>. Then you need to copy
        the client id and secret into the Keycloak Admin Console.
    </para>
    <orderedlist>
        <listitem>
            <para>
                Log in to <link xlink:href="https://github.com/settings/applications">GitHub Settings</link>. Click the
                <literal>Register new application</literal> button. Use any value for <literal>Application name</literal>,
                <literal>Homepage URL</literal> and <literal>Application Description</literal> you want. In <literal>Authorization callback URL</literal>
                enter the <link linkend="social-callbackurl">social callback url</link> for your realm. Click the
                <literal>Register application</literal> button.
            </para>
        </listitem>
        <listitem>
            <para>
                Copy <literal>Client ID</literal> and <literal>Client secret</literal> from the
                <link xlink:href="https://github.com/settings/applications">GitHub Settings</link> into the settings
                page in the Keycloak Admin Console as the <literal>Key</literal> and <literal>Secret</literal>. Then click
                <literal>Save</literal> in the Keycloak Admin Console to enable login with GitHub.
            </para>
        </listitem>
    </orderedlist>
</section>