Skip to content
tuxudo edited this page Jun 28, 2020 · 2 revisions

Module Marketplace is a feature of MunkiReport 5.5 and higher. It provides you with an overview of installed, available, outdated, and custom modules.

How It Works

Module Marketplace works by comparing installed custom and composer modules against those available through Packagist. Most of this comparison takes place live in the web browser that is viewing the Module Marketplace. You can see this comparison taking place in the first few seconds after you view the Module Marketplace as it fills in information about the modules.

The MunkiReport server reaches out to the munkireport-php and Tuxudo's GitHub for a list of available modules. In the event it cannot get the list(s), it will use the built-in static list that is updated when MunkiReport itself it updated on the server.

Duplicate Modules

You may see duplicate modules in the Module Marketplace. This is normal and can happen for a few reasons. The first is that the module was manually installed and Composer does not know about it. The second is that the module is in two different Packagist repos.

Getting Your Module into Module Marketplace's Available Modules

Module Marketplace's module list of available modules is pulled from the main munkireport-php GitHub and Tuxudo's munkireport-php GitHub. You can request that your module be added to the list by sending a message to Tuxudo or bochoven on GitHub or the MacAdmin's Slack for review and possible inclusion into the list of available modules.

Requirements

Modules must meet the following requirements before it can be included into Module Marketplace's list of available modules.

  • In public GitHub repository
  • Has Packagist entry
  • Uses the latest module design
  • Provides useful data

If you do not have/want a GitHub repository or Packagist entry for your module, contact Tuxudo. They can setup, host, and maintain the module for you or provide you with pointers to meeting the requirements.

Clone this wiki locally