Skip to content

Commit 9d2326f

Browse files
committed
Readme: Added Keycloak and changed order of chapters within configuration
1 parent c784eb8 commit 9d2326f

File tree

1 file changed

+27
-26
lines changed

1 file changed

+27
-26
lines changed

README.md

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ This README file contains the following main sections:
2020
+ [Dropbox](#dropbox)
2121
+ [Github](#github)
2222
+ [Google](#google)
23-
+ [Keycloak](#keycloak)
2423
+ [Joomla](#joomla)
24+
+ [Keycloak](#keycloak)
2525
+ [Nextcloud](#nextcloud)
2626
+ [Spotify](#spotify)
2727
+ [WordPress](#wordpress)
@@ -79,6 +79,7 @@ Currently, the following authorization providers are supported:
7979
+ **Github**
8080
+ **Google**
8181
+ **Joomla** (with a specific authorization provider extension installed in Joomla)
82+
+ **Keycloak**
8283
+ **Nextcloud**
8384
+ **Spotify**
8485
+ **WordPress** (with a specific authorization provider plugin installed in WordPress)
@@ -231,6 +232,31 @@ Google_clientSecret='xxx'
231232
+ **Google_clientSecret**='...' (value shown in Google, like described above)
232233
+ Press the "OK" button in the Google browser page
233234

235+
### Joomla
236+
+ Download the Joomla extension [joomla-oauth2-server](https://github.com/Jefferson49/joomla-oauth2-server/releases/latest)
237+
+ Install the extension in the Joomla administration backend
238+
+ Open the backend menu: Components / OAuth2 Server / Configure OAuth
239+
+ Click on the button "Add client"
240+
+ Enter a name for "Client Name", e.g. "webtrees"
241+
+ Enter the "Authorized Redirect URL" for the webtrees OAuth 2.0 client. See chapter [General Configuration](#general-configuration) about how to get the redirect URL from the webtrees custom module settings
242+
+ Find the following configuration parameters in the list of OAuth clients, which are needed for the webtrees configuration in config.ini.php below:
243+
+ Client ID
244+
+ Client Secret
245+
+ Click on "Endpoint URLs" to find the following configuration parameter, which is needed for the webtrees configuration in config.ini.php below:
246+
+ Authorize Endpoint
247+
+ Open your webtrees config.ini.php file and add the following lines (copy/paste to the end):
248+
```PHP
249+
Joomla_clientId='xxx'
250+
Joomla_clientSecret='xxx'
251+
Joomla_urlAuthorize='xxx'
252+
Joomla_signInButtonLabel='xxx'
253+
```
254+
+ Insert the configuration details from the Joomla OAuth 2.0 Server into the newly included configuration lines of your config.ini.php file:
255+
+ **Joomla_clientId**='...' (value for "Client ID" shown in Joomla)
256+
+ **Joomla_clientSecret**='...' (value for "Client Secret" shown in Joomla)
257+
+ **Joomla_urlAuthorize**='JOOMLA_BASE_URL/index.php' (JOOMLA_BASE_URL from your Joomla installation, e.g. 'https://mysite.net/joomla')
258+
+ **Joomla_signInButtonLabel**='...' (the label, which shall be shown for the sign in button etc.)
259+
234260
### Keycloak
235261
+ Log into your Keycloak administration backend and select or create a realm
236262
+ Create a new client with "Client" / "Create client"
@@ -257,31 +283,6 @@ Keycloak_signInButtonLabel='xxx'
257283
+ **Keycloak_realm**='xxx' (value for "Realm name" shown in Keycloak)
258284
+ **Keycloak_signInButtonLabel**='...' (the label, which shall be shown for the sign in button etc.)
259285

260-
### Joomla
261-
+ Download the Joomla extension [joomla-oauth2-server](https://github.com/Jefferson49/joomla-oauth2-server/releases/latest)
262-
+ Install the extension in the Joomla administration backend
263-
+ Open the backend menu: Components / OAuth2 Server / Configure OAuth
264-
+ Click on the button "Add client"
265-
+ Enter a name for "Client Name", e.g. "webtrees"
266-
+ Enter the "Authorized Redirect URL" for the webtrees OAuth 2.0 client. See chapter [General Configuration](#general-configuration) about how to get the redirect URL from the webtrees custom module settings
267-
+ Find the following configuration parameters in the list of OAuth clients, which are needed for the webtrees configuration in config.ini.php below:
268-
+ Client ID
269-
+ Client Secret
270-
+ Click on "Endpoint URLs" to find the following configuration parameter, which is needed for the webtrees configuration in config.ini.php below:
271-
+ Authorize Endpoint
272-
+ Open your webtrees config.ini.php file and add the following lines (copy/paste to the end):
273-
```PHP
274-
Joomla_clientId='xxx'
275-
Joomla_clientSecret='xxx'
276-
Joomla_urlAuthorize='xxx'
277-
Joomla_signInButtonLabel='xxx'
278-
```
279-
+ Insert the configuration details from the Joomla OAuth 2.0 Server into the newly included configuration lines of your config.ini.php file:
280-
+ **Joomla_clientId**='...' (value for "Client ID" shown in Joomla)
281-
+ **Joomla_clientSecret**='...' (value for "Client Secret" shown in Joomla)
282-
+ **Joomla_urlAuthorize**='JOOMLA_BASE_URL/index.php' (JOOMLA_BASE_URL from your Joomla installation, e.g. 'https://mysite.net/joomla')
283-
+ **Joomla_signInButtonLabel**='...' (the label, which shall be shown for the sign in button etc.)
284-
285286
### Nextcloud
286287
+ Open the chapter about OAuth2 configuration in the [Nextcloud Administration Manual](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/oauth2.html#add-an-oauth2-application)
287288
+ Configure a new OAuth2 client app in Nextcloud like described in chapter "Add an OAuth2 Application"

0 commit comments

Comments
 (0)