keycloak-scim/docbook/auth-server-docs/reference/en/en-US/modules/jetty8-adapter.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="jetty8-adapter">
    <title>Jetty 8.1.x Adapter</title>
    <para>
        Keycloak has a separate adapter for Jetty 8.1.x that you will have to install into your Jetty
        installation.  You then have to provide some extra configuration in each WAR you deploy to
        Jetty.  Let's go over these steps.
    </para>
    <section id="jetty8-adapter-installation">
        <title>Adapter Installation</title>
        <para>
            Adapters are no longer included with the appliance or war distribution.Each adapter is a separate download on
            the Keycloak download site.  They are also available as a maven artifact.
        </para>
    <para>
        You must unzip the Jetty 8.1.x  distro into Jetty 8.1.x's root directory.  Including
        adapter's jars within your WEB-INF/lib directory will not work!
    </para>
    <para>
<programlisting>
$ cd $JETTY_HOME
$ unzip keycloak-jetty81-adapter-dist.zip
</programlisting>
    </para>
    <para>
        Next, you will have to enable the keycloak option.  Edit start.ini and add keycloak to the options
    </para>
        <para>
<programlisting>
<![CDATA[
#===========================================================
# Start classpath OPTIONS.
# These control what classes are on the classpath
# for a full listing do
#   java -jar start.jar --list-options
#-----------------------------------------------------------
OPTIONS=Server,jsp,jmx,resources,websocket,ext,plus,annotations,keycloak
]]>
</programlisting>

        </para>
    </section>

    <section>
        <title>Required Per WAR Configuration</title>
        <para>
            Enabling Keycloak for your WARs is the same as the Jetty 9.x adapter.  Our 8.1.x adapter supports both keycloak.json
            and the jboss-web.xml advanced configuration.  See <link linkend="jetty9_per_war">Required Per WAR Configuration</link>
        </para>
     </section>
</section>