aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 34b6bfcfab6c2a10be22abbd0d13267a51532d40 (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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# AuthMinetest

Extension for MediaWiki allowing to authenticate users against a Minetest server

## Requirements:

* MediaWiki 1.27+
* Minetest with auth_export mod enabled
* minetestauth.py duct-tape http server

## Installation and setup

Clone / unzip into your MediaWiki's extension/AuthMinetest/ folder.

Configure your MediaWiki authentication manager to use this extension as the
primary authentication provider:

	wfLoadExtension( 'AuthMinetest' );

	$wgAuthManagerAutoConfig['primaryauth'] = [
		MediaWiki\Auth\MinetestPasswordPrimaryAuthenticationProvider::class => [
			'class' => MediaWiki\Auth\MinetestPasswordPrimaryAuthenticationProvider::class,
			'args' => [
				[
					'minetestUrl' => 'http://your.minetest.url',
				]
			],
			'sort' => 0,
		],
		];

Enable the auth\_export mod on your minetest server, and install the
minetestauth.py script. You then need to point both the auth\_export
mod and this plugin to the minetestauth.py script like this:

	auth_export ←→ minetestauth.py ←→ AuthMinetest

Keep in mind that stuff is sent in plain text, so you should have all
of these listening on localhost or use encrypted tunnels between the
hosts, such as ssh or vpn tunnels.

## Copying

This extension is based on
[AuthMoodle](https://github.com/moodlehq/mediawiki-authmoodle) by
David Mudrák.

Copyright 2017 David Mudrák <david@moodle.org>
Copyright 2019 Gabriel Pérez-Cerezo <gabriel@gpcf.eu>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.