Added configuration example in keycloak auth client

2amigos · Feb 9, 2024 · 888bc4c · 888bc4c
1 parent 6056be8
commit 888bc4c
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/src/User/AuthClient/Keycloak.php b/src/User/AuthClient/Keycloak.php
@@ -5,6 +5,26 @@
 use Da\User\Contracts\AuthClientInterface;
 use yii\authclient\OpenIdConnect;
 
+/**
+ * Example application configuration:
+ *
+ * ```php
+ * 'components' => [
+ *     'authClientCollection' => [
+ *         'class' => 'yii\authclient\Collection',
+ *         'clients' => [
+ *             'github' => [
+ *                 'class' => 'yii\authclient\clients\Keycloak',
+ *                 'clientId' => 'keycloak_client_id',
+ *                 'clientSecret' => 'keycloak_client_secret',
+ *                 'issuerUrl' => 'http://keycloak/realms/your-realm',
+ *             ],
+ *         ],
+ *     ]
+ *     // ...
+ * ]
+ * ```
+*/
 class Keycloak extends OpenIdConnect implements AuthClientInterface
 {
     /**