Appearance
System Updater
How the System Updater page works: Admin → System → System Updater (/admin/system/updater).
The page downloads the newest version of the product from the license server and installs it over the current code. Data in the database is kept. There are three ways to run it:
| Way | Where | Use it when |
|---|---|---|
| One-Click Updater | "Download & Install Update" / "Re-install The Latest Version" button | Normal case |
| Manual System Updater | The 6 "Run" buttons on the same page | The one-click run times out or fails halfway |
| CLI | php artisan cms:update | You have shell access; no web timeouts |
All three call the same methods in Core, so the result is the same. See The update process.
DANGER
Always back up the database and files before updating.
Key files
| File | Role |
|---|---|
platform/core/core.json | Product ID, current version, license-server and marketplace URLs/keys |
platform/core/base/src/Supports/Core.php | All update logic: check, download, validate, extract, migrate, publish, clean |
platform/core/base/src/Http/Controllers/SystemController.php | getUpdater (page), postUpdater (runs one step), getCheckUpdate |
platform/core/base/src/Enums/SystemUpdaterStepEnum.php | Step names, order, progress % |
platform/core/base/resources/views/system/updater.blade.php | The page |
platform/core/base/resources/js/components/SystemUpdateComponent.vue | One-click button and progress screen (built to public/js/system-update.js) |
platform/core/base/src/Commands/UpdateCommand.php | cms:update command |
platform/core/base/resources/lang/en/enums.php → system_updater_steps | Step labels and messages |
platform/core/base/config/general.php → enable_system_updater | On/off switch |
Routes
Defined in platform/core/base/routes/web.php.
| Method | URL | Name | Action | Permission |
|---|---|---|---|---|
| GET | /admin/system/updater | system.updater | getUpdater | superuser |
| POST | /admin/system/updater | system.updater.post | postUpdater | superuser, preventDemo |
| GET | /admin/system/check-update | system.check-update | getCheckUpdate | superuser |
Configuration
.env
ini
CMS_ENABLE_SYSTEM_UPDATER=true # false hides the menu item, returns 404 on the page and blocks cms:updateplatform/core/core.json
json
{
"productId": "8FC3E4BB",
"source": "envato",
"apiUrl": "https://license.webhaki.com",
"apiKey": "<license server API key>",
"version": "2.0.0",
"marketplaceUrl": "https://marketplace.webhaki.com/api/v1",
"marketplaceToken": "<marketplace token>",
"minimumPhpVersion": "8.3.0"
}| Key | Used by the updater? | Meaning |
|---|---|---|
productId | Yes | Tells the license server which product to send. An update zip must have the same ID. |
version | Yes | Installed version. Compared with the server's latest version. |
apiUrl | Yes | License/update server. All update requests go to {apiUrl}/api/.... |
apiKey | Yes | Sent as the X-API-KEY header. |
minimumPhpVersion | Yes | Checked against the update zip's own core.json. |
source | No | License source (e.g. envato). Used by license activation. |
marketplaceUrl / marketplaceToken | No | Plugin marketplace only (see Servers and endpoints). They must still exist in an update zip, or validation fails. |
apiUrl and apiKey in core.json override the defaults hard-coded in Core.php.
core.json is cached under the key core_file_data for 30 minutes. Clear the cache after editing it.
PHP limits
The page warns if the server is below:
memory_limit≥ 256Mmax_execution_time≥ 300 seconds
The updater also calls BaseHelper::maximumExecutionTimeAndMemoryLimit() to raise them at runtime where the host allows it. The curl and zip PHP extensions are required.
What the page shows
SystemController::getUpdater() runs on page load:
verifyLicense(false, 15)→$activated(is a license activated?).getLatestVersion()→ asks the license server for the newest release. It sendscurrent_version = "0.0.0"on purpose, so the server always returns the latest release, even when the site is already on it.$isOutdated = version_compare(installed version, latest version, '<').- If the license server can't be reached,
$latestUpdate = nulland the page just says "up to date".
| Situation | What appears |
|---|---|
$isOutdated = true | "Latest changelog" card at the top, and the Download & Install Update button |
$isOutdated = false | "The system is up-to-date" message, the Re-install The Latest Version button, and the changelog at the bottom |
| License not activated | Red warning, and a confirm modal before running ("You might not receive the latest updates") |
| PHP limits too low | Yellow warning with the needed values |
$latestUpdate exists | Manual System Updater card with 6 steps |
"Re-install The Latest Version" is the same process as "Download & Install Update". Only the label differs. It downloads the current latest release again and extracts it over your files. This is useful to repair broken or edited core files.