Merge pull request #2293 from nemonik/keycloak-idp-doc-tweak

Keycloak idp doc tweak

Author: sameersbn

docs/keycloak-idp.md

@@ -26,6 +26,8 @@ Next, click save, get the client secret generated by Keycloak and start filling
 
 ![Keycloak client secret](images/keycloak-secret.png)
 
+Set the following in the docker-compose file:
+
 ```yaml
     - OAUTH2_GENERIC_APP_SECRET=<your-client-secret>
     - OAUTH2_GENERIC_CLIENT_SITE=http://<your-ip-address>:10081
@@ -35,7 +37,19 @@ Next, click save, get the client secret generated by Keycloak and start filling
     - OAUTH2_GENERIC_CLIENT_END_SESSION_ENDPOINT=http://<your-ip-address>:10081/auth/realms/master/protocol/openid-connect/logout
 ```
 
-Make sure the following variables are filled in the docker-compose file:
+`<your-ip-address>` is the IP address of your keycloak. For this example this would be your IP address, but if your Keycloak existed elsewhere for your deployment `<your-ip-address>` would be different as would the port and the realm. 
+
+The following must also be configured:
+
+```yaml
+    - OAUTH2_GENERIC_USER_UID='preffered_usename'
+    - OAUTH2_GENERIC_USER_NAME='name'
+    - OAUTH2_GENERIC_USER_EMAIL='email'    
+```
+
+The values will be different for your deployment. Navigate Keycloak's UI, select `Clients`, click `[your client]`, then open the `Client Scopes` tab, then open `Evaluate` sub-tab, enter a username you know in the `User` field, select the match, then `Generate Access Token` to see the values you need to configure. 
+
+Also, make sure the following variables are filled in the docker-compose file:
 
 ```yaml
     - GITLAB_HOST='<your-ip-address>'
@@ -46,9 +60,10 @@ Make sure the following variables are filled in the docker-compose file:
     - OAUTH_BLOCK_AUTO_CREATED_USERS=false
     - OAUTH_AUTO_LINK_LDAP_USER=false
     - OAUTH_AUTO_LINK_SAML_USER=false
-    - OAUTH_EXTERNAL_PROVIDERS=Keycloak
 ```
 
+`<your-ip-address>` is the IP address of your GitLab for this example this would be the your IP address, but if your GitLab was to be proxied or deployed elsewhere `<your-ip-address>` would be another value appropriate for your deployment.
+
 GitLab does not allow login from users in Keycloak with an empty email or name. To prevent this, you can create a new user in Keycloak or you can add email and name for the admin account.
 
 Visit the `Users` tab and click on `View all users` to modify the Admin user.
@@ -62,4 +77,4 @@ Deploy GitLab, Reddis and PostgreSQL by running the following command: `docker-c
 
 You can now login on the local GitLab instance with with Keycloak on your [local IP](http://localhost:10080).
 
-![gitlab-login](images/keycloak-gitlab-login.png)
+![gitlab-login](images/keycloak-gitlab-login.png)