multiserver

command module
v1.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 28, 2021 License: MIT Imports: 27 Imported by: 0

README

multiserver

Minetest reverse proxy supporting multiple servers and media multiplexing

Credits

This project was made possible by anon55555's Minetest RUDP package.

Modchannel RPC API

There is a modchannel-based RPC API for minetest servers: click here.

Installation

Go 1.16 or higher is required

go get github.com/HimbeerserverDE/multiserver

Updating

go get -u github.com/HimbeerserverDE/multiserver

How to use

Note: This shouldn't be used with existing minetest servers without moving authentication data (not the database files) to the proxy and then deleting the auth databases on the minetest servers! Not doing so can cause proxy <-> mt_server authentication to fail.

Running

The go get command will create an executable file in ~/go/bin/multiserver. This file should always be run from the same working directory. If you don't do this, the program will be unable to read the old data and will create the default files in the new working directory.

Configuration

The configuration file is located in WORKING_DIR/config/multiserver.yml

  • Default config file
host: "0.0.0.0:33000"
servers:
  lobby:
    address: "127.0.0.1:30000"
default_server: lobby
force_default_server: true

host

Type: String
Description: The IP address and port the proxy will be running on

player_limit

Type: Integer
Description: Maximum number of concurrent connections, unlimited if not set

servers

Type: Dictionary
Description: List of all servers

servers.*

Type: Dictionary
Description: Contains server details

servers.*.address

Type: String
Description: The IP address and port this server is running on

servers.*.priv

Type: String
Description: If this is set, players need this privilege (on the proxy) to connect to this server.
Leave this empty to require no special privilege. Note that this only affects the #server command. This means that
players can still be connected to this server if it is the default server, a minetest server requests it
or if a different command is used.

default_server

Type: String
Description: Name of the minetest server new players are sent to

force_default_server

Type: Boolean
Description: If this is false known players are sent to the last server they were connected to, not to the default server

admin

Type: String
Description: The "privs" privilege is granted to the player with this name on startup

csm_restriction_flags

Type: Integer
Description: The CSM restriction flags, default is none
* 0: No restrictions
* 1: No CSM loading
* 2: No chat message sending
* 4: No itemdef reading
* 8: No nodedef reading
* 16: Limit node lookup
* 32: No player info lookup
* 63: All restrictions
To set multiple flags at the same time add the corresponding numbers

rpc_reconnect_interval

Type: Integer
Description: Number of seconds between RPC reconnection attempts, default is 600

media_refetch_interval

Type: Integer
Description: Number of minutes between media refetching, default is 10

Documentation

Overview

Multiserver is a multi-server minetest reverse proxy capable of media and definition multiplexing

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL