FoF Upgrade Advisor

FriendsOfFlarum

A Flarum extension by FriendsOfFlarum. Check your forum's readiness for the next Flarum major version.

Adds an admin page that runs a series of readiness checks for Flarum 2.0 and shows an overall verdict, so you know what to address before upgrading.

Checks

PHP version — fails below PHP 8.3.
Database version — detects MySQL vs MariaDB and applies two tiers:
- Fails below the version required for JSON column support (MySQL 5.7.8, MariaDB 10.2.7), which Flarum 2.0 relies on.
- Warns below the recommended version (MySQL 8.4, MariaDB 11.8) to encourage staying on a modern, supported release.
Extension compatibility — for every installed extension (enabled or disabled — either will block the upgrade), determines whether a Flarum 2.0-compatible release exists. Each extension resolves to one of:
- Compatible — a published release supports flarum/core ^2.0 (pre-releases count).
- Incompatible — no compatible release yet.
- Abandoned — flagged by Flarum core or its support thread; if a replacement is suggested, its own 2.0 readiness is checked and shown.
- Superseded — functionality is now built into core, or the extension has moved to a different package (curated list).
- Could not check — a premium or private-repository extension that isn't on public Packagist (see below).

Compatibility is determined from Packagist and cross-referenced against the extension's official support discussion tags on discuss.flarum.org. For extensions the advisor can't resolve, it surfaces the support thread and author contact links so you can ask the author about their 2.0 plans.

Private & premium repositories

Extensions installed from private sources aren't on public Packagist, so the advisor can't check them by default. Under the Repositories tab you can add:

Floxum — just paste your access token.
Private Packagist / custom Composer repositories — provide the repository URL, username, and token.

Each repository has a Test connection button to verify the credentials before saving. Configured repositories are only queried for extensions that public Packagist can't resolve.

Adding your own checks

Other extensions can register additional checks via the Checks extender in their extend.php:

use FoF\UpgradeAdvisor\Extend\Checks;

return [
    (new Checks())
        ->add(\Acme\MyExtension\Check\MyCustomCheck::class),
];

Each registered class must implement FoF\UpgradeAdvisor\Check\Check and is resolved from the container, so it may type-hint any services it needs.

Installation

Install with composer:

composer require fof/upgrade-advisor:"*"

Updating

composer update fof/upgrade-advisor:"*"
php flarum cache:clear

Once your forum reports as ready and you've upgraded to Flarum 2.0, this extension has done its job and can be removed.

🚀 New Release: 1.0.0

Targets Flarum 1.x

Released by: @IanM
Release URL: FriendsOfFlarum/upgrade-advisor1.0.0

Initial release

luceos

@IanM original screenshots would be extremely helpful to understand what the extension does.

Well done on this one! Feeling inspired? 👏

FoF Bot

🚀 New Release: 1.0.1

Targets Flarum 1.x

Released by: @IanM
Release URL: FriendsOfFlarum/upgrade-advisor1.0.1

chore: map kilowhat audit to flarum/audit by @IanM in FriendsOfFlarum/upgrade-advisor2

Full Changelog: FriendsOfFlarum/upgrade-advisor1.0.0 → 1.0.1

ClaudiusH

luceos Here's an example readiness report output:
...I cropped the middle part of the long extension compability list. But the end looks like this:

huoxin

ClaudiusH Just realise there is a re-run check button after seeing your screenshot 😮
Maybe it is not a good idea to put it all the way below?

clarkwinkelmann

Please do not ask about compatibility in my extensions discussions though, I won't reply...

treyb

FriendsOfFlarum I may be missing something, but I don't see anything.

Karl

treyb try disabling it and purging it, then re-enable 🙂

treyb

Karl No dice, even removed and required again.

Karl

treyb try php flarum migrate and php flarum assets:publish

treyb

Karl Still nope, ill try again tomorrow when I have some time to troubleshoot.

@Karl EDIT: Update (In case anyone else needs similar)

Hey quick update, I figured it out.

fof/upgrade-advisor was installed and enabled, but the admin page was not loading because other extensions were causing admin JavaScript errors before Upgrade Advisor could fully register its page.

Here is what was messing it up:

quasimo-llms-txt
liplum-html-widget
justoverclock-custom-html-widget

The browser console ended up being the key. The first error I saw was from quasimo-llms-txt:

Uncaught TypeError: Cannot read properties of undefined (reading 'quasimo-llms-txt')

So I disabled that extension:

php flarum extension:disable quasimo-llms-txt
php flarum cache:clear
php flarum assets:publish

After that, I got another admin JS error related to widgets:

Uncaught TypeError: Cannot read properties of undefined (reading 'prototype')

That traced back to liplum-html-widget, which looked like it was still referencing the old Afrux widget namespace.

So I disabled that one too:

php flarum extension:disable liplum-html-widget
php flarum cache:clear
php flarum assets:publish

Then one more widget extension showed up in the console error:

flarum.extensions.justoverclock-custom-html-widget

So I disabled that as well:

php flarum extension:disable justoverclock-custom-html-widget
php flarum cache:clear
php flarum assets:publish

After disabling those three extensions and refreshing the admin panel, fof/upgrade-advisor loaded correctly.

Tutrix

treyb
I had already pointed out this error to @LinZhizhao
#3885716

With version 1.0.4 of quasimo-llms-txt, FoF Upgrade Advisor also works