Skip to content

Installation

David Pesce edited this page Mar 4, 2026 · 1 revision

Installation

There are several ways to install the Logstore xAPI plugin on your Moodle instance. You must be logged in as a Moodle site administrator to install plugins.

Install from the Moodle Plugin Directory (Recommended)

The simplest method is to install directly from the Moodle Plugin Directory:

  1. Log in to your Moodle site as an administrator.
  2. Go to Site Administration > Plugins > Install plugins.
  3. Click Install plugins from the Moodle plugins directory.
  4. Search for "Logstore xAPI" and click Install now.
  5. Confirm the installation and follow the on-screen prompts.
  6. Proceed to Configuration to connect the plugin to your LRS.

Install via ZIP Upload

If you prefer to download the plugin manually:

  1. Download the latest release ZIP from GitHub Releases or from the Moodle Plugin Directory.
  2. In your Moodle site, go to Site Administration > Plugins > Install plugins (usually at http://your.moodle/admin/tool/installaddon/index.php).
  3. Drag and drop the ZIP file into the upload area.
  4. Click Install plugin from the ZIP file.
  5. Click Install plugin! to confirm.
  6. Proceed to Configuration to connect the plugin to your LRS.

Install via Manual Download

If ZIP upload is disabled on your Moodle instance:

  1. Download the latest release ZIP from GitHub Releases.
  2. Unzip the file.
  3. Copy the extracted folder into your Moodle installation at admin/tool/log/store/xapi.
  4. Visit your Moodle site's admin notifications page (http://your.moodle/admin/index.php) to trigger the database upgrade.
  5. Proceed to Configuration to connect the plugin to your LRS.

Enabling the Plugin

After installation, you need to enable the logstore:

  1. Navigate to Site Administration > Plugins > Logging > Manage log stores (or go to http://your.moodle/admin/settings.php?section=managelogging).
  2. Enable the Logstore xAPI plugin by clicking the eye icon.

Note: The plugin settings page will display a warning banner if the logstore is not enabled.

Upgrading

To upgrade to a new version, simply repeat the installation process using the new release ZIP. Moodle will detect the version change and run any necessary database upgrades automatically when you visit the admin notifications page.

Requirements

Requirement Details
Moodle version 4.3 or later (supported through 5.01)
PHP As required by your Moodle version
LRS Any xAPI-conformant Learning Record Store

Clone this wiki locally