====== AuthDiscourse Plugin ======

---- plugin ----
description: Authenticates users with a Discourse SSO provider
author     : Lukas Werling 
email      : lukas@lwrl.de 
type       : Auth
lastupdate : 2019-05-23
compatible : Greebo
depends    : 
conflicts  : 
similar    : 
tags       : sso

downloadurl: https://github.com/lluchs/dokuwiki-plugin-authdiscourse/zipball/master
bugtracker : https://github.com/lluchs/dokuwiki-plugin-authdiscourse/issues
sourcerepo : https://github.com/lluchs/dokuwiki-plugin-authdiscourse

----

Authenticates users with a Discourse SSO provider. This might also be useful if you don't run Discourse at all, because the protocol is very simple and thus easy to implement.

The plugins passes Discourse groups to DokuWiki. The admin flag is mapped to the "admin" group, and likewise the moderator flag to a "moderator" group.

===== Installation =====

:!: **External requirements:** This plugin requires the following additional components that must be installed separately: 
  * A Discourse-compatible SSO provider ([[https://meta.discourse.org/t/official-single-sign-on-for-discourse-sso/13045|see documentation]]). Discourse itself can also act as an SSO provider.

Install the plugin using the [[plugin:plugin|Plugin Manager]] and the download URL above, which points to latest version of the plugin. Refer to [[:Plugins]] on how to install plugins manually.

Two configuration keys are required. For example, if you have a Discourse instance at https://discourse.example.com and a DokuWiki instance at dokuwiki.example.com, follow these steps:

  * Enable the SSO provider in the Discourse settings (settings key "enable sso provider")
  * Generate a shared secret (e.g., ''head -c18 /dev/urandom | base64'') and add your site to the "sso provider secrets" (fill in dokuwiki.example.com / <your shared secret>)
  * Add the following to your DokuWiki configuration, or fill in with the configuration editor:

<code>
$conf['authtype'] = 'authdiscourse';
$conf['plugin']['authdiscourse']['sso_url'] = 'https://discourse.example.com/session/sso_provider';
$conf['plugin']['authdiscourse']['sso_secret'] = '<your shared secret>';
</code>


===== Development =====

=== Change Log ===

{{rss>https://github.com/lluchs/dokuwiki-plugin-authdiscourse/commits/master.atom date}}

=== Report Bugs and Issues ===

Please report bugs [[https://github.com/lluchs/dokuwiki-plugin-authdiscourse/issues|on GitHub]].


===== Discussion =====

This is an excellent plugin, thank you!  The only flaw for me is that the login period times out too quickly, seemingly in about an hour.  Is there a way to adjust this?