Updates

154 vues Markdown

Review the pending version, pre-checks, backup, and rollback status before starting an update to keep the upgrade process controlled.

Reaching the Screen

Panel menu: Help then Updates: {admin}/help/updates

The version control in the top bar sits on every admin page and opens the same screen. Its dot turns red when a mandatory release or a security patch is waiting. It is shown to any staff member who may see this screen.

Bell messages are a narrower audience: only staff who may run upgrades receive them. Three of those messages carry a Go to updates button that lands here (a new release, an automatic upgrade that stood down because of the theme, a run that failed); the messages about a mandatory release and about a waiting security patch do not.

What Is on the Screen

Two cards. The first carries the verdict and everything that governs it, the second the release history. Bands appear above and inside the first card only when they have something to say.

The status strip One sentence saying where this installation stands, the version pair when a release is waiting, and the buttons that act on it.

Pre-flight checks Four questions answered when the page is drawn, so whether an upgrade can start is stated before you open anything. Shown only while a release is waiting.

Bands An unfinished run, a release list that could not be fetched, a mandatory release nothing will install, a security patch waiting. Each appears only under its own condition.

The facts row Four cells with what governs this page: automatic approval, release channel, backup directory, system health.

Version history Every release this installation may see, grouped by major line, newest first, with its notes behind the row.

The status strip

The strip opens with a verdict, and there are three of them: You are up to date when nothing newer can be installed, A new version is ready when a release is waiting and nothing stands in its way, and The upgrade cannot start when a release is waiting but a blocking check failed. Under it a chip names the package: product and version, the channel it came from, and the download size when a release is waiting.

When a release is waiting the strip also prints the jump, Installed on the left and Upgrading to on the right. A patch level rides beside the installed number as an SC-1 mark when the running version was rebuilt under a security patch; hovering it lists the patches it carries.

The buttons follow the same condition. With a release waiting you get What Changed (only when that release actually has notes, since it jumps to its row in the history below) and Start Upgrade, which is disabled while a blocking check stands. With nothing waiting the first button is Check for Updates instead. The gear that opens Update Settings is there only for staff who may run upgrades.

Once a check has run at least once, a last line says when the release list was fetched and who asked: manual for the button on this page, automatic for the hourly job. Both write the same record, so the two can never disagree about what came back. On an installation where neither has run yet, the line is not drawn at all.

The pre-flight checks

Four checks are resolved while the page is drawn, and they are only shown while a release is waiting. If all four pass, the strip says Ready to upgrade and names them in one line. If any fails, only the failures are listed: printing four chips made a single failure shout four times over.

Check	Fails when	Effect
You do not have permission	your account cannot run upgrades	blocks
License not eligible	the license does not cover upgrades	blocks, except a security patch
Server requirements not met	memory limit or maximum execution time below what the release asks for, or the ZipArchive extension is missing	blocks
You are using a custom theme	the theme did not ship with the product and some release in the pending chain moves template files	warns only

The theme check needs both halves to be true. A release the publisher marked as leaving the theme alone raises nothing, because warning about it would teach you to click past the warning that mattered. And the whole pending chain is examined, not just the newest release: taking an upgrade by hand applies every release in between, so an intermediate one that rewrites templates is as much a reason to warn as the last one.

The bands

An unfinished run Above the card, whenever a run is still open. It names the version, the phase it reached and how far it got, and reads in one of four ways: an upgrade is running, it is waiting for the automation, the automation did not take it over, or it stopped and needs you. Its buttons are shown only to staff who may run upgrades.

The release list could not be retrieved Above the card, in red, with the reason the license network gave. Without it you would see a page with no releases and nothing saying why.

This installation is not in the beta program Amber, when the channel is set to Beta but this installation was not admitted. Beta releases are hidden, the stable ones are still listed and installable, and the fix is the gear button on this page.

A mandatory release is waiting Red, inside the card, and only when both automatic switches are off, because then the only mover left is the person reading the page. With either switch on the band stays quiet, since the automation is expected to take the release: always so for automatic approval, and for the security switch only while the release sits on your current release line.

A security patch is waiting The version you run was rebuilt in place under a patch. Amber when either switch will apply it within minutes, red when neither will. The patch ids are listed as chips, the ones already in place marked as such, and Apply now starts it.

Preview Only when the address carries a preview parameter and your account may run upgrades. A sample release or patch is staged so the flow can be reviewed; nothing is upgraded and no request is sent. Without that privilege the parameter is ignored and the page stays on the real state of the installation.

The facts row

Four cells stating what this page is governed by, rather than dates nobody acts on.

Automatic Approval Enabled or disabled. When it is off but mandatory patches are still automatic, a small shield beside the value says so.

Release Channel Stable or Beta, the channel the release list was asked for.

Backup Directory Read-only here: the folder is named in the backup settings. A tick means it exists and can be written to, a warning triangle means it cannot.

Health Status A badge with the health page's own verdict, linking to it. Its tone follows severity, not a score.

Under the cells, a quiet line offers the way back from the last finished run when one is still available. Nothing is wrong when it appears; an option simply exists.

Version history

Releases are grouped by major line and each group can be folded. Grouping states a reason: sorted by version alone the dates jump backwards, because a v5 installation and the separately maintained older line are two histories, not one. Each group header says whether it is the line this system runs on or an older line that does not affect it, and how many releases it holds. All groups open by default, since folding one would hide most of the history on an installation whose own line holds a single release.

A row carries the version, its marks, what the release contains and its date. Rows with notes open them underneath; a release the publisher recorded no notes for, such as an installed version the network no longer publishes, says No changelog recorded instead.

The notes panel always says what happened to the theme, one of three ways: a link to the changes when the release moves template files and the publisher supplied a comparison address, a plain line saying the theme changed when no such address exists, and a line saying the theme was left alone otherwise. It also links to the full public release notes, when the publisher gave an address for them.

Installed The version this system runs. It is listed even when the network no longer publishes it: the page states what you have, not only what you could get.

Available The release the strip above is offering.

Beta A test release. It only appears while the channel is Beta and this installation was admitted to the program.

Mandatory The publisher marked this release as one that must be taken. It is what the automatic security switch installs on its own, but only while the release sits on your current release line.

SC-1 The package of that release was rebuilt in place under a security patch, and the number is how many times. Hovering lists the patch ids.

The counts beside the version are the publisher's own buckets: new, improved, fixed and flagged. Flagged is the security bucket and is the one worth reading before the others.

Fields

Three settings behind the gear, and two switches inside the upgrade wizard.

Updates are approved and installed automatically Off by default. When on, the hourly check starts the installation as soon as it finds a release, without waiting for approval, and the automation carries out the steps on the server. A backup is always taken first, and that is not a choice: an upgrade nobody is watching has to be reversible.

Mandatory security patches install automatically On by default, and it works even while the switch above is off. It only installs mandatory releases within your current release line, along with the ordinary releases that have to be applied before them; it never moves you to another line. Turning it off makes mandatory patches wait for you as well.

Release Channel Stable by default. Beta also offers test releases and only works on installations admitted to the beta program. Changing the channel drops the cached release list, because a different channel is a different catalogue.

Create Backup On by default in the wizard, and it cannot be turned off for a security patch. While it is on, the wizard states where the archive goes and how to come back to it; turning it off collapses both, because a promise of a way back is false when no archive is being taken. If the backup directory cannot be written to, the wizard will not let the run start while the switch is on.

I read and understood Only appears when the wizard has something to warn about and nothing to block it: a custom theme, or a notice the publisher attached to this particular release. The continue button stays closed until it is ticked.

Tasks

Ask whether a new release exists

Press Check for Updates in the strip. The button is only there while nothing is waiting.
If a release was found the page reloads and the strip changes to the version pair; if not, a small confirmation says you are up to date and the page stays as it is.
If a release was found, the reloaded page reads manual and the time on the last line under the buttons. If none was found the record is still updated on the server, but the line on screen keeps the previous check until you open the page again.

Start an upgrade

Press Start Upgrade. If a warning was raised, the dialog opens on it first: read it, tick I read and understood, then continue.
Check the plan (which versions will be applied and in what order) and leave Create Backup on unless you have your own restore point.
Press the start button. The run is opened but not driven from your browser: the automation on the server picks it up within a minute and carries the phases.
The dialog follows the phases and you may close the window. When it finishes, the strip reads You are up to date and the new version carries the Installed mark in the history.

Apply a waiting security patch

In the security patch band, read the chips: they are cumulative, so the ones marked as already in place are not news.
Press Apply now. The same wizard opens, named after the patch, with the backup forced on.
Start it. When it finishes, your version number is unchanged and the patch level beside it has moved up.

Change how updates are installed

Open the gear button next to the strip.
Set the two switches and the channel. If you pick Beta a warning appears under it, and if this installation runs a theme that did not ship with the product, a note under the first switch explains why some releases will still wait for you.
Save. The page reloads and the facts row shows the new values.

Roll back the last update

Find the line at the foot of the first card and press Roll Back. It is only drawn when the last finished run can still be undone.
Read the confirmation: how many files return, how many added files are removed, what the version or patch level goes back to, and that database changes stay as they are.
Confirm. The files are put back, the version marks return, and the page reloads onto the state you came from.

Deal with a run that stopped

Read the band at the top of the page: it says whether the run is being carried, waiting, abandoned or failed, and when the automation is not coming it names the reason.
One button is offered at a time, and they replace each other: a run being carried or waiting offers See progress, a failed one offers View, and a run the automation never took over offers Continue, which hands it to your browser.
In the dialog, a failed run offers Retry, which unlocks it and hands it back to the automation, and cancel, which closes it for good.
Whatever finished is kept, so a resumed run continues from the phase it stopped on rather than starting over.

Review the upgrade flow without upgrading

Open the screen with a preview parameter. It only works for staff who may run upgrades: {admin}/help/updates?preview=upgrade stages a sample release, ?preview=sc a sample security patch, ?preview=critical a release the publisher attached a blocking notice to, and ?preview=blocked a licence that does not cover upgrades.
A banner says the screen is staged. Walk the wizard as usual; no request is sent and nothing is installed.
Press Leave Preview to return to the real state of the installation.

Things to Watch

Rolling back returns files, not the database

Files go back and the version marks follow, but schema changes stay as the update left them, and so does the release's own configuration step. It is offered for the last finished run only and can be taken once. Anything older is the full backup's territory, which is why leaving the backup switch on matters.

With both switches off, nothing patches this installation

Mandatory releases and security patches are the reason the second switch defaults to on: a fleet is only patched when the fix reaches the installations whose operator never opened this dialog. Turn both off and only the channels that warn are left: the red band on this page, a bell message, and the red dot in the top bar. None of them installs anything.

A license that does not cover upgrades still sees the list

The history is never hidden: you are told what exists and what it would take to get it. Only the run is barred, so the start button stays closed. A security patch is the exception and is applied anyway, because it repairs the version you already bought rather than granting a newer one.

Required Privileges

The Help section as a whole opens for staff holding any of its privileges. This screen needs HELP_UPDATES_LOOK, which is also what puts the version control in the top bar. Everything that moves an upgrade needs HELP_UPDATES_OPERATION: without it the settings gear, the roll back line, the run band's buttons and the security patch button are not drawn, the preview parameters are ignored, the bell messages about a release are not delivered, and the four operations behind them are refused on the server as well. Updating a bought module or theme from the same section is stricter still and needs ADMIN_PRIVILEGES.

Cet article vous a-t-il été utile ?

Merci pour votre retour !

Besoin d'aide supplémentaire ?

Notre équipe d'assistance est disponible 24h/24 pour tout ce que vous ne trouvez pas ci-dessus.

Nous contacter Ouvrir un ticket