From a5fbde222ffba30a990782ed289ada374978a90e Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Tue, 21 Jan 2014 14:01:03 +0000 Subject: [PATCH 1/2] Added doc for OpenShift cartridge --- docbook/reference/en/en-US/master.xml | 2 + .../reference/en/en-US/modules/openshift.xml | 71 +++++++++++++++++++ .../en/en-US/modules/social-facebook.xml | 10 ++- .../en/en-US/modules/social-twitter.xml | 13 ++-- 4 files changed, 89 insertions(+), 7 deletions(-) create mode 100644 docbook/reference/en/en-US/modules/openshift.xml diff --git a/docbook/reference/en/en-US/master.xml b/docbook/reference/en/en-US/master.xml index f3f6f40627..ed7ef6237b 100755 --- a/docbook/reference/en/en-US/master.xml +++ b/docbook/reference/en/en-US/master.xml @@ -4,6 +4,7 @@ + @@ -49,6 +50,7 @@ &License; &Overview; &Installation; + &OpenShift; Adapters diff --git a/docbook/reference/en/en-US/modules/openshift.xml b/docbook/reference/en/en-US/modules/openshift.xml new file mode 100644 index 0000000000..bbb9062a24 --- /dev/null +++ b/docbook/reference/en/en-US/modules/openshift.xml @@ -0,0 +1,71 @@ + + Running Keycloak Server on OpenShift + + + Keycloak provides a OpenShift cartridge to make it easy to get it running on OpenShift. If you don't already + have + an account or don't know how to create applications go to + + first. You can + create the Keycloak instance either with the web tool or the command line tool, both approaches are described + below. + + + + + It's important that immediately after creating a Keycloak instance you open the Administration Console + and login to reset the password. If this is not done anyone can easily gain admin rights to your Keycloak instance. + + + +
+ Create Keycloak instance with the web tool + + Open + + and click onAdd Application. + Scroll down to the bottom of the page to find the + Code Anything + section. Insert + https://raw.github.com/stianst/openshift-keycloak-cartridge/master/metadata/manifest.yml + into the + URL to a cartridge definition + field and click onNext. Fill in the + following form and click onCreate Application. + + + Click on Continue to the application overview page. Under the list of applications you should + find your Keycloak instance and the status should be Started. Click on it to open the Keycloak + servers homepage. + +
+ +
+ Create Keycloak instance with the web tool + + Run the following command from a terminal: + rhc app create <APPLICATION NAME> https://raw.github.com/stianst/openshift-keycloak-cartridge/master/metadata/manifest.yml + Replace <APPLICATION NAME> with the name you want (for example keycloak). + + + Once the instance is created the rhc tool outputs details about it. Open the returned URL in a + browser to open the Keycloak servers homepage. + +
+ +
+ Next steps + + The Keycloak servers homepage should show the Keycloak logo and Welcome to Keycloak. + There should also be a link to the Administration Console. Open that and log in using username + admin and password admin. On the first login you should be asked + to reset the password. + + + + On OpenShift Keycloak has been configured to only accept requests over https. If you try to use http + you should be redirected to https. + + +
+ diff --git a/docbook/reference/en/en-US/modules/social-facebook.xml b/docbook/reference/en/en-US/modules/social-facebook.xml index f173d21a53..bc87171234 100644 --- a/docbook/reference/en/en-US/modules/social-facebook.xml +++ b/docbook/reference/en/en-US/modules/social-facebook.xml @@ -21,9 +21,7 @@ Once the app has been created click on Settings in sidebar on the left. Then click on Advanced. Under Security make sure Client OAuth Login is enabled. In Valid OAuth redirect URIs insert - the social callback url. Facebook doesn't allow - localhost in the redirect URI, so if you are testing on a local server replace - localhost with 127.0.0.1. Scroll down and click on the + the social callback url. Scroll down and click on the Save Changes button. @@ -42,4 +40,10 @@ + + + Facebook doesn't allow localhost in the redirect URI. To test on a local server + replace localhost with 127.0.0.1. + + \ No newline at end of file diff --git a/docbook/reference/en/en-US/modules/social-twitter.xml b/docbook/reference/en/en-US/modules/social-twitter.xml index 316a178634..7f7f3fb603 100644 --- a/docbook/reference/en/en-US/modules/social-twitter.xml +++ b/docbook/reference/en/en-US/modules/social-twitter.xml @@ -11,10 +11,7 @@ Log in to the Twitter Developer Console. Click the Create a new application button. Use any value for Name, Description and Website you want. Insert the social callback url - in Callback URL. Twitter doesn't allow localhost in the redirect URI, - so if you are testing on a local server replace localhost with 127.0.0.1. - 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 Create your Twitter application. + in Callback URL. Then click Create your Twitter application. @@ -32,4 +29,12 @@ + + + Twitter doesn't allow localhost in the redirect URI. To test on a local server + replace localhost with 127.0.0.1. + Twitter also restricts connection to TLS/SSL connections only, so you are required to use HTTPS to access + Keycloak to enable log in with Twitter. + + \ No newline at end of file From ebf80b6deb6f82a2ec0ce38e28e488128533f1a5 Mon Sep 17 00:00:00 2001 From: Stian Thorgersen Date: Tue, 21 Jan 2014 14:40:05 +0000 Subject: [PATCH 2/2] Updated openshift cartridge url --- docbook/reference/en/en-US/modules/openshift.xml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docbook/reference/en/en-US/modules/openshift.xml b/docbook/reference/en/en-US/modules/openshift.xml index bbb9062a24..97b329a27d 100644 --- a/docbook/reference/en/en-US/modules/openshift.xml +++ b/docbook/reference/en/en-US/modules/openshift.xml @@ -27,7 +27,7 @@ Scroll down to the bottom of the page to find the Code Anything section. Insert - https://raw.github.com/stianst/openshift-keycloak-cartridge/master/metadata/manifest.yml + https://raw.github.com/keycloak/openshift-keycloak-cartridge/master/metadata/manifest.yml into the URL to a cartridge definition field and click onNext. Fill in the @@ -44,7 +44,7 @@ Create Keycloak instance with the web tool Run the following command from a terminal: - rhc app create <APPLICATION NAME> https://raw.github.com/stianst/openshift-keycloak-cartridge/master/metadata/manifest.yml + rhc app create <APPLICATION NAME> https://raw.github.com/keycloak/openshift-keycloak-cartridge/master/metadata/manifest.yml Replace <APPLICATION NAME> with the name you want (for example keycloak).