Go to file
Pierre-Adrien Langrognet 9326b2dfda
Merge pull request #1 from Panquesito7/master
Use mod.conf for description
2019-10-27 22:38:39 +01:00
intllib Implement automatic per-session user translation 2017-11-22 19:27:39 +01:00
.gitmodules Implement automatic per-session user translation 2017-11-22 19:27:39 +01:00
README.md Installation instructions 2017-11-28 17:08:37 +01:00
auth_handler.lua Implement password changing 2017-11-18 11:35:22 +01:00
ban.lua Implement local ban 2017-11-19 16:32:26 +01:00
chatcmds.lua Implement local ban 2017-11-19 16:32:26 +01:00
default_settings.conf Fix crash on join player 2017-11-29 18:21:16 +01:00
formspecs.lua Implement registration & authentication & pinging 2017-09-09 13:17:36 +02:00
init.lua Change version number to 0.0.1 2017-11-23 20:00:18 +01:00
languages.txt Implement registration & authentication & pinging 2017-09-09 13:17:36 +02:00
mod.conf Use mod.conf for description 2019-10-27 15:34:17 -06:00
ping.lua Fix crash on pinging 2017-11-28 16:42:01 +01:00
rocks Add a `rocks` file 2018-01-14 11:25:36 +01:00
serverapi.lua Add HTTPS support 2017-11-28 16:19:59 +01:00
session.lua Fix crash on join player 2017-11-29 18:21:16 +01:00
settings.lua Error handling on authentication and registering 2017-11-18 12:55:54 +01:00

README.md

Umabis

Ultimate Minetest Authentication, Banning and Identity theft prevention System

Installing

Dependencies

The mod depends on LuaSocket:

# apt-get install luarocks
# luarocks install luasocket

For HTTPS support (highly recommended on production), you will also need the LuaSec package:

# luarocks install luasec

Configuring

Once you have installed the dependencies, added the mod in your mods directory and enabled it in your world.mt, you need to configure it.

Everything can be set in minetest.conf, prefixing settings names with umabis..

You can find an exhaustive list of settings in the default_settings.conf file, but most of them have sensible default values and you'll probably need to change only three of them:

  • umabis.api_uri: set this to the URI of your Umabis server, and add api/ at the end. The protocol needs to be explicitely written (http or https), and it would be an extremely bad idea to run a production server without https, as passwords would be sent in clear text.
  • umabis.server_name and umabis.server_password: the information that allow your minetest server to be authenticated by the Umabis server (see Setting up the database).

Start the minetest server and check the logs. If everything is going well, try to join the server and to register. Now, you can make yourself the first admin.

Version numbering convention

Both client and server version are represented using three numbers a.b.c:

a b c
Breaking change. If server a and client a are not equal, they will not be able to negociate. New server feature. If client b is lower than server b, it may not be able to benefit a few non-essential server features. Minor update (such as a bugfix).