diff options
| author | HimbeerserverDE <himbeerserverde@gmail.com> | 2021-08-28 13:20:57 +0200 |
|---|---|---|
| committer | HimbeerserverDE <himbeerserverde@gmail.com> | 2021-08-28 13:22:35 +0200 |
| commit | 1b364826ed2f8205bdd8c7473a095683d4cb44f2 (patch) | |
| tree | 418412c708a75963fe3587e2f0a84f15ad2665a0 | |
| parent | 25781fea002bb12ef12c2285fbbe9d540748f42a (diff) | |
Document installation and usage
| -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!** |