====== feedauth Plugin ======

---- plugin ----
description: Send an “authorization required” header in the feed
author     : Andreas Gohr 
email      : andi@splitbrain.org 
type       : action
lastupdate : 2016-02-03
compatible : Lemming
depends    : 
conflicts  : 
similar    : 
tags       : rss, feed, authentication

downloadurl: https://github.com/splitbrain/dokuwiki-plugin-feedauth/zipball/master
bugtracker : https://github.com/splitbrain/dokuwiki-plugin-feedauth/issues
sourcerepo : https://github.com/splitbrain/dokuwiki-plugin-feedauth/
donationurl: 
----

DokuWiki's [[:syndication|RSS feed]] does honor the [[:ACL]] settings. This means info about read restricted pages are only in the feed when a permitted user logged in. The login can be done by appending username and password to the feed but that's quite insecure.

An alternative is to pass credentials through HTTP basic auth. However some feed readers only do that when asked so, by the webserver. This plugin makes this possible by sending the needed header either on request or always.

Note: basic auth logins only work when PHP is running as Apache module.

===== Download and Installation =====

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.

==== Changes ====

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

===== Usage =====

Once installed, you can add the parameter **feedauth** to any of DokuWiki's [[:syndication|feeds]] to make it request authorization for non logged in users.

Examples:

  http://yourserver.com/dokuwiki/feed.php?feedauth=1
  http://yourserver.com/dokuwiki/feed.php?content=html&feedauth=1

If you set the ''always'' config option it will always request authorization from anonymous users.