summaryrefslogtreecommitdiff
path: root/README.md
blob: 269df4d17658e57e4e1eee817919e192807ef13a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
## ABOUT

This is a collection of bridges allowing an ejabberd XMPP server to use a locally installed PHP-based CMS for external authentication.

## FEATURES

Currently implemented bridges:

* phpBB 3.0
* phpBB 3.1 (unstable)
* Drupal 7.x
* Drupal 8.x (unstable)

Potential candidates for further bridges are WordPress, MediaWiki, Joomla! and Moodle.

## EXTENDING

In order to create a new plugin named {xyz}, you will need the following:

* A class extending EjabberdAuthBridge and implementing its methods.
* A file named {xyz}.module that contains the function {xyz}_init().

{xyz}_init() will receive its appropriate conf array in config.php and must
return an instance of the extended class.

The class methods must return boolean values indicating success or failure.
It is generally recommended NOT to allow account creation, account deletion or
password changes, and instead to simply return FALSE in these methods.

## LICENSE

The core project, without plugins, is available under the terms of the GNU General Public License, version 2 or later.

Plugins are individually licensed:

* phpBB, all versions: GNU General Public License, v2
* Drupal, all versions: GNU General Public License, v2 and later.

GPL v2: http://www.gnu.org/licenses/gpl-2.0.txt
GPL v3: http://www.gnu.org/licenses/gpl-3.0.txt