diff options
| author | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-11-26 15:43:44 +0100 |
|---|---|---|
| committer | HimbeerserverDE <himbeerserverde@gmail.com> | 2023-11-26 15:43:53 +0100 |
| commit | ab0b8a57a3a48552317b0fc0de263a1426e0ff37 (patch) | |
| tree | 26d2f640981c827f4b39c39aa6aaf82463f0e74b | |
| parent | 79469ffae8aa2d3569f41a95fc1aa0e8c8a9ad36 (diff) | |
update/add documentation around helper executables
| -rw-r--r-- | README.md | 19 |
1 files changed, 15 insertions, 4 deletions
@@ -10,14 +10,25 @@ This project was made possible by [anon55555's mt module](https://github.com/ano Go 1.18 or higher is required. Run ``` -go install github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/mt-multiserver-proxy@latest +go install github.com/HimbeerserverDE/mt-multiserver-proxy/cmd/...@latest ``` to download and compile the project. A mt-multiserver-proxy executable -will be created in your $GOBIN directory. The same command is also +will be created in your ${GOBIN} directory. The same command is also used to upgrade to the latest version. You will need to recompile all plugins after upgrading. +In addition to the main `mt-multiserver-proxy` binary the following +additional utilities are installed: + +* [mt-auth-convert](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/auth_backends.md#mt-auth-convert): Helper program to convert between authentication database formats. +* [mt-build-plugin](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/plugins.md#automatic-version-management): Utility for building plugins against the correct proxy version. + +You can replace the `...` in the installation command +with any of the binary names to limit installation and updating +to a single executable. **This is not recommended, however, +as it can cause version mismatches between them.** + ## Usage ### Starting @@ -35,8 +46,8 @@ they have timed out. ## Configuration The configuration file name and format including a minimal example are described in [doc/config.md](https://github.com/HimbeerserverDE/mt-multiserver-proxy/blob/main/doc/config.md). -__All internal servers need to allow empty passwords -and must not be reachable from the internet!__ +**All internal servers need to allow empty passwords +and must not be reachable from the internet!** ## Authentication database migration It is possible to import existing Minetest authentication databases. |