summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorGabriel Pérez-Cerezo <gabriel@gpcf.eu>2020-10-10 23:35:44 +0200
committerGabriel Pérez-Cerezo <gabriel@gpcf.eu>2020-10-10 23:35:44 +0200
commitad25fb61f76b88e27caa9d9bd9759c990c400a7f (patch)
tree7e6b81afb83b53dd5eb2cfa5f27f1e60c7a15b47 /README.md
downloadforks-modpack-ad25fb61f76b88e27caa9d9bd9759c990c400a7f.tar.gz
forks-modpack-ad25fb61f76b88e27caa9d9bd9759c990c400a7f.tar.bz2
forks-modpack-ad25fb61f76b88e27caa9d9bd9759c990c400a7f.zip
Squashed 'auth_export/' content from commit 77f7a30
git-subtree-dir: auth_export git-subtree-split: 77f7a301678e6e4b121d0f4729594f5cb34d8c39
Diffstat (limited to 'README.md')
-rw-r--r--README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..363174a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# Auth_export mod for minetest
+
+This is an ad-hoc mod written to interface Minetest with Mediawiki
+(see [the mediawiki plugin](/AuthMinetest.git/)). It is intended only
+for usage with the http server bundled with the mediawiki plugin.
+
+## Installation
+
+To set up your minetest installation to communicate with the minetest server, edit your "minetest.conf":
+
+```
+# enable curl/http on that mod
+secure.http_mods = mail
+secure.http_mods = auth_export
+```
+
+## BUGS
+
+Bugs are tracked on
+[Hemiptera](https://bugs.linux-forks.de/MinetestMediawiki/). Send bugs
+as an e-mail to <MinetestMediawiki@bugs.linux-forks.de>
+
+## TODO
+
+* Improve architecture – This mod's architecture is rather ugly right now
+* Integrate with various ban mechanisms
+* Add service-specific access rights, such as a "wiki" priv for wiki
+ access, or "nowiki" xban flag to ban access to wiki
+
+
+## Credits
+
+This mod is essentially scavenged from
+[the webmail mod](https://github.com/thomasrudin-mt/mail) by Thomas
+Rudin.