Auto-upgrade feature that we introduced in Active Collab 3.3 changed the way people manage their self-hosted installations.Tweet
It also gave us a means to ship improvements and bug fixes without overwhelming our customers with excess maintenance work. Thanks to auto-upgrade we shipped a lot of releases in 3.3, 4.0, 4.1 and 4.2 branches without any major bumps along the way.
Original plan for Active Collab 5 rollout was to have Heartbeat as a good shepherd that watches over self-hosted Active Collab installations and provides them with all sorts of useful services. One such service was auto-upgrade. When Heartbeat proved to be an unrealistic service to provide given the diversity of setups that Active Collab runs on, we had to rethink the auto-upgrade as well.
First stable iteration of this new auto-upgrade engine comes in Active Collab 5.0.88. Once you ask Active Collab to upgrade itself, it will do several things:
- Check if there are new releases,
- Download the latest release and unpack it (new engine uses 50% smaller upgrade packages than the old auto-upgrade system),
- Check if current environment meets the system requirements of the new release and whether all migrations can be ran or not,
- Backup the database prior to running the database migrations,
- Update the database.
Once all steps are done, Active Collab is switched over to the new release and temporal data is cleaned up. Database backup is kept, for the reference and in case you need to revert to it for whatever reason.
To start the upgrade process, open your command line,
/tasks folder of your Active Collab and run:
php activecollab-cli.php check_for_updates
As you can see on the screenshot, our internal 5.0.86 build that we used for testing reported that there’s a new release available for download. Lets upgrade by running the following command:
php activecollab-cli.php upgrade
We wanted to ship this as soon as possible, so there’s no web interface for auto-upgrade just yet, but that’s definitely planned for one of the upcoming releases. Until then command line utility is here to automate what used to be a manual process.
Upgrading from Older Active Collab 5 Beta
If you already have Active Collab 5.0.x beta installed, please follow these upgrade instructions:
- Go to my.activecollab.com and click on Licenses option. There you can download Active Collab 5.0.88.
- Unpack the ZIP archive.
/activecollab/5.0.88from the package to
/activecollab/5.0.88folder of your current Active Collab 5 installation. Don’t delete the older Active Collab version from your server just yet, we still need it.
/tasksfolder on your server and upload all the new files from
/tasksfolder of the Active Collab 5.0.88 installation package. We’ll need all of these files, incuding
activecollab-cli.php, as well as all three cron jobs that are in
/activecollab/X.Y.Z/angie/src/Angie/Command/UpgradeCommand.phpfile (where X.Y.Z is your current version) with the file from this ZIP archive: UpgradeCommand.php.zip,
- Using your terminal,
/tasksfolder on your server and run:
php activecollab-cli.php upgrade. This command will run all the required database migrations and upgrade your
- Delete everything inside
/cachefolders (delete everything except
.htaccessfile if you have it).
- If you are upgrading from Active Collab 5.0.49, log in and go to System Settings and under Technical Settings configure outgoing mail, search, and Cron jobs.
That’s it. If you notice any problems or need our help, do get in touch.