libre.sh/keycloak-scim
3
0
Fork 0
Code Issues 15 Pull requests Releases 1 Packages Activity Actions

Merge pull request #1454 from brmeyer/KEYCLOAK-1563

Browse source 
KEYCLOAK-1563 update docs for server/adapter subsystem split & WF 9.0…
This commit is contained in:
Stian Thorgersen 2015-07-15 09:37:00 +02:00
commit 1ebec0e2e5
3 changed files with 27 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docbook/reference/en/en-US/modules/MigrationFromOlderVersions.xml
View file

@ -103,11 +103,11 @@
</para> </para>
</simplesect> </simplesect>
<simplesect> <simplesect>
<title>WildFly 9.0.0.CR2</title> <title>WildFly 9.0.0.Final</title>
<para> <para>
Following on from the distribution changes that was done in the last release the standalone download Following on from the distribution changes that was done in the last release the standalone download
of Keycloak is now based on WildFly 9.0.0.CR2. This als affects the overlay which can only be deployed of Keycloak is now based on WildFly 9.0.0.Final. This als affects the overlay which can only be deployed
to WildFly 9.0.0.CR2 or JBoss EAP 6.4.0.GA. WildFly 8.2.0.Final is no longer supported for the server. to WildFly 9.0.0.Final or JBoss EAP 6.4.0.GA. WildFly 8.2.0.Final is no longer supported for the server.
</para> </para>
</simplesect> </simplesect>
<simplesect> <simplesect>

32
docbook/reference/en/en-US/modules/jboss-adapter.xml
View file

@ -199,7 +199,7 @@ public class CustomerService {
<title>Securing WARs via Keycloak Subsystem</title> <title>Securing WARs via Keycloak Subsystem</title>
<para> <para>
You do not have to crack open a WAR to secure it with Keycloak. Alternatively, you can externally secure You do not have to crack open a WAR to secure it with Keycloak. Alternatively, you can externally secure
it via the Keycloak Subsystem. While you don't have to specify KEYCLOAK as an <literal>auth-method</literal>, it via the Keycloak Adapter Subsystem. While you don't have to specify KEYCLOAK as an <literal>auth-method</literal>,
you still have to define the <literal>security-constraints</literal> in <literal>web.xml</literal>. You do you still have to define the <literal>security-constraints</literal> in <literal>web.xml</literal>. You do
not, however, have to create a <literal>WEB-INF/keycloak.json</literal> file. This metadata is instead defined not, however, have to create a <literal>WEB-INF/keycloak.json</literal> file. This metadata is instead defined
within XML in your server's <literal>domain.xml</literal> or <literal>standalone.xml</literal> subsystem within XML in your server's <literal>domain.xml</literal> or <literal>standalone.xml</literal> subsystem
@ -207,20 +207,22 @@ public class CustomerService {
</para> </para>
<para> <para>
<programlisting><![CDATA[ <programlisting><![CDATA[
<server xmlns="urn:jboss:domain:1.4"> <extensions>
<extension module="org.keycloak.keycloak-adapter-subsystem"/>
</extensions>
<profile> <profile>
<subsystem xmlns="urn:jboss:domain:keycloak:1.0"> <subsystem xmlns="urn:jboss:domain:keycloak:1.1">
<secure-deployment name="WAR MODULE NAME.war"> <secure-deployment name="WAR MODULE NAME.war">
<realm>demo</realm> <realm>demo</realm>
<realm-public-key>MIGfMA0GCSqGSIb3DQEBAQUAA</realm-public-key> <realm-public-key>MIGfMA0GCSqGSIb3DQEBAQUAA</realm-public-key>
<auth-server-url>http://localhost:8081/auth</auth-server-url> <auth-server-url>http://localhost:8081/auth</auth-server-url>
<ssl-required>external</ssl-required> <ssl-required>external</ssl-required>
<resource>customer-portal</resource> <resource>customer-portal</resource>
<credential name="secret">password</credential> <credential name="secret">password</credential>
</secure-deployment> </secure-deployment>
</subsystem> </subsystem>
</profile> </profile>
]]> ]]>
</programlisting> </programlisting>
</para> </para>
@ -242,7 +244,7 @@ public class CustomerService {
</para> </para>
<para> <para>
<programlisting><![CDATA[ <programlisting><![CDATA[
<subsystem xmlns="urn:jboss:domain:keycloak:1.0"> <subsystem xmlns="urn:jboss:domain:keycloak:1.1">
<realm name="demo"> <realm name="demo">
<realm-public-key>MIGfMA0GCSqGSIb3DQEBA</realm-public-key> <realm-public-key>MIGfMA0GCSqGSIb3DQEBA</realm-public-key>
<auth-server-url>http://localhost:8080/auth</auth-server-url> <auth-server-url>http://localhost:8080/auth</auth-server-url>

14
docbook/reference/en/en-US/modules/server-installation.xml
View file

@ -43,10 +43,10 @@
<section id="overlay_install"> <section id="overlay_install">
<title>Install on existing WildFly 9.0.0.CR2</title> <title>Install on existing WildFly 9.0.0.Final</title>
<para> <para>
Keycloak can be installed into an existing WildFly 9.0.0.CR2 server. To do this download Keycloak can be installed into an existing WildFly 9.0.0.Final server. To do this download
<literal>keycloak-overlay-&project.version;.zip</literal> or <literal>keycloak-overlay-&project.version;.tar.gz</literal>. <literal>keycloak-overlay-&project.version;.zip</literal> or <literal>keycloak-overlay-&project.version;.tar.gz</literal>.
Once downloaded extract into the root directory of your WildFly installation. To start WildFly with Keycloak Once downloaded extract into the root directory of your WildFly installation. To start WildFly with Keycloak
run: run:
<programlisting>keycloak-&project.version;/bin/standalone.sh --server-config=standalone-keycloak.xml</programlisting> <programlisting>keycloak-&project.version;/bin/standalone.sh --server-config=standalone-keycloak.xml</programlisting>
@ -65,16 +65,16 @@
to, for example <literal>standalone/configuration/standalone.xml</literal>. From <literal>standalone-keycloak.xml</literal> to, for example <literal>standalone/configuration/standalone.xml</literal>. From <literal>standalone-keycloak.xml</literal>
you need to copy 3 elements: you need to copy 3 elements:
<itemizedlist> <itemizedlist>
<listitem><literal>&lt;extension module="org.keycloak.keycloak-subsystem"/&gt;</literal></listitem> <listitem><literal>&lt;extension module="org.keycloak.keycloak-server-subsystem"/&gt;</literal></listitem>
<listitem><literal>&lt;datasource jndi-name="java:jboss/datasources/KeycloakDS" ...&gt;</literal></listitem> <listitem><literal>&lt;datasource jndi-name="java:jboss/datasources/KeycloakDS" ...&gt;</literal></listitem>
<listitem><literal>&lt;subsystem xmlns="urn:jboss:domain:keycloak:1.0" ...&gt;</literal></listitem> <listitem><literal>&lt;subsystem xmlns="urn:jboss:domain:keycloak-server:1.1" ...&gt;</literal></listitem>
</itemizedlist> </itemizedlist>
</para> </para>
</section> </section>
<section> <section>
<title>Install on existing JBoss EAP 6.4.0.GA</title> <title>Install on existing JBoss EAP 6.4.0.GA</title>
<para> <para>
Same procedure as JBoss EAP 6.4.0.GA, but download <literal>keycloak-overlay-eap6-&project.version;.zip</literal> or <literal>keycloak-overlay-eap6-&project.version;.tar.gz</literal>. Same procedure as WildFly 9.0.0.Final, but download <literal>keycloak-overlay-eap6-&project.version;.zip</literal> or <literal>keycloak-overlay-eap6-&project.version;.tar.gz</literal>.
</para> </para>
</section> </section>
<section> <section>
@ -84,7 +84,7 @@
To install it first download <literal>keycloak-demo-&project.version;.zip</literal> or To install it first download <literal>keycloak-demo-&project.version;.zip</literal> or
<literal>keycloak-demo-&project.version;.tar.gz</literal>. Once downloaded extract it inside <literal>keycloak-demo-&project.version;.tar.gz</literal>. Once downloaded extract it inside
<literal>keycloak-demo-&project.version;</literal> you'll find <literal>keycloak</literal> which contains <literal>keycloak-demo-&project.version;</literal> you'll find <literal>keycloak</literal> which contains
a full WildFly 9.0.0.CR2 server with Keycloak Server and Adapters included. You'll also find <literal>docs</literal> a full WildFly 9.0.0.Final server with Keycloak Server and Adapters included. You'll also find <literal>docs</literal>
and <literal>examples</literal> which contains everything you need to get started developing applications that use Keycloak. and <literal>examples</literal> which contains everything you need to get started developing applications that use Keycloak.
</para> </para>
<para> <para>