Manual/Custom Install

Upgrade Manual/Custom Install

Upgrading a manual/custom installation happens in 3 stages:

Requirements (upgrading to v1.8.x)
Upgrade the CMS files (Upgrading the CMS files is a manual process that should be completed by your web server administrator).
Upgrade the database (In 2.x, 3.x and 4.x, upgrading the CMS can be done by your web server administrator from the terminal. In versions earlier than v2.0.0 upgrading is completed in a wizard and can be done by the CMS administrator).

Please check the release notes for the version you want to upgrade to before starting the upgrade.

You should always take a backup before upgrading your CMS Installation.

Upgrading to v4.0.0 and later

Open a terminal
cd into your installation folder
run vendor/bin/phinx migrate -c phinx.php

Xibo CMS v4 requires public/private and encryption keys to be saved in the library folder. Instructions for doing this can be found here.

After a successful upgrade a background task called “Widget Compatability” runs in XTR and converts all widgets from v3 to v4. Xibo v4 must have XTR correctly configured and operational to function correctly.

Upgrading to v3.0.0 and later

Open a terminal
cd into your installation folder
run vendor/bin/phinx migrate -c phinx.php

Upgrading to v2.0.0 and later

Open a terminal
cd into your installation folder
run vendor/bin/phinx migrate -c phinx.php

Upgrading to a version earlier than v2.0.0

Log in as an administrator.
The upgrade wizard will open and show the list of upgrade steps.
Press start to run through them.

Upgrading to v1.8.x

Ensure your environment meets the requirements for installation. If it does not then correct that before continuing.
Backup settings.php from your installation (found in web/settings.php )
Manually take a backup of your database
Replace your existing installation with the new version from the tar.gz or zip file. Do not copy over the top.
Replace your backup settings.php file in your Xibo installation directory
Browse to http://your.server/path as normal

Verify All

If upgrading to a version earlier than 4.0.0, once the upgrade has completed, login to your CMS and click the Verify All button from the Modules page under the Administration section of the CMS main menu. This is to ensure any updates/enhancements are applied to any module files which may have changed between versions.