🚧 Maintenance

On this page, you will find information on how to close your server or network for maintenance.

This module is configured in modules/maintenance.yml inside the PhoenixLobby folder.

#Maintenance

Maintenance closes a server, or the whole network, for everyone except the people you allow. Players already connected are kicked, and new connections are denied until it ends. Open it from Editor > Modules > Maintenance.

It works in two places. On a proxy, the maintenance lives on BungeeCord or Velocity and can close any backend server or the entire network at once. Without a proxy, the lobby runs its own maintenance and closes only that server.

Everyone with phoenixlobby.maintenance.bypass can always join, and phoenixlobby.maintenance is needed to use the command.

#Maintenance State

With this option, you can close the server right now, and open it again the same way. It has no end time, so it stays closed until you turn it back off. Use /maintenance start <time> instead when you want it to end on its own.

#Whitelisted Players

With this option, you can list the names or uuids that are still allowed in while the server is closed. It is the same list /maintenance add writes to, so either way of managing it works.

#Feature State

With this option, you can turn the module off completely. The commands stop working and nobody is kept out, even if a maintenance was left running.

#Time Format

Times are written as 1Y 1M 1W 1D 1H 1m 1S, and can be combined, for example 1D12H.

An uppercase M means months and a lowercase m means minutes.

#MOTD

Both sides replace the motd with a separate one while a maintenance is running, and {timer} shows how much time is left. The regular motd is covered on the MOTD page.

modules/motd.yml

maintenance:
  enabled: true
  motd:
  - '                &c&lUNDER MAINTENANCE'
  - '              &8We will be back in &7{timer}'

modules/maintenance.yml

enabled: true
start-at: 0
end-at: 0
whitelist: []

On the proxy the same options live in its config.yml and maintenance.yml. Either way the running and scheduled maintenances are saved to disk, so they survive a restart.

When both are running, the proxy denies the connection before the lobby ever sees it. Use the proxy commands on a network, and the lobby commands only on a standalone server.

Last updated 42 minutes ago