Docker での Nginx リバース プロキシを使用した Keycloak v26 の構成: さまざまなレルムでのコンソールの問題の解決

Docker で Keycloak のリバース プロキシとして Nginx を設定する

Keycloakプロキシ用のNginx構成を使用したバックエンドソリューション

upstream sso-mydomain-com {
    server 10.10.0.89:8080;
}
server {
    listen 443 ssl;
    server_name sso.mydomain.com;
    location / {
        proxy_pass http://sso-mydomain-com/;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-Port $server_port;
    }
    ssl_certificate /etc/nginx/ssl/sso.mydomain.com/fullchain.pem;
    ssl_certificate_key /etc/nginx/ssl/sso.mydomain.com/privkey.pem;
}
server {
    listen 8443 ssl;
    server_name sso.mydomain.com;
    error_log /usr/local/nginx/logs/sso_err.log debug;
    location / {
        proxy_pass http://sso-mydomain-com/;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Forwarded-Host $host;
        proxy_set_header X-Forwarded-Port $server_port;
    }
    ssl_certificate /etc/nginx/ssl/sso.mydomain.com/fullchain.pem;
    ssl_certificate_key /etc/nginx/ssl/sso.mydomain.com/privkey.pem;
}

環境変数を使用した Keycloak Docker Compose 構成

環境変数を使用した Keycloak セットアップ用の Docker Compose ファイル

version: '3.9'
services:
  keycloak:
    container_name: keycloak
    image: quay.io/keycloak/keycloak:26.0
    env_file:
      - .env
    ports:
      - "8080:8080"
    volumes:
      - /opt/keycloak/themes:/opt/keycloak/themes
      - /etc/localtime:/etc/localtime
    privileged: true
    command: start

Keycloak APIエンドポイント検証の単体テスト

Keycloak /whoami エンドポイントの応答を検証するための Python ベースの単体テスト

import requests
def test_whoami_endpoint():
    url = "https://sso.mydomain.com:8443/auth/admin/master/console/whoami?currentRealm=master"
    headers = {"Content-Type": "application/json"}
    try:
        response = requests.get(url, headers=headers, verify=True)
        assert response.status_code == 200, "Expected 200 OK, got {}".format(response.status_code)
        print("Test passed: whoami endpoint accessible")
    except requests.ConnectionError:
        print("Connection error: Check Nginx reverse proxy and Keycloak availability")
    except AssertionError as e:
        print("Assertion error:", e)
# Run the test
test_whoami_endpoint()

代替アプローチ: Nginx フェイルオーバーを使用した Keycloak ヘルスチェック

Keycloakでヘルスチェックを実行し、必要に応じてNginxを再起動するBashスクリプト

#!/bin/bash
# Check if Keycloak is reachable via the /whoami endpoint
URL="http://10.10.0.89:8080/auth/admin/master/console/whoami"
STATUS_CODE=$(curl -s -o /dev/null -w "%{http_code}" $URL)
if [ "$STATUS_CODE" -ne 200 ]; then
    echo "Keycloak endpoint unavailable, restarting Nginx..."
    docker restart nginx
else
    echo "Keycloak endpoint is healthy."
fi

Nginx と Docker を使用した Keycloak に関するよくある質問

1. Nginx で Keycloak を使用するときに 502 Bad Gateway エラーを解決するにはどうすればよいですか?
2. 502 エラーのトラブルシューティングを行うには、Nginx 構成をチェックして、 proxy_pass URLはKeycloakのコンテナアドレスとポートと一致します。また、Keycloak が実行中であり、内部ネットワーク経由でアクセスできることを確認します。
3. KeycloakのNginxでSSL終端を使用できますか?
4. はい、Nginx での SSL 終了は一般的です。設定する ssl_certificate そして ssl_certificate_key Nginx 上で受信リクエストの HTTPS を処理します。これにより、Keycloak は HTTP 経由で通信できるようになります。
5. 複数の Keycloak インスタンスの負荷を分散するにはどうすればよいですか?
6. を定義します upstream 各Keycloakインスタンスを使用してNginxでブロックします。セット proxy_pass 上流のサーバーにリクエストを送信すると、Nginx はすべてのインスタンスにリクエストを分散します。
7. Docker で Keycloak の環境変数を保護するためのベスト プラクティスは何ですか?
8. 使用 env_file Docker Compose で機密データを保存し、ハードコーディングされた値を回避します。また、環境ファイルに適切な権限を設定してアクセスを制限します。
9. Nginx で SSL 証明書の更新を自動化するにはどうすればよいですか?
10. Let’s Encrypt のようなツールは証明書の更新を自動化します。更新後、スクリプトを使用して Nginx をリロードすると、コンテナーを再起動せずに新しい証明書が有効になります。
11. KeycloakはNginxを通じてその状態を監視できますか?
12. はい、簡単なスクリプトを使用すると、 curl Keycloakのエンドポイントステータスを確認できます。障害が発生した場合は、Nginx またはコンテナを再起動して、可用性と応答性を維持します。
13. Nginx ログを使用して Keycloak ログインの問題をトラブルシューティングすることはできますか?
14. セット error_log Nginxで debug 詳細なログを取得するために一時的にレベルを上げ、認証とアクセスの問題の診断に役立ちます。
15. 複数のKeycloakインスタンス間でセッションの永続性を確保するにはどうすればよいですか?
16. Nginx でスティッキー セッションを構成すると、ユーザーが同じ Keycloak インスタンスに接続したままになり、セッションの変更によるログインの問題が軽減されます。
17. カスタムドメイン経由でKeycloakの管理コンソールにアクセスできますか?
18. はい、設定します KC_HOSTNAME Keycloakの環境変数をカスタムドメインに追加します。ドメインが Nginx で正しくルーティングされていることを確認します。
19. KeycloakがNginxで正しく構成されているかどうかを確認するにはどうすればよいですか?
20. 設定後、使用します curl エンドポイントが正しく応答するかどうかを確認するか、管理コンソールにアクセスしてエラーを確認します。また、接続の問題がないかログを監視します。

まとめ: Keycloak と Nginx の構成に関する重要なポイント

Nginx リバース プロキシの背後に Keycloak を構成すると、アクセスの保護と管理に非常に効果的です。ただし、「502 Bad Gateway」などのエラーやレルム関連のコンソールの問題は、設定ミスが原因で発生することがよくあります。ログを注意深く分析し、SSL とプロキシ設定を確認し、ネットワーク パスを検証することで、セットアップのトラブルシューティングと最適化を行うことができます。

このプロセスを通じて、コンテナ化、プロキシ設定、環境変数がどのように連携して Keycloak の管理コンソールを安定化させるかを示しました。ロード バランシング、SSL オフロード、シームレスな認証のいずれであっても、適切に構成されたセットアップにより、さまざまな運用環境に適した回復力のある認証ソリューションが提供されます。 🔧