Update from the console and the update log
When a new MonoPbx release is available, a system administrator can install it from the admin console with a few clicks, watch each step, and read the full log afterwards. This page walks through that screen and what to do when something goes differently. The background (the update agent, air-gapped installs, scheduled upgrades, rolling back) is in Updates and upgrades.
Who can do it
- Checking for updates and installing them needs the permission to operate the installation (the System Owner role). Without it the Check for updates button is not shown.
- Reading the log and the Upgrades page needs the permission to view system settings.
Every request is recorded in the audit log.
Where to find it
- At the bottom of the admin console's sidebar, next to the version number, the link Updates (with a badge while a newer release is out).
- System, Upgrades, which has the Software update card, the upgrade log and the snapshots for rolling back. While a newer release is waiting, the Upgrades entry carries an Update badge.
Install an update in one flow
- Choose Check for updates. A window titled Software update opens and says one of:
- "You're up to date." with the version and the channel;
- "Version 1.3.0 is available" with a Release notes link;
- that the update check is off, or why the release channel could not be reached.
- Read the release notes, then choose Install update.
- The window explains what will happen: a full backup is taken first, the new release is checked, started and must pass its self-test, and if the self-test fails MonoPbx returns to your current release by itself. It also warns that the PBX is offline for a few minutes and calls in progress end, so pick a quiet time. Confirm with Upgrade to 1.3.0, or choose Cancel.
- The window says "Waiting for the update to start…" until the server's update agent picks the request up, usually within a few seconds. The result of an earlier update is not shown in the meantime. Then the window switches to the progress list. The steps are Requested, Downloading the release, Checking the release, Taking the backup, Installing, Starting and updating the data and Running the self-test, with the current one in bold. The window cannot be closed while the update runs.
- The console goes offline while the PBX restarts and shows "The console is offline while the PBX restarts. Waiting for it to come back…". Leave it open. When the new release answers, the console reloads itself and you are on the new version.
The same steps are shown on the Upgrades page under Upgrade progress, so you can follow an update there as well, or from another browser tab. Check now on that page also reads the server's update state again, so the Upgrade now button and the progress always match the latest check.
The update log
Below the steps (in the window and on the Upgrades page) Show log opens the Upgrade log: the full output of the run, covering the download, the backup, the start, the self-test and, if it happened, the rollback. While the update runs the log follows the end by itself. Hide log closes it and Download log saves it as a text file.
- If the update fails or is rolled back, the log opens by itself and highlights First failing line.
- Earlier runs are listed under Earlier upgrades, each with a Download log link. The last ten runs are kept.
- Passwords, tokens and keys that appear in the output are replaced with
[redacted], and only the most recent part of a very long log is shown. - If the log cannot be loaded the page says so and names the folder on the server where it is kept.
When you ask support for help with an update, download the log and attach it.
The three outcomes
| What the window says | What it means |
|---|---|
| "Upgraded to 1.3.0." and the console reloads | The new release is running and passed its self-test. |
| "The upgrade to 1.3.0 did not pass its self-test. 1.2.0 is running again with the data from before the upgrade." | MonoPbx went back by itself. Nothing is lost. Read the log, and contact support with it before you try again. |
| "The upgrade to 1.3.0 did not complete." with a reason | Read the reason and the log. If it says nothing was changed, your current release is still running. |
After a successful update the backup taken at the start is kept, so Roll back on the Upgrades page remains available.
When no button is shown
There is no Install update button when:
- You do not have the permission. Ask a System Owner.
- The release is not offered for one-click install. The window says "This release needs your decision, so the console does not start it" and lists the reasons, for example a change that needs your attention or a jump of several releases. Read the release notes, then upgrade from the command line as they say.
- This install cannot upgrade itself. The window shows Upgrade from the command line with the exact command to run on the server. The Updates and upgrades page lists the command for each kind of install.
- Another update or rollback is already running. The window says so and the page keeps checking. Wait for it to finish.
- The update check is off. This is the setting for installs without internet access; see Updates and upgrades.
- The release channel cannot be reached. Check that the server can reach the internet, then choose Check for updates again. If the channel offered a different release while you were reading, check again and confirm the release shown.
Notes
- Install updates in a quiet period: calls in progress end when the PBX restarts.
- Scheduled upgrades, if set up, show on the Upgrades page under Scheduled upgrades, with how the last run ended.