summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndrew Dolgov <[email protected]>2023-09-22 19:20:45 +0300
committerAndrew Dolgov <[email protected]>2023-09-22 19:20:45 +0300
commitd8fe6bdaac881524a54f3c7b9b188b667bdf34de (patch)
tree2a9bf35bbac022d0b792610e90b040466d7e17ea
parentb7ee4260395989e0928b557f176fb0bec35a74c9 (diff)
update readme
-rw-r--r--README.md19
1 files changed, 14 insertions, 5 deletions
diff --git a/README.md b/README.md
index 8552cd5..f8e145c 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,12 @@
This is a system plugin, it has to be enabled globally through `TTRSS_PLUGINS`.
-Sample Authelia configuration:
+If everything is configured correctly, another login button will appear on the login form, which
+you can use to log in through OpenID.
+
+## Examples
+
+### Authelia
```yml
identity_providers:
@@ -17,10 +22,9 @@ identity_providers:
redirect_uris:
- "https://example.com/tt-rss"
userinfo_signing_algorithm: none
- #pre_configured_consent_duration: 30d
```
-Plugin configuration (`.env`):
+Plugin settings (`.env`):
```properties
TTRSS_AUTH_OIDC_NAME=Authelia
@@ -29,5 +33,10 @@ TTRSS_AUTH_OIDC_CLIENT_ID=test-ttrss
TTRSS_AUTH_OIDC_CLIENT_SECRET=your-secret-token
```
-If everything is configured correctly, another login button will appear on the login form, which
-you can use to log in through OpenID.
+### Keycloak
+
+When using Keycloak, set `TTRSS_AUTH_OIDC_URL` to base realm URL:
+
+```properties
+TTRSS_AUTH_OIDC_URL=https://keycloak.example.com/realms/YourRealm
+```