https://github.com/shivajiva101/sauth

authentification handler mod for minetest
https://github.com/shivajiva101/sauth

authentification lsqlite3 minetest-mod

Last synced: about 1 month ago
JSON representation

authentification handler mod for minetest

• Host: GitHub
• URL: https://github.com/shivajiva101/sauth
• Owner: shivajiva101
• License: mit
• Created: 2017-10-01T16:56:09.000Z (about 7 years ago)
• Default Branch: 0.5
• Last Pushed: 2024-05-20T15:55:38.000Z (6 months ago)
• Last Synced: 2024-09-27T08:43:49.234Z (about 2 months ago)
• Topics: authentification, lsqlite3, minetest-mod
• Language: Lua
• Homepage: https://forum.minetest.net/viewtopic.php?f=9&t=18604
• Size: 152 KB
• Stars: 11
• Watchers: 7
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sauth v2.0

[![Build status](https://github.com/shivajiva101/sauth/workflows/Check%20&%20Release/badge.svg)](https://github.com/shivajiva101/sauth/actions)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

IMPORTANT: Version 2 changes the DB schema inline with the core auth schema. The existing sauth.sqlite will be converted so make a backup! ONLY USE with minetest version 0.5 or greater.

Sauth is an alternative sqlite3 auth handler for minetest. Capable of handling large player databases and provides mitigation of auth entry request load by use of memory caching. Fine tune your servers auth memory load by caching clients who play regularly to reduce join event load on the server, resulting in a better playability experience on servers with many player accounts.

Requires:

* lsqlite3 lua library. (http://lua.sqlite.org/)

* SQLite3 (https://www.sqlite.org/) OR your favourite SQL management app (for importing sql files)

I suggest you use luarocks (https://luarocks.org/) to install lsqlite3.

	sudo apt install luarocks

	luarocks install lsqlite3

Your server should always run mods in secure mode, you must add sauth to the list of trusted mods in minetest.conf for example:

	secure.trusted_mods = irc,sauth

You can and should use your existing auth db, make a copy of auth.sqlite renaming it to sauth.sqlite BEFORE starting the server.

To enable the mod for singleplayer add:

	sauth.enable_singleplayer = true

to minetest.conf before starting the server.

Caching comes at the expense of memory consumption. During server startup sauth initialises the cache with up to 500 players who logged in to the server in the last 24 hours before the last player to login prior to shutdown. You can manage the cache by adding these settings to minetest.conf and modifying the values otherwise the mod will use the hard coded defaults.

	sauth.cache_max = 500 -- default maximum number of memory cached entries on startup

	sauth.cache_ttl = 86400 -- default seconds deducted from last login

Uninstalling

If/when you want to remove sauth just delete the mod and minetest will default back to using the internal auth handler on the same db, it's as simple as that!