Skip to content

Commit 3050b42

Browse files
committed
Readme: Added explanation of sign on options
1 parent baf8149 commit 3050b42

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ This README file contains the following main sections:
1111
+ [IMPORTANT SECURITY NOTES](#important-security-notes)
1212
+ [Installation](#installation)
1313
+ [Supported Authorization Providers](#supported-authorization-providers)
14+
+ [Sign On Options](#sign-on-options)
15+
+ [Handling of User Name and Email](#handling-of-user-name-and-email)
1416
+ [Configuration of Authorization Providers](#configuration-of-authorization-providers)
1517
+ [General Configuration](#general-configuration)
1618
+ [Generic](#generic)
@@ -57,6 +59,16 @@ Please check whether your **webtrees BASE_URL** in the config.ini.php file **sta
5759
+ Go to "Control Panel/All Modules", and find the module called "ExtendedImportExport"
5860
+ Check if it has a tick for "Enabled"
5961

62+
## Sign On Options
63+
64+
The OAuth 2.0 Client offers two different options to sign on with an authorization provider:
65+
+ **Register a new webtrees user based on the identity provided by an authorization provider**: Sign out and choose to sign in with an authorization provider. A new webtrees user will be registered. The registration will fail if the email oder the user name, which is transmitted by the authorization provider, already exists within webtrees. After the registration, a webtrees administrator needs to approve the new user and the email before signing in with the authorization provider is possible. The general idea of this option is that the user identify from the authorization provider is used within webtrees. In the control panel, a setting is offered to synchronize the email address from the authorization provider to the webtrees user.
66+
+ **Connect an existing webtrees user with an authorization provider**: Sign on with an exisiting user and choose to "connect" the existing user with an authorization provider. In this case, the existing user credentials in webtrees will continue to exist and the user will be (additionally) allowed to sign in with the chosen provider. The general idea of this is that the two user accounts exist in parallel and are connected.
67+
68+
## Handling of User Name and Email
69+
70+
If a new webtrees user is created (i.e. registered), the user name and the email needs to be unique. This is a general webtrees requirement. If the user name or email address provided by the authorization provider is identical to an already existing user, an error message will be shown.
71+
6072
## Supported Authorization Providers
6173
The OAuth 2.0 Client for webtrees uses the OAuth 2.0 implementation of the [The League](https://oauth2-client.thephpleague.com/), which allows developers to create OAuth 2.0 clients that interface with a wide-variety of OAuth 2.0 providers. Within this concept, The League supports serveral "[official providers](https://oauth2-client.thephpleague.com/providers/league/)". As far as suitable for webtrees, these official providers were included, see list below.
6274

0 commit comments

Comments
 (0)