From 045012f9b7619d441d8c5b5800519cb7ac6891b6 Mon Sep 17 00:00:00 2001
From: Christoph Burschka
Date: Fri, 17 Jan 2014 16:10:10 +0100
Subject: Okay, the last patch was actually rubbish.

It turns out that you can't hope to bootstrap more
than one PHP-based software without messing stuff
up, particularly because they rely on global variables
without exception. If it is risky and unpredictable for
different systems, it is completely impossible with multiple
instances of the same.

Therefore, the ability to use multiple plugins (and the
accompanying config.php structure) has been removed. The
only plugin that can be used in conjunction with another
is session.
---
 README.md | 18 +++++++++++++++++-
 1 file changed, 17 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 5637636..2a0a77f 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,8 @@
 ejabberd-auth-php
 =================
 
-This is a collection of bridges allowing an ejabberd XMPP server to use a locally installed PHP-based CMS for external authentication.
+This is a collection of bridges allowing an ejabberd XMPP server to use a locally
+installed PHP-based CMS for external authentication.
 
 Features
 --------
@@ -16,6 +17,21 @@ Currently implemented bridges:
 
 Potential candidates for further bridges are WordPress, MediaWiki, Joomla! and Moodle.
 
+Installation
+------------
+
+Copy the file `config.sample.php` to `config.php` and fill in the appropriate
+values.
+
+If you want to add session authentication, also read [plugins/session/README.md](
+plugins/session/README.md). Otherwise, remove the relevant section of `config.php`.
+
+Open your ejabberd configuration (`/etc/ejabberd/ejabberd.cfg`) and set the
+external authentication script:
+
+    {auth_method, external}.
+    {extauth_program, ".../ejabberd-auth-php/main.php"}.
+
 Extending
 ---------
 
-- 
cgit v1.1