Release status: beta
|Implementation||User identity, Special page|
|Description||Provides login with your Google account.|
|Author(s)||Florian Schmidt (Florianschmidtwelzowtalk)|
|See the version lifecycle for an compatibility overview|
|Translate the GoogleLogin extension if it is available at translatewiki.net|
|Issues||Open tasks · Report a bug|
The GoogleLogin extension allows wiki users to login with their Google account. The extension uses the Google API to request basic profile information from Google (such as the account ID, the full name and the email address).
To use this extension you need at least:
- MediaWiki 1.31+
- MySQL (no PostgreSQL or SQLite support for now!)
- PHP 5.6+
- Google Developer Access
- API Credentials for Webapplication (Client ID and Client Secret)
- Able to run
composer update --no-dev
- Download and place the file(s) in a directory called
- Only when installing from git run Composer to install PHP dependencies, by issuing
composer install --no-devin the extension directory. (See task T173141 for potential complications.)
- Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'GoogleLogin' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Configure the required parameters
- Make sure ./wiki/extensions/GoogleLogin/cache is writeable for the Webserver's user
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
The extension provides two configuration variables to set the Client ID and Client Secret (you get this pair in the Google Developer Console, remove "<" and ">").
$wgGLSecret = '<your-client-secret>'; $wgGLAppId = '<your-client-id>';
Additional Configuration parameterEdit
|Configuration variable||Default value||Description|
||An array of mail domains, which are allowed to use with GoogleLogin, e.g. |
||If set to true, GoogleLogin uses the database to check, if an email domain of the primary email-address of a Google account is allowed to login.|
||Only observed, if |
test.example.com isn't allowed if
||Key for public API access. Used only for admin actions to check, if the user has a Google Plus profile or not.|
||Controls the Authoritative mode of GoogleLogin.|
Settings in Google Developer ConsoleEdit
To use this extension you need a Google developer account and access to the developer console. This is a simple (a very simple!) step-by-step guide:
- Open Google developer console
- Read and accept the terms of service
- Create your first project
- Go to APIS & AUTH
- Go to Credentials
- In Section OAuth click Create new Client ID
- Type in your Authorized redirect URI like this example:
- If your domain is example.com and you have installed MediaWiki in Root of your domain, the redirect URI is as follows: http://example.com/index.php/Special:GoogleLoginReturn
- Click create and copy the Client ID and Client Secret to the configuration variables in LocalSettings.php
"Special:GoogleLoginReturn" or (in german for example) "Spezial:GoogleLoginReturn"Edit
The allowed redirect URI in Google developer console must be in the content language. So, if your wiki has german as the content language, then use
Spezial:GoogleLoginReturn. If you used the wrong language, all authentication requests will fail with the error code redirect uri mismatch.
Normally, you can see the error message on all generic error pages. Sometimes there are Internal Errors, called Exceptions. In this case, please add $wgShowExceptionDetails with value true in LocalSettings.php to see the complete Exception message. For a support request, please provide always the lines of the Exception.
Use on a private wikiEdit
If you have set your Wiki to private with
$wgGroupPermissions['*']['read'] = false;
you have to whitelist the "Special:GoogleLoginReturn" page, so that anonymous users can access the callback URL after being redirected from the authentication provider. You can do this by adding the following line to your LocalSettings.php:
$wgWhitelistRead = array( 'Special:GoogleLoginReturn' );
Administer allowed domains on-wikiEdit
GoogleLogin provides a feature to restrict the login with Google to specific Email address domains (such as gmail.com, googlemail.com or every other (own) domain). This feature is especially interesting for companies, who use their own domain names with Google Apps.
The list of domains, which are allowed to login with Google, are managed in an array in the LocalSettings.php (the
$wgGLAllowedDomains configuration option). Since version 0.4.0, GoogleLogin also provides a way to manage the list of allowed domains on the wiki itself. The allowed domains are saved in the database when this feature is enabled and can be change (remove/add) through a graphical user interface (a special page) or through the MediaWiki API.
Note: The list of allowed domains cannot be managed in LocalSettings.php anymore, once the administration of the domains in the database is enabled.
To enable the feature to manage the allowed domains in the database, just set the
$wgGLAllowedDomainsDB configuration variable to
true in your LocalSettings.php. You also want to assign the new
managegooglelogindomains user right to one group you're a member of (please keep in mind, that all users with this user right are allowed to change the list of allowed domains, so consider to add this right to an administrator-level group only!). An example configuration could look like:
$wgGLSecret = 'your-secret'; $wgGLAppId = 'your-app-id'; $wgGLAllowedDomainsDB = true; $wgGroupPermissions['sysop']['managegooglelogindomains'] = true;
You now need to run the
update.php script again, so that the necessary database changes are applied to your database. After the update process is completed, you can navigate to the special page
Special:GoogleLoginAllowedDomains on your wiki. You'll get a page where you can add new domains, which are allowed to login with their Google account and you can remove them, once they was added.
This configuration option still exists, but it's now used for more than just the Special:ManageGoogleLogin special page. It's now used to get the name of a user on Special:RemoveCredentials to make it easier to the user to identify the correct Google account (instead of just showing the Google ID). If the key isn't correct or isn't supplied, GoogleLogin will show the Google ID only. For a good user experience, it's highly suggested to supply this api key now.
Google Login supports a so called authoritative mode, in which, when enabled, a user account is automatically created when the Google account, which was used to login, is not associated with a local MediaWiki account already. This option is disabled by default and needs to be enabled with a configuration option. However, please read the following important information before doing so. This feature requires that the wiki's configuration strictly supports the following:
- GoogleLogin needs to be the only primary authentication provider
- The @ sign needs to be whitelisted in the
- Autocreation of accounts needs to be enabled:
$wgGroupPermissions['*']['autocreateaccount'] = true;
- The GoogleLogin authoritative mode needs to be enabled
Enabling this feature also has the following influence:
- The username of the account is the primary email field of the returned information from Google. This is not configurable.
- If a local wiki account is already connected, this account is used to login, which means that an already existing account takes precedence over creating a new one.
- The new created account will automatically being linked with the Google account.
- GoogleLogin will not let a user add or remove any further Google account connections (or the automatically created link) to prevent a user from being not able to login anymore.
- GoogleLogin does not add a password during the account creation, if the authoritative mode is disabled and password login shall be enabled again, the user needs to reset their password.
Google API PHP ClientEdit
updatePublicSuffixArray.php maintenance script downloads a list of domain names which are valid to be used in the world.
This is required in order for GoogleLogin to allow subdomains of a specific email domain when you've restricted the login with GoogleLogin for specific domains.
This is only needed if
$wgGLAllowedDomainsStrict is set to false (which is the default).
Please note that I support only the latest version of GoogleLogin. Any versions apart from the current release (which means the current MediaWiki release branch) and the current development version (aka master) are not supported anymore.