Skip to content

Commit

Permalink
docs: document incompatibility with /restart
Browse files Browse the repository at this point in the history
  • Loading branch information
WiIIiam278 committed Oct 5, 2024
1 parent 099a258 commit 311cc85
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/Compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ HuskSync is primarily developed against the latest release. Old Minecraft versio
* Long Term Support (LTS) – Supported for up to 12-18 months
* Non-Long Term Support (Non-LTS) – Supported for 3-6 months

## Incompatible
## Incompatible versions
This plugin does not support the following software-Minecraft version combinations. The plugin will fail to load if you attempt to run it with these versions. Apologies for the inconvenience.

| Minecraft | Server Software | Notes |
Expand Down
1 change: 1 addition & 0 deletions docs/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ Welcome! This is the plugin documentation for HuskSync v3.x+. Please click throu

## Guides
* 📚 [[Setup]]
* ⚠️ [[Compatibility]]
* 📄 [[Config File]]
* 🔗 [[Troubleshooting]]
* ↪️ [[Data Rotation]]
Expand Down
14 changes: 14 additions & 0 deletions docs/Troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,17 @@ If you are hosting your Redis server on the same node as your servers, you need

### MySQL connection problems on Pterodactyl
If you have more than one MySQL server connected to your panel, you may need to set `useSSL=true` in the parameters.

### Issues with player data going out of sync during a server restart
This can happen due to the way in which your server restarts. If your server uses either:

* `/restart` (this is a weird Spigot command that uses legacy bash scripting)
* ANY restart plugin, e.g. UltimateAutoRestart (these basically execute an API-called restart using the same legacy bash logic as per above)

These are **not compatible** with HuskSync in most cases due to the way in which this causes restart servers causing shutdown logic to process in strange and unpredictable orders, usually before HuskSync has had a chance to scan and perform its shutdown logic. To safely restart your server, please use:

* A Pterodactyl task to perform a Restart. This executes the Power Action program stopcode (and then execute the startup command when the container has terminated)
* A cronjob to send a stop command / Power Action program stopcode, listen for the service to fully terminate, and then execute your startup command
* For manual restarts, executing `/stop` and starting your server up with the startup command is totally fine.

It's not a great idea to use a plugin to handle restarts. Plugins are only able to operate when your server is turned on and must rely on scripts which don't safely shutdown servers when restarting.
1 change: 1 addition & 0 deletions docs/_Sidebar.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
## Guides
* 📚 [[Setup]]
* ⚠️ [[Compatibility]]
* 📄 [[Config File]]
* 🔗 [[Troubleshooting]]
* ↪️ [[Data Rotation]]
Expand Down

0 comments on commit 311cc85

Please sign in to comment.