Getting Started Guide

Keycloak downloadsから keycloak-14.0.0.[zip|tar.gz] をダウンロードします。

選択したディレクトリーにファイルを配置します。

unzip、tar、Expand-Archiveなどの適切な unzip ユーティリティーを使用して、ZIPファイルを解凍します。

$ unzip keycloak-14.0.0.zip

または

$ tar -xvzf keycloak-14.0.0.tar.gz

> Expand-Archive -Path 'C:Downloads\keycloak-14.0.0.zip' -DestinationPath 'C:\Downloads'

サーバー配布物の bin ディレクトリーに移動します。

standalone 起動スクリプトを実行します。

$ cd bin
$ ./standalone.sh

> ...\bin\standalone.bat

Webブラウザーで http://localhost:8080/auth を開きます。

ユーザー名とパスワードを入力して、最初の管理ユーザーを作成します。

Welcome ページの Administration Console リンクをクリックするか、 http://localhost:8080/auth/admin/ （コンソールURL）に直接アクセスします。

Welcome ページで作成したユーザー名とパスワードを入力して、 admin console を開きます。

http://localhost:8080/auth/admin/ に移動し、adminアカウントを使用してKeycloak管理コンソールにログインします。

Master のメニューから Add Realm を選択し、クリックします。masterレルムにログインすると、このメニューには他のすべてのレルムが一覧表示されます。

Name フィールドに demo と入力します。

Create をクリックします。

Select realm ドロップダウン・リストのエントリーをクリックして、 master レルムと作成したレルムの管理を切り替えます。

メニューから Users をクリックして、ユーザー一覧ページを開きます。

ユーザー追加ページを開くには、空のユーザーリストの右側にある Add User をクリックします。

Username フィールドに名前を入力します。

Email Verified スイッチを On に切り替え、 Save をクリックします。

Credentials タブをクリックして、新しいユーザーの仮パスワードを設定します。

新しいパスワードを入力して確認します。

ユーザーのパスワードを指定した新しいパスワードにするには、Set Password をクリックします。

ユーザーメニューを開き、 Sign Out を選択して、管理コンソールからログアウトします。

http://localhost:8080/auth/realms/demo/account に移動し、作成したユーザーとして demo レルムにログインします。

新しいパスワードの入力を求められたら、覚えやすいパスワードを入力します。

このページを使用してテストするには、必要なフィールドに値を入力します。

WildFly.org からWildFlyをダウンロードします。

ダウンロードしたWildFlyを解凍します。

$ unzip <filename>.zip

Keycloakのルート・ディレクトリーに移動します。

jboss.socket.binding.port-offset システム・プロパティーの値を指定して、Keycloakサーバーを起動します。この値は、Keycloakサーバーによって開かれたすべてのポートのベース値に追加されます。この例では、 100 です。

$ cd bin
$ ./standalone.sh -Djboss.socket.binding.port-offset=100

> ...\bin\standalone.bat -Djboss.socket.binding.port-offset=100

> ...\bin\standalone.bat -D"jboss.socket.binding.port-offset=100"

Keycloakサーバーが実行されていることを確認します。 http://localhost:8180/auth/admin/ にアクセスします。

keycloak.org から WildFly OpenID Connect Client Adapter の配布物をダウンロードします。

WildFlyのルート・ディレクトリーに移動します。

ダウンロードしたクライアント・アダプターをこのディレクトリーに解凍します。たとえば次のようにします。

$ unzip <filename>.zip

binディレクトリーに移動します。

$ cd bin

使用しているプラットフォームに適したスクリプトを実行します。

$ ./jboss-cli.sh --file=adapter-install-offline.cli

> jboss-cli.bat --file=adapter-install-offline.cli

$ ./jboss-cli.sh --file=adapter-elytron-install-offline.cli

> jboss-cli.bat --file=adapter-elytron-install-offline.cli

アプリケーション・サーバーを起動します。

$ ./standalone.sh

> ...\standalone.bat

管理者アカウントで管理コンソールにログインします： http://localhost:8180/auth/admin/

左上のドロップダウン・リストで Demo レルムを選択します。

左側のメニューの Clients をクリックして、クライアント・ページを開きます。

右側にある Create をクリックします。

Add Clientダイアログで、次のようにフィールドに入力して、 vanilla というクライアントを作成します。

Save をクリックします。

表示される Vanilla クライアントページで、 Installation タブをクリックします。

Keycloak OIDC JSON を選択して、後の手順で必要なファイルを生成します。

Download をクリックして Keycloak.json を後で見つけられる場所に保存します。

XMLテンプレートを生成するには、 Keycloak OIDC JBoss Subsystem XML を選択します。

次の手順で使用するために、 Download をクリックしてWildFlyの設定を含むコピーを保存します。

WildFlyのルート・ディレクトリーの standalone/configuration ディレクトリーに移動します。

standalone.xml ファイルを開き、次のテキストを検索します。

<subsystem xmlns="urn:jboss:domain:keycloak:1.1"/>

次に示すように、自己終了のXMLエントリーを開始タグと終了タグのペアを使用するように変更します。

<subsystem xmlns="urn:jboss:domain:keycloak:1.1">
</subsystem>

この例に示すように、 <subsystem> の要素内のXMLテンプレートの内容をペーストします。

<subsystem xmlns="urn:jboss:domain:keycloak:1.1">
  <secure-deployment name="WAR MODULE NAME.war">
    <realm>demo</realm>
    <auth-server-url>http://localhost:8180/auth</auth-server-url>
    <public-client>true</public-client>
    <ssl-required>EXTERNAL</ssl-required>
    <resource>vanilla</resource>
  </secure-deployment>
</subsystem>

WAR MODULE NAME.war を vanilla.war に変更します。

<subsystem xmlns="urn:jboss:domain:keycloak:1.1">
  <secure-deployment name="vanilla.war">
  ...
</subsystem>

アプリケーション・サーバーを再起動します。

WildFlyアプリケーション・サーバーが起動していることを確認してください。

次のコマンドを使用して、コードをダウンロードし、ディレクトリーを変更します。

$ git clone https://github.com/keycloak/keycloak-quickstarts
$ cd keycloak-quickstarts/app-profile-jee-vanilla/config

keycloak.json ファイルを現在のディレクトリーにコピーします。

1つ上のレベルの app-profile-jee-vanilla ディレクトリーに移動します。

次のコマンドを使用してコードをインストールします。

$ mvn clean wildfly:deploy

アプリケーションのインストールが成功したことを確認します。ログインページが表示される http://localhost:8080/vanilla に移動します。

demoレルムで作成したアカウントを使用してログインします。