Skip to content

Commit d28e086

Browse files
committed
Update README.md
Add the possibility to use the email address for login.
1 parent 84ad0f4 commit d28e086

1 file changed

Lines changed: 3 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,9 @@ A MediaWiki extension to authenticate users from an external MySQL/MariaDB datab
44

55
## Use Case / Purpose
66

7-
This extension can be useful whenever you are running multiple web applications besides your MediaWiki and you are
8-
keeping all user/login data in one central MySQL or MariaDB database. To avoid having to synchronize the accounts with
9-
the MediaWiki database this extension simply connects to this external database, searches for the username that was
10-
entered in the wiki's login form and - if it was found - checks, if the supplied password matches the one that is stored
11-
alongside the username in the external database. If user and password match, a local user is created and authentication
12-
is successful. If the local user already exists (due to a previous login) it is simply updated. Since no password is
13-
stored in your wiki's database, authentication always relies on the external database.
7+
This extension can be useful whenever you are running multiple web applications besides your MediaWiki and you are keeping all user/login data in one central MySQL or MariaDB database. To avoid having to synchronize the accounts with the MediaWiki database this extension simply connects to this external database, searches for the username or email address that was entered in the wiki's login form and - if one of the two was found - checks, if the supplied password matches the one that is stored alongside the username or email address in the external database. If user and password match, a local user (the same as the username in the external database, not the email address) is created and authentication is successful. If the local user already exists (due to a previous login) it is simply updated. Since no password is stored in your wiki's database, authentication always relies on the external database.
148

15-
This extension was inspired by [ExtAuthDB](https://www.mediawiki.org/wiki/Extension:ExtAuthDB) and tries to offer the
16-
same functionality as a state of the art MediaWiki extension.
9+
This extension was inspired by [ExtAuthDB](https://www.mediawiki.org/wiki/Extension:ExtAuthDB) and tries to offer the same functionality as a state of the art MediaWiki extension.
1710

1811
## Requirements
1912

@@ -48,7 +41,7 @@ $wgExternalDatabaseAuthFields = [
4841
'userRealName' => 'fieldwithrealname'
4942
];
5043
$wgExternalDatabaseAuthHash = 'bcrypt';
51-
```
44+
```
5245

5346
- Navigate to `Special:Version` on your wiki to verify that the extension is successfully installed.
5447

0 commit comments

Comments
 (0)