• Home
  • History
  • Annotate
Name Date Size #Lines LOC

..17-May-2022-

conf/H03-May-2018-24018

plugin/authshibboleth/H03-May-2018-1,177612

CHANGELOG.mdH A D17-Jan-2017308 167

README.mdH A D17-Jan-20172.8 KiB5733

README.md

1# DokuWiki Shibboleth Authentication Plugin
2
3* Homepage: [DokuWiki Shibboleth Authentication Plugin](https://github.com/ivan-novakov/dokuwiki-shibboleth-auth)
4* License: [BSD 3 Clause](http://debug.cz/license/bsd-3-clause)
5* Author: [Ivan Novakov](http://novakov.cz/)
6
7## Introduction
8
9[DokuWiki](https://www.dokuwiki.org/) is a flexible and simple wiki system written in PHP. [Shibboleth](http://shibboleth.net/) is widely used open-source implementation of SAML. DokuWiki supports different authentication plugins and it is easy to write an alternative authentication plugin to integrate your own authentication mechanism within DokuWiki.
10
11This plugin uses a Shibboleth session to authenticate users. It just takes all required information from the environment variables injected by Shibboleth (user's attributes sent by the identity provider).
12
13The plugin requires DokuWiki version __2013-05-10 Weatherwax__ or newer. The older versions have different authentication structure - _authentication backends_. In case you have an older version and you don't want to upgrade, you may use the [Shibboleth authentication backend](https://github.com/ivan-novakov/dokushib).
14
15## Requirements
16
17* PHP >= 5.x
18* Shibboleth SP 2.x instance
19* DokuWiki __2013-05-10 Weatherwax__ or newer
20
21## Features
22
23* highly configurable
24* includes an action plugin to handle login actions
25* different group sources
26* logging and debugging
27
28## Shibboleth configuration
29
30You need Shibboleth SP 2.x installed and running. In Apache you have to configure Shibboleth to "know" about your DokuWiki directory:
31
32    <Directory "/var/www/sites/dokuwiki/">
33      AuthType shibboleth
34      require shibboleth
35    </Directory>
36
37## Plugin installation and configuration
38
39Clone the [repository](https://github.com/ivan-novakov/dokuwiki-shibboleth-auth) anywhere on your system. Copy the `plugin/authshibboleth` directory to `DOKUWIKI_HOME/lib/plugins`.
40
41In `DOKUWIKI_HOME/conf/local.conf` set the `authtype` directive:
42
43    $conf['authtype'] = 'authshibboleth';
44
45Alternatively, you can use the configuration manager.
46
47Now, in most cases, the Shibboleth authentication should work out-of-the-box. But if that is not the case or you need to tune something, there is a bunch of configuration options you can set.
48
49The best way to do this is to copy the `conf/authshibboleth.conf.php` file from the repository to `DOKUWIKI_HOME/conf` and include it in your `DOKUWIKI_HOME/conf/local.protected.php` file (it doesn't exist by default, you have to create it yourself):
50
51    include __DIR__ . '/authshibboleth.conf.php';
52
53It's better to use `local.protected.php` instead of `local.php`, because `local.php` may be overwritten if you use the configuration manager.
54
55The `authshibboleth.conf.php` file contains all available directives, set to their default values and commented out. If you need to change a directive, just uncomment it and change its value.
56
57