Skip to content

Moodle versions and requirements

LearnBoard reads Moodle 4.0 to 5.3, on a MySQL or MariaDB database. This page lists what your Moodle site needs for each way of connecting, what the LearnBoard plugin for Moodle needs, and which optional Moodle plugins some screens read. It is for the Moodle administrator and the workspace administrator setting LearnBoard up.

  • Moodle 4.0 to 5.3 Supported
  • Database: MySQL or MariaDB.
  • Plugin: LearnBoard for Moodle, version 1.1.19, one plugin for the connection, the charts block, the LearnBoard page and sign-in.
  • https is required for the plugin connection.
  • Optional: a certificate plugin for certificate figures, and the Questionnaire activity for Course Feedback.
Moodle version Supported Notes
4.0, 4.1, 4.2 Yes The LearnBoard menu entry is not added automatically. Add it under Site administration, Appearance, Custom menu items.
4.3, 4.4, 4.5 Yes The LearnBoard menu entry is added automatically.
5.0, 5.1, 5.2, 5.3 Yes The LearnBoard menu entry is added automatically.
Earlier than 4.0 No The plugin needs Moodle 4.0 or later.
Later than 5.3 Not yet Outside the range the plugin is tested on.

LearnBoard’s reports are written for the Moodle 4.0 to 5.3 database, whichever way you connect.

Through the Moodle plugin

  • Moodle 4.0 to 5.3

  • PHP 7.3 or later, within the range your Moodle version supports

  • The Moodle site served over https, at a public address

  • A MySQL or MariaDB database

  • The Moodle data directory writable by the web server

  • The Moodle server clock kept to the correct time

  • A MySQL or MariaDB Moodle database

  • A database account granted SELECT only on that database

  • The database reachable from LearnBoard (host, port, any firewall or allow-list)

  • The correct table prefix

  • <'; title="Upload a copy" icon="cloud-download">
  • An export of a MySQL or MariaDB Moodle database, as a .sql file

  • Up to 2 GB

  • https: LearnBoard only reads a Moodle site over an encrypted connection. If your site sits behind a proxy that handles https, the Moodle administrator sets sslproxy in Moodle’s config.php.
  • A public address: use the address people type to open your Moodle. Private and internal network addresses are refused.
  • A writable data directory: the plugin records each request so it cannot be replayed, and keeps an audit file of every request there.
  • A correct clock: requests that arrive with a time too far from the correct time are refused, so the Moodle server needs automatic time synchronisation.
Name LearnBoard for Moodle (block_learnboard)
Version 1.1.19
Moodle 4.0 to 5.3
Includes the data connector, the LearnBoard block for course pages and the Dashboard, the full-page LearnBoard view, and per-user sign-in

Since version 1.1.0 the data connector is part of this one plugin. Sites that still have the older separate connector plugin (local_learnboard) can upgrade in place; once charts and the LearnBoard page work, the older connector can be uninstalled.

The plugin’s settings that matter for requirements:

Setting What it does
Allow LearnBoard to read data through the plugin The master switch for the data connector.
Read-only database user (optional) A database account granted SELECT only. LearnBoard’s queries then run on it instead of Moodle’s own account.
LearnBoard server addresses (optional) Only accept requests from these addresses. Leave empty to accept signed requests from any address.
Requests to answer at once How many LearnBoard requests the site works on at the same moment. Lower it on a small or shared server.
Enable per-user sign-in (SSO) Lets someone signed in to Moodle open LearnBoard without signing in again, and shows charts as that person.
Show LearnBoard in the main menu Adds the LearnBoard page to Moodle’s main menu (Moodle 4.3 and later).

Install steps are in the Moodle plugin section.

LearnBoard reads the reporting data Moodle already holds: user profiles, enrolments, course activity, grades, completions and logs. Tables holding site secrets, and password, token and key columns, are never sent.

Some figures depend on Moodle features being in use:

Moodle feature Used for
Standard log (logstore) activity, engagement, sign-in and active figures, and the risk score’s activity signals
Activity completion tracking tracked activities, In progress, and the “every tracked activity done” part of the completion rule
Course completion the course completion part of the completion rule
Gradebook and quizzes assessment figures, average quiz score, and the risk score’s grade signal
Course groups and site cohorts cohorts, the Groups filter, and team leads’ teams
Course categories departments in the Groups filter, and the engagement treemap
Moodle plugin What it adds
Custom certificate (mod_customcert) certificate figures
Certificate tool for Moodle Workplace (tool_certificate) certificate figures, including the expiry dates it records
Certificate (mod_certificate) certificate figures
Questionnaire (mod_questionnaire) the Course Feedback screen

When no certificate plugin is installed, certificate figures have nothing to count, and the Certified stage of the funnel stays empty. LearnBoard looks for these plugins itself; there is nothing to switch on.