haveachin / infrared

An ultra lightweight minecraft reverse proxy and idle placeholder
https://infrared.dev
GNU Affero General Public License v3.0
758 stars 62 forks source link

More descriptive documentation/README? #15

Open bdotsamir opened 3 years ago

bdotsamir commented 3 years ago

Hello! The README is a bit ambiguous on the first read-through. It seems, according to the config variables, that Infrared expects there to be a minecraft server running in a Docker container, and that's what the proxy points to. Is that true?

Also, if people would like to contribute, creating a CONTRIBUTING.md file or just putting it in the README would be helpful.

vorburger commented 3 years ago

It's also not as clear as it perhaps could be from a first glance at the README if and how this proxy supports multiple Minecraft servers, as the first sentence hints at with: Ever wanted to have only one exposed port on your server for multiple Minecraft servers? The https://github.com/haveachin/infrared#examples show a single proxyTo. Does it support proxying to multiple Minecraft servers with different names on a single IP and port?