AstroShield Docs

Command Palette

Search for a command to run...

Updating

How AstroShield updates itself, how to turn that off and how to update by hand.

AstroShield can update itself. Updates replace the resource's own files and never touch your other resources, your configuration or your bans, which live in the dashboard.

Automatic updates#

A few seconds after it starts, AstroShield asks astroshield.dev for the latest release and compares it with the version in its .version file. If a newer version exists:

  1. It downloads the changed files for your license and writes them into the AstroShield folder.
  2. It writes the new version number to .version last, so an update that was interrupted is offered again on the next start.
  3. It prints Updated to v1.x.x! Restart the resource in the console.

The new files only take effect after you restart the resource. Run restart AstroShield in the server console, or restart the server.

Automatic updates need the add_unsafe_child_process_permission AstroShield line from the installation, because that is how the files are written.

Turn automatic updates off#

If you want to control when updates happen, switch off Auto-Update in the dashboard under Configuration, General. See Configuration.

While it is off, AstroShield only logs that a newer version exists:

Output
[AstroShield] Update v1.1.0 is available. Auto update is off in the dashboard (Settings > General).

The update stays pending and is installed as soon as you turn the switch back on.

Update by hand#

  1. Download the latest ZIP from the dashboard, the same way as in Installation.
  2. Stop AstroShield: stop AstroShield.
  3. Extract the ZIP over the existing AstroShield folder and overwrite the files.
  4. Start it again: start AstroShield.

The ZIP contains your .key and .version, so overwriting them is fine. Your configuration is not stored in the folder.

Release notes#

Each release has notes in the dashboard. They are listed on the Dashboard page under Changelog, tagged as Added, Fixed, Updated or Removed.

If an update fails#

Update failed: ... in the console names the reason. The usual causes are a missing add_unsafe_child_process_permission line, a resources folder the server user cannot write to, or no connection to astroshield.dev. Fix the cause and restart AstroShield, or update by hand.

PreviousInstallationNextUninstalling