Installing MuTMS

MuTMS plugins are distributed through two official channels and can be installed using one of several methods depending on your setup.

MuTMS currently supports Moodle 4.5.x, 5.0.x, 5.1.x, and 5.2.x. These correspond to all officially supported Moodle releases at the time of writing. For information on which Moodle versions are currently receiving security updates see the Moodle releases page.

Want to try it quickly?

Not ready to set up a server? Run a throwaway MuTMS demo with mdl-demo — no web server, database or configuration. One command on macOS, Windows or Linux gives you a full MuTMS site to explore, and you delete the container when you are done. It is quicker than a test install on your own server.

Where to get MuTMS plugins

GitHub

The source code for all MuTMS plugins is hosted on GitHub at github.com/mutms. Each plugin has its own repository following the standard Moodle plugin naming convention.

Patches for multi-tenancy are in separate patches repository.

You can track changes for each plugin separately via CHANGELOG.md file or rely on overview of changes in the MuTMS releases page.

Packagist

All MuTMS plugin releases are automatically published to Packagist repository to allow installation via Composer.

Release packages for each plugin can be downloaded from its tags page on GitHub, for example moodle-tool_muprog tags.

A note on the Moodle Marketplace

MuTMS is not available in the Moodle Marketplace. Clause 2.1 of the Moodle Marketplace Terms states that Moodle will not list apps that “directly compete with Moodle’s commercial offerings”, and MuTMS has been recognised as directly competing with Moodle Workplace.

This means MuTMS plugins cannot be found or installed by searching from within your Moodle site. Use one of the installation methods below instead.

Installation methods

MuTMS distribution

The mutms/mutms repository is a full Moodle distribution with all MuTMS plugins pre-included. This is the easiest way to get started — no advanced Git skills are required, and Moodle and all plugins are pre-configured together. It is ideal for evaluation or for sites that want to stay up to date with the full suite.

Packages can be downloaded directly from the project release page or cloned using Git, for example:

git clone -b MuTMS_45 https://github.com/mutms/mutms.git

The installation process is exactly the same as normal Moodle installation, see the Moodle documentation for more information.

Upgrade process is also the same as for standard Moodle installations.

Composer seed projects

The MuTMS seed packages are Composer project templates for setting up a new Moodle 5.1.x and later site with MuTMS plugins. Moodle 5.0 and 4.5 do not support installation via Composer.

The seed method is particularly well suited when you want to install only a subset of MuTMS plugins rather than the full suite.

Two seeds are available depending on whether you need multi-tenancy:

mutms/seed — standard Moodle with MuTMS plugins
mutms/seed-mutenancy — Moodle with the multi-tenancy core patch applied

Install into an existing Moodle site without multi-tenancy

If you already have a Moodle site, you can install MuTMS plugins from ZIP packages through the Moodle administration interface. Download the ZIP for each plugin from its tags page on GitHub, then upload it under Site administration ▸ Plugins ▸ Install plugins. For full instructions see Installing plugins in the Moodle documentation.

Because the plugins are not served from the Moodle Marketplace, dependencies are not resolved automatically. Install them in the order given on each plugin’s installation page, starting with the MuTMS library.

Advanced installation via Git with multi-tenancy

Installing multi-tenancy patch and individual plugins via Git is not recommended unless you have detailed Git knowledge and advanced web server management skills.

See Advanced Git installation in the multi-tenancy section.