Docker

Docker で Keycloak を始める

開始する前に

Keycloak のご希望の用途に対して、お使いのマシンまたはコンテナプラットフォームが十分なメモリと CPU を提供できることを確認してください。本番環境のサイジングを始める方法の詳細については、「CPU およびメモリリソースのサイジングに関するコンセプト」を参照してください。

Docker がインストールされていることを確認してください。

Keycloak を起動する

ターミナルから、次のコマンドを入力して Keycloak を起動します。

docker run -p 8080:8080 -e KC_BOOTSTRAP_ADMIN_USERNAME=admin -e KC_BOOTSTRAP_ADMIN_PASSWORD=admin quay.io/keycloak/keycloak:26.2.0 start-dev

このコマンドは、ローカルポート 8080 で公開された Keycloak を起動し、ユーザー名 admin とパスワード admin を持つ初期管理者ユーザーを作成します。

Admin Console にログインする

  1. Keycloak Admin Console にアクセスします。

  2. 先ほど作成したユーザー名とパスワードでログインします。

レルムを作成する

Keycloak におけるレルムは、テナントに相当します。各レルムにより、管理者はアプリケーションとユーザーの独立したグループを作成できます。初期状態では、Keycloak には master という単一のレルムが含まれています。このレルムは Keycloak の管理専用とし、アプリケーションの管理には使用しないでください。

次の手順で最初のレルムを作成します。

  1. Keycloak Admin Console を開きます。

  2. 現在のレルム の横にある レルムの作成 をクリックします。

  3. レルム名 フィールドに myrealm と入力します。

  4. 作成 をクリックします。

Add realm
図 1. レルムの追加

ユーザーを作成する

初期状態では、レルムにはユーザーがいません。ユーザーを作成するには、次の手順に従ってください。

  1. 現在のレルム の横にある myrealm レルムにまだいることを確認してください。

  2. 左側のメニューにある ユーザー をクリックします。

  3. 新しいユーザーを作成 をクリックします。

  4. フォームに次の値を入力します。

    • ユーザー名: myuser

    • 名: 任意のFirstName

    • 姓: 任意のLastName

  5. 作成 をクリックします。

Create user
図 2. ユーザーの作成

このユーザーがログインするにはパスワードが必要です。初期パスワードを設定するには

  1. ページ上部の 認証情報 をクリックします。

  2. パスワードを設定 フォームにパスワードを入力します。

  3. 一時的 を オフ に切り替えて、ユーザーが最初のログイン時にこのパスワードを更新する必要がないようにします。

Set password
図 3. パスワードの設定

Account Console にログインする

これで Account Console にログインして、このユーザーが正しく構成されていることを確認できます。

  1. Keycloak Account Console を開きます。

  2. myuser と先ほど作成したパスワードでログインします。

Account Console のユーザーとして、プロフィールの変更、二要素認証の追加、および ID プロバイダーアカウントの追加など、アカウントを管理できます。

Keycloak Account Console

最初のアプリケーションを保護する

最初のアプリケーションを保護するには、まずアプリケーションを Keycloak インスタンスに登録することから始めます。

  1. Keycloak Admin Console を開きます。

  2. 現在のレルム の横にある myrealm をクリックします。

  3. クライアント をクリックします。

  4. クライアントを作成 をクリックします。

  5. フォームに次の値を入力します。

    • クライアントタイプ: OpenID Connect

    • クライアント ID: myclient

      Add client
      図 4. クライアントの追加

  6. 次へ をクリックします。

  7. 標準フロー が有効になっていることを確認します。

  8. 次へ をクリックします。

  9. ログイン設定 でこれらの変更を行います。

    • 有効なリダイレクト URI を https://keycloak.dokyumento.jp/app/* に設定します。

    • Web オリジン を https://keycloak.dokyumento.jp に設定します。

  10. 保存 をクリックします。

Update client
図 5. クライアントの更新]

クライアントが正常に作成されたことを確認するには、Keycloak ウェブサイトの SPA テストアプリケーションを使用できます。

  1. https://keycloak.dokyumento.jp/app/ を開きます。

  2. 保存 をクリックして、デフォルト設定を使用します。

  3. サインイン をクリックして、先ほど起動した Keycloak サーバーを使用してこのアプリケーションに認証します。

次のステップへ

Keycloak を本番環境で実行する前に、次のアクションを検討してください。

  • PostgreSQL などの本番環境対応データベースに切り替えます。

  • 独自の証明書で SSL を構成します。

  • 管理者パスワードをより安全なパスワードに切り替えます。

詳細については、サーバーガイド を参照してください。

このページについて
このガイドを編集