Skip to content
Jon Crain edited this page May 1, 2020 · 48 revisions

Getting Started

A reporting system for munki.

Features

  • Quick overview of your Mac fleet with a dashboard
  • Get reports on many features (hardware types, disk usage, etc)
  • Lightweight: only sends reports when facts have changed
  • Modular: add your own reporting items without hacking the core
  • Datatables serverside processing: short loading times for tables, no large memory allocations on the client
  • Looks great on high resolution displays
  • Responsive web design (adapts to screen size)

Searching the wiki

To search this wiki use the "Search" field in the GitHub navigation bar above. Then on the search results page select the "Wiki" option or click here.

Details

See the Quick Demo for a walk-through of setting up a functional MunkiReport server. This is a quick and easy way to get started with MunkiReport, and is a recommended starting point for people new to MunkiReport.

Setup

Requirements

Apart from munki clients doing reporting, MunkiReport relies on:

Server side

  • A webserver (runs fine with Apache, IIS and nginx)
  • php version 5.6 or higher with pdo-sqlite3 or pdo-mysql and libxml
  • Starting with MunkiReport version 3, PHP > version 7.0.27 is required.
  • If using MySQL, version 5.7 or higher is recommended.

PHP 7.4 seems to introduce an incompatibility with the kissmvc framework for MunkiReport versions < 5.1.4. It is recommended to not upgrade at this time if you are on an older version, or upgrade past MunkiReport 5.1.4 if you would like to use PHP 7.4.

Client side

A Client running munki and Mac OS X 10.6 and up

Upgrading

If you're coming from an older version of MunkiReport, here's some instructions on how to do a safe upgrade:

Customization

Extend Munkireport

One of the goals of this version of MunkiReport is to make it easier to extend the base install with your own data/widgets. Although there is still a lot of work to be done to make MunkiReport truly customizable, some things are in place to modify things.

Screenshots

Dashboard view

Dashboard view

Reports view

Reports view

Munki list view

Reports view

Clone this wiki locally