Extension:CryoKey

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
CryoKey

Release status:Extension status stable

ImplementationTemplate:Extension#type User identity
DescriptionTemplate:Extension#description Allows Basic integration of CryoKey credentials into MediaWiki for single sign-on
Author(s)Template:Extension#username Authenticade LLC (CryoKeytalk)
Latest versionTemplate:Extension#version 2.3 (2013-12-06)
MediaWikiTemplate:Extension#mediawiki 1.13+
PHPTemplate:Extension#php 5.3+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license MIT License
Download
README
ExampleTemplate:Extension#example Authenticade wiki
ParametersTemplate:Extension#parameters

$wgCKAutoRegister

Hooks usedTemplate:Extension#hook
UserLoadFromSessionManual:Hooks/UserLoadFromSession
UserLoginFormManual:Hooks/UserLoginForm
BeforePageDisplayManual:Hooks/BeforePageDisplay
GetLocalURL::InternalManual:Hooks/GetLocalURL::Internal

Translate the CryoKey extension if it is available at translatewiki.net

Check usage and version matrix.

The CryoKey extension will add support for CryoKey credentials as an alternative to traditional usernames and passwords.

Download[edit]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/CryoKey/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/CryoKey.git

Installation[edit]

  • Download and place the file(s) in a directory called cryokey in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/cryokey/cryokey.php";
    
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configruation[edit]

The extension authenticates users based on their E-Mail address. CryoKey authentication is optional, and shows up as a separate link in the UserLogin page. If the user provides CryoKey credentials, then the extension will grant access to the first user with a matching E-Mail address. If you set $wgCKAutoRegister to true in LocalSettings.php, then the extension will automatically try to register a new user using the E-Mail address found in the CryoKey credentials bound to a random username and password. (By default, $wgCKAutoRegister is false. If you change the setting, make sure you set the value after the line that loads the extension.)

To get an idea of how CryoKey works in MediaWiki, first visit the acquisition site (or use a CryoKey app) to get credentials, then try to log in to the test wiki at

http://www.authenticade.com/wiki

See also[edit]