Client setup

MunkiReport is versatile in how you are able to add client machines to the reporting server. The manual option is used mostly for testing; the next method is the recommended way to distribute the setup to client machines.

Python 3

NOTE: As of MunkiReport version 5.8.0, released June 19, 2023, Mac Admins Python 3.10 is required to be installed on each client computer for MunkiReport to function properly. For Munki users, this is most easily accomplished by setting your MunkiReport installer package to REQUIRE the Mac Admins Python 3.10 package. This will ensure Mac Admins Python 3.10 gets installed before MunkiReport.

The version 3.10 of Mac Admins Python can be found on this page: https://github.com/macadmins/python/releases/tag/v3.10.11.80742

This change was necessitated by Apple's removal of the included python2 in the macOS 12.3 update, in March 2022.

Rosetta for Apple Silicon

Starting with MunkiReport v5.8, Rosetta 2 is no longer required for MunkiReport.

Manual Install

Note: Use only for testing purposes.

Command Line

The simplest form to install the client scripts is to run the following lines on the client:

sudo /bin/bash -c "$(curl -s 'https://example.com/index.php?/install')"

This will download the installscript with curl and run it with root privileges. The install script will download all additional reporting scripts and configure the client to report back to your munkireport server.

GUI

1. Go to MR install page. (https://example.com/index.php?/install)
2. Copy and paste the install script from the web page. Save as mr_client_install.sh
3. Run it locally. Open Terminal. Type sh and drag and drop the script you've saved.

Generate an Installer Package (pkg)

When the manual test above goes well, you can create an installer package by running the following package:

/bin/bash -c "$(curl 'https://example.com/index.php?/install')" bash -i ~/Desktop

You will end up with a MunkiReport installer package on your desktop (~/Desktop/munkireport-x.x.x.pkg) You can then distribute this package with your favorite distribution mechanism.

Generate an Installer Package with Version Override

If you need to push out a new version to your clients (maybe you changed some client side options in the configuration), but the version of munkireport has not changed, you can override the version using the -v flag:

bash -c "$(curl 'https://example.com/index.php?/install')" bash -v 5.8.0.20230619 -i ~/Desktop

This will result in ~/Desktop/munkireport-5.8.0.20230619.pkg

You can import this package into munki which will pick up the new version number.

AutoPkg

There is also an AutoPkg recipe for creating MunkiReport packages, you can read more on how to setup those on AutoPkg for MunkiReport.

Uninstall MunkiReport

To uninstall MunkiReport, run sudo munkireport-runner --uninstall-munkireport on the client or remove the following files:

# remove the MunkiReport directories
sudo rm -r /usr/local/munkireport/
sudo rm -r /Library/Munkireport/

# remove the munki scripts
sudo rm /usr/local/munki/postflight
sudo rm /usr/local/munki/report_broken_client

# remove prefs
sudo rm /Library/Preferences/MunkiReport.plist

# remove pkgreceipt
sudo pkgutil --forget com.github.munkireport

#unload LaunchDaemon
sudo launchctl unload /Library/LaunchDaemons/com.github.munkireport.runner.plist

#remove LaunchDaemon
sudo rm /Library/LaunchDaemons/com.github.munkireport.runner.plist

Troubleshooting client scripts

Basic troubleshooting for new client setups:

1. Go to MR install page. http://munkireport.your.org/install
2. Copy and paste the install script from the web page. Save as MR-install.sh
3. Run it locally. Open Terminal. Type "sh" and drag and drop the script you've saved.
4. Test.

If that works then make a package maybe if that works. Or make your own with munkipkg or other methods