Moved social config instructions from admin console to documentation
This commit is contained in:
Stian Thorgersen committed
1 parent
d34c73f9b9
commit
2b38df9495
14 files changed
+192
-138
No files matched your search
@@ -7,6 +7,11 @@
|
||||
<!ENTITY AdapterConfig SYSTEM "modules/adapter-config.xml">
|
||||
<!ENTITY WildflyAdapter SYSTEM "modules/wildfly-adapter.xml">
|
||||
<!ENTITY EAP6Adapter SYSTEM "modules/eap6-adapter.xml">
|
||||
<!ENTITY SocialConfig SYSTEM "modules/social-config.xml">
|
||||
<!ENTITY SocialFacebook SYSTEM "modules/social-facebook.xml">
|
||||
<!ENTITY SocialGoogle SYSTEM "modules/social-google.xml">
|
||||
<!ENTITY SocialTwitter SYSTEM "modules/social-twitter.xml">
|
||||
<!ENTITY SocialProviderSPI SYSTEM "modules/social-spi.xml">
|
||||
]>
|
||||
|
||||
<book>
|
||||
@@ -55,5 +60,18 @@
|
||||
&EAP6Adapter;
|
||||
</chapter>
|
||||
|
||||
<chapter>
|
||||
<title>Social</title>
|
||||
<para>
|
||||
Social login description
|
||||
</para>
|
||||
&SocialConfig;
|
||||
&SocialFacebook;
|
||||
&SocialGoogle;
|
||||
&SocialTwitter;
|
||||
&SocialProviderSPI;
|
||||
</chapter>
|
||||
|
||||
</book>
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
<section id="social-config">
|
||||
<title>Social Login Config</title>
|
||||
<para>
|
||||
Social login config description
|
||||
</para>
|
||||
|
||||
<section id="social-callbackurl">
|
||||
<title>Social Callback URL</title>
|
||||
<para>
|
||||
There is a single callback url used by all realms and social providers. This makes it possible to share
|
||||
the configuration for a social network between multiple realms. An example callback url is
|
||||
<literal>http://localhost:8080/auth/rest/social/callback</literal>. To get the callback url for your server
|
||||
replace <literal>http://localhost:8080</literal> with the base address of your server. You can also
|
||||
find the callback url in the Keycloak Admin Console under social settings.
|
||||
</para>
|
||||
</section>
|
||||
</section>
|
||||
@@ -0,0 +1,45 @@
|
||||
<section id="social-facebook">
|
||||
<title>Facebook</title>
|
||||
<para>
|
||||
To enable login with Facebook you first have to create an app in the
|
||||
<ulink url="https://developers.facebook.com/">Facebook Developer Console</ulink>. Then you need to copy
|
||||
the client id and secret into the Keycloak Admin Console.
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Log in to the <ulink url="https://developers.facebook.com/">Facebook Developer Console</ulink>. Click
|
||||
<literal>Apps</literal> in the menu and select <literal>Create a New App</literal>. Use any value for
|
||||
<literal>Display Name</literal> and <literal>Category</literal> you want, then click the
|
||||
<literal>Create App</literal> button. Wait for the project to be created (this may take a while). If after
|
||||
creating the app you are not redirected to the app settings, click on <literal>Apps</literal> in the
|
||||
menu and select the app you created.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Once the app has been created click on <literal>Settings</literal> in sidebar on the left. Then click
|
||||
on <literal>Advanced</literal>. Under <literal>Security</literal> make sure
|
||||
<literal>Client OAuth Login</literal> is enabled. In <literal>Valid OAuth redirect URIs</literal> insert
|
||||
the <link linkend="social-callbackurl">social callback url</link>. Facebook doesn't allow
|
||||
<literal>localhost</literal> in the redirect URI, so if you are testing on a local server replace
|
||||
<literal>localhost</literal> with <literal>127.0.0.1</literal>. Scroll down and click on the
|
||||
<literal>Save Changes</literal> button.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Click <literal>Status & Review</literal> and select <literal>YES</literal> for <literal>Do you want
|
||||
to make this app and all its live features available to the general public?</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Click <literal>Basic</literal>. Copy <literal>App ID</literal> and <literal>App Secret</literal>
|
||||
(click <literal>show</literal>) from the <ulink url="https://developers.facebook.com/">Facebook Developer Console</ulink> 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 Facebook.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
@@ -0,0 +1,48 @@
|
||||
<section id="social-google">
|
||||
<title>Google</title>
|
||||
<para>
|
||||
To enable login with Google you first have to create a project and a client in the
|
||||
<ulink url="https://cloud.google.com/console/project">Google Developer Console</ulink>. Then you need to copy
|
||||
the client id and secret into the Keycloak Admin Console.
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Log in to the <ulink url="https://cloud.google.com/console/project">Google Developer Console</ulink>. Click the
|
||||
<literal>Create Project</literal> button. Use any value for <literal>Project name</literal> and
|
||||
<literal>Project ID</literal> you want, then click the <literal>Create</literal> button. Wait for the project to
|
||||
be created (this may take a while).
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Once the project has been created click on <literal>APIs & auth</literal> in sidebar on the left. To retrieve
|
||||
user profiles the <literal>Google+ API</literal> has to be enabled. Scroll down to find it in the list. If its
|
||||
status is <literal>OFF</literal>, click on <literal>OFF</literal> to enable it (it should move to the top of
|
||||
the list and the status should be <literal>ON</literal>).
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Now click <literal>Credentials</literal> in the sidebar on the left. Then click
|
||||
<literal>Create New Client ID</literal>. Select <literal>Web application</literal> as
|
||||
<literal>Application type</literal>. Empty the <literal>Authorized Javascript origins</literal> textarea. In
|
||||
<literal>Authorized redirect URI</literal> enter the <link linkend="social-callbackurl">social callback url</link>
|
||||
for your realm. Click the <literal>Create Client ID</literal> button.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Copy <literal>Client ID</literal> and <literal>Client secret</literal> from the
|
||||
<ulink url="https://cloud.google.com/console/project">Google Developer Console</ulink> 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 Google.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
<para>
|
||||
You may also want to configure how the Google Consent Screen looks when users log in to your application via
|
||||
Google. To do this go to <ulink url="https://cloud.google.com/console/project">Google Developer Console</ulink>
|
||||
and click on <literal>Consent Screen</literal> in the sidebar to the left.
|
||||
</para>
|
||||
</section>
|
||||
@@ -0,0 +1,11 @@
|
||||
<section id="social-spi">
|
||||
<title>Social Provider SPI</title>
|
||||
<para>
|
||||
Keycloak provides an SPI to make it easy to add additional social providers. This is done by implementing the
|
||||
<ulink url="https://raw.github.com/keycloak/keycloak/master/social/core/src/main/java/org/keycloak/social/SocialProvider.java">SocialProvider</ulink>
|
||||
interface and providing a provider configuration file (<literal>META-INF/services/org.keycloak.social.SocialProvider</literal>).
|
||||
</para>
|
||||
<para>
|
||||
A good reference for implementing a Social Provider is the <ulink url="https://github.com/keycloak/keycloak/tree/master/social/google">Google provider</ulink>.
|
||||
</para>
|
||||
</section>
|
||||
@@ -0,0 +1,35 @@
|
||||
<section id="social-twitter">
|
||||
<title>Twitter</title>
|
||||
<para>
|
||||
To enable login with Twtter you first have to create an application in the
|
||||
<ulink url="https://dev.twitter.com/apps">Twitter Developer Console</ulink>. Then you need to copy
|
||||
the consumer key and secret into the Keycloak Admin Console.
|
||||
</para>
|
||||
<orderedlist>
|
||||
<listitem>
|
||||
<para>
|
||||
Log in to the <ulink url="https://dev.twitter.com/apps">Twitter Developer Console</ulink>. Click the
|
||||
<literal>Create a new application</literal> button. Use any value for <literal>Name</literal>,
|
||||
<literal>Description</literal> and <literal>Website</literal> you want. Insert the social callback url
|
||||
in <literal>Callback URL</literal>. Twitter doesn't allow <literal>localhost</literal> in the redirect URI,
|
||||
so if you are testing on a local server replace <literal>localhost</literal> with <literal>127.0.0.1</literal>.
|
||||
Twitter also restricts connection to TLS/SSL connections only, this means that you have to use HTTPS to
|
||||
access Keycloak in order to log in via Twitter. Then click <literal>Create your Twitter application</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Now click on <literal>Settings</literal> and tick the box <literal>Allow this application to be used to Sign in with Twitter</literal>,
|
||||
then click on <literal>Update this Twitter application's settings</literal>.
|
||||
</para>
|
||||
</listitem>
|
||||
<listitem>
|
||||
<para>
|
||||
Now click <literal>Details</literal>. Copy <literal>Consumer key</literal> and <literal>Consumer secret</literal> from the
|
||||
<ulink url="https://dev.twitter.com/apps">Twitter Developer Console</ulink> 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 Twitter.
|
||||
</para>
|
||||
</listitem>
|
||||
</orderedlist>
|
||||
</section>
|
||||
Reference in new issue
Block a user