# Update
Check the PanelAlpha changelog (opens new window) with each new PanelAlpha release. It says when a release needs a newer Engine version.
You can update the Engine in two ways:
- From PanelAlpha: on the server's Details tab, click Update Now.
- From the command line on the Engine server, as described below. Use this if the panel shows "This server is outdated", if the update from the panel fails, or if you want to watch the output.
# What Happens During an Update
The updater downloads the new version, stops all Engine containers, replaces the Engine files, builds and starts the containers again, and then rebuilds the web server configuration and file permissions for every account. Websites are unavailable for a short time while the containers restart, so update outside peak hours.
The updater keeps files you may have changed in webserver-config and the ModSecurity exclusions. It does not change site files or databases.
The updater does not roll back on its own. If it fails, the server can be left between two versions.
# Before You Update
- Back up the server. A snapshot from your hosting provider is the simplest option.
- Read the changelog (opens new window).
- Make sure the server has a few GB of free disk space for the new Docker images.
# Update Steps
Log in to the Engine server as root:
ssh root@your-server-ipDownload the updater:
wget -N -P /opt/panelalpha https://license.panelalpha.com/engine-updater.shRun it:
bash /opt/panelalpha/engine-updater.shThe updater uses the license key saved on the server. To use a different key, add
--key 'YOUR_LICENSE_KEY'.The updater shows whether a newer version is available and asks for confirmation. Type
y.
# Updater Options
| Option | What it does |
|---|---|
--key <key> | Uses this license key and saves it on the server. |
--version <version> | Installs a given Engine version instead of the latest. |
--background | Runs without questions and in the background. The panel uses this option. |
--force | Runs even if the updater cannot detect the installed version. |
--debug | Prints more output. |
# Post-Update Verification
In PanelAlpha, open Configuration → Servers → Hosting Servers and click Manage on the server. Check the version on the Details tab.
Open a few sites on the server.
Create a test instance.
Check that all containers are running:
docker compose -f /opt/panelalpha/shared-hosting/docker-compose.yml ps
# Recovering from a Failed Update
Read the logs of the last run:
/opt/panelalpha/log/engine-updates/latest/holdsstdout,stderrandexit_code, plusfrom_versionandto_version. Older runs are in folders named by Unix time./opt/panelalpha/log/engine-updater_<date>.logis the full log of each run.
Fix the cause shown in the logs, for example a full disk or no access to
license.panelalpha.com.Run the updater again:
bash /opt/panelalpha/engine-updater.shTo go back to an earlier version, run the updater with that version:
bash /opt/panelalpha/engine-updater.sh --version <previous-version>This installs the files of that version again. It does not restore data. If something is still broken, restore your backup.
Only one updater can run at a time. If you see "Another instance is already running.", wait for the other run to finish.
For other problems, see Troubleshooting.