diff options
| -rw-r--r-- | README.md | 15 |
1 files changed, 15 insertions, 0 deletions
@@ -1,2 +1,17 @@ # MTConnector MTConnector is a reverse proxy designed for linking multiple Minetest servers together +## Installation +Go 1.16 or higher is required. Run + +`go install github.com/HimbeerserverDE/MTConnector` + +to download and compile the project. A MTConnector executable +will be created in your $GOBIN directory. +## Usage +Run `$GOBIN/MTConnector`. The configuration file and other required +files are created automatically in the directory the executable +(or symlink to said executable) is in, so make sure to move the +executable to the desired location or use a symlink. +## Configuration +The configuration file name and format are described in [doc/config.md](doc/config.md) +**All internal servers need to allow empty passwords and must not be reachable from the internet!** |