mirror of
https://github.com/timvisee/lazymc.git
synced 2025-05-19 04:40:22 -07:00
Add extras document with recommendations and tips after installing
This commit is contained in:
parent
0049ad456c
commit
9b71052b61
16
README.md
16
README.md
@ -94,20 +94,14 @@ nano lazymc.toml
|
|||||||
lazymc start
|
lazymc start
|
||||||
```
|
```
|
||||||
|
|
||||||
Before you use this in production, please ensure starting and stopping the
|
Please see [extras](./docs/extras.md) for recommendations and additional things
|
||||||
server works as expected by connecting to it once. Watch `lazymc`s output while
|
to set up (e.g. how to fix incorrect client IPs and IP banning on your server).
|
||||||
it starts and stops. If stopping results in errors, fix this first to prevent
|
|
||||||
corrupting world/user data.
|
|
||||||
|
|
||||||
Follow this repository with the _Watch_ button on the top right to be notified of new releases.
|
After you've read through the [extras](./docs/extras.md), everything should now
|
||||||
|
be ready to go! Connect with your Minecraft client to wake your server up!
|
||||||
Everything should now be ready to go! Connect with your Minecraft client to wake
|
|
||||||
your server up!
|
|
||||||
|
|
||||||
_Note: If a binary for your system isn't provided, please [compile from
|
_Note: If a binary for your system isn't provided, please [compile from
|
||||||
source](#compile-from-source)._
|
source](#compile-from-source). Installation options are limited at this moment. More will be added
|
||||||
|
|
||||||
_Note: Installation options are limited at this moment. More will be added
|
|
||||||
later._
|
later._
|
||||||
|
|
||||||
[latest-release]: https://github.com/timvisee/lazymc/releases/latest
|
[latest-release]: https://github.com/timvisee/lazymc/releases/latest
|
||||||
|
28
docs/extras.md
Normal file
28
docs/extras.md
Normal file
@ -0,0 +1,28 @@
|
|||||||
|
# Extras
|
||||||
|
|
||||||
|
Some extra steps and recommendations when using lazymc:
|
||||||
|
|
||||||
|
Before you use this in production, always ensure starting and stopping the
|
||||||
|
server works as expected by connecting to it once. Watch `lazymc`s output while
|
||||||
|
it starts and stops. If stopping results in errors, fix this first to prevent
|
||||||
|
corrupting world/user data.
|
||||||
|
|
||||||
|
Follow this repository with the _Watch_ button on the top right to be notified
|
||||||
|
of new releases.
|
||||||
|
|
||||||
|
## Recommended
|
||||||
|
|
||||||
|
- [Protocol version](./protocol-version.md):
|
||||||
|
_set correct Minecraft protocol version for the best client compatability_
|
||||||
|
- [Proxy IP](./proxy-ip.md):
|
||||||
|
_fix incorrect client IPs on Minecraft server, notify server of correct IP with `PROXY` header_
|
||||||
|
|
||||||
|
## Tips
|
||||||
|
|
||||||
|
- [bash with start command](./command_bash.md):
|
||||||
|
_how to properly use a bash script as server start command_
|
||||||
|
|
||||||
|
## Experimental features
|
||||||
|
|
||||||
|
- [Join method: lobby](./join-method-lobby.md):
|
||||||
|
_keep clients in fake lobby world while server starts, teleport to real server when ready_
|
@ -1,7 +1,7 @@
|
|||||||
# Proxy IP
|
# Proxy IP
|
||||||
|
|
||||||
lazymc acts as a proxy most of the time. Because of this the Minecraft server
|
lazymc acts as a proxy most of the time. Because of this the Minecraft server
|
||||||
will think all clients connect from the same IP, being the IP `lazymc` proxies
|
will think all clients connect from the same IP, being the IP lazymc proxies
|
||||||
from.
|
from.
|
||||||
|
|
||||||
This breaks IP banning (`/ban-ip`, amongst other IP related things). This may be
|
This breaks IP banning (`/ban-ip`, amongst other IP related things). This may be
|
||||||
@ -49,7 +49,8 @@ Other related properties, you probably won't need to touch, include:
|
|||||||
## Server plugin
|
## Server plugin
|
||||||
|
|
||||||
Install one of these plugins as companion on your server to enable support for
|
Install one of these plugins as companion on your server to enable support for
|
||||||
the `PROXY` header.
|
the `PROXY` header. This requires Minecraft server software supporting plugins,
|
||||||
|
the vanilla Minecraft server does not support this.
|
||||||
|
|
||||||
If lazymc connects to a Spigot compatible server, use any of:
|
If lazymc connects to a Spigot compatible server, use any of:
|
||||||
|
|
||||||
|
@ -31,15 +31,11 @@ notepad lazymc.toml
|
|||||||
.\lazymc start
|
.\lazymc start
|
||||||
```
|
```
|
||||||
|
|
||||||
Before you use this in production, please ensure starting and stopping the
|
Please see [extras](./extras.md) for recommendations and additional things
|
||||||
server works as expected by connecting to it once. Watch `lazymc`s output while
|
to set up (e.g. how to fix incorrect client IPs and IP banning on your server).
|
||||||
it starts and stops. If stopping results in errors, fix this first to prevent
|
|
||||||
corrupting world/user data.
|
|
||||||
|
|
||||||
Follow this repository with the _Watch_ button on the top right to be notified of new releases.
|
After you've read through the [extras](./extras.md), everything should now
|
||||||
|
be ready to go! Connect with your Minecraft client to wake your server up!
|
||||||
Everything should now be ready to go! Connect with your Minecraft client to wake
|
|
||||||
your server up!
|
|
||||||
|
|
||||||
_Note: if you put `lazymc` in `PATH`, or if you
|
_Note: if you put `lazymc` in `PATH`, or if you
|
||||||
[install](../README.md#compile-from-source) it through Cargo, you can invoke
|
[install](../README.md#compile-from-source) it through Cargo, you can invoke
|
||||||
|
Loading…
x
Reference in New Issue
Block a user