README.md
1authyubikey
2===========
3This plugin is written for Dokuwiki to enable a two factor authentification.
4
5
6Prerequisites
7=============
8You have to ensure, that your PHP installation supports PEAR and curl (i.e. php-pear and php5-curl on Debian systems).
9
10
11Install
12=======
13This plugin can be installed manually in the plugin directory of Dokuwiki
14(i.e. /usr/share/dokuwiki/lib/plugins).
15
16After that, you have to login into your Dokuwiki as an administrator. At first
17you have to configure the new authentification method in the configuration form
18of Dokuwiki by choosing "authyubikey" as Dokuwiki's "authtype".
19
20Moreover it is important, that the users can manage their own profiles. So do not
21disable "User profile" with the parameter "disableactions".
22
23In the next step you have to set client ID and the secret key for your Yubikey.
24If you do not know, what this mean, please vist https://upgrade.yubico.com/getapikey
25and follow their instructions.
26
27After that you have to decide, how many different Yubikey-OTP's a user can manage.
28
29Now users can add their personal Yubikeys in personal profile form (see also
30https://your.domain.org/dokuwiki/doku.php?id=start&do=profile).
31