Client Configuration

Client Configuration

• Client Configuration
  • BaseUrl
  • ReportItems
  • Passphrase
  • scriptTimeOut
  • UseMunkiAdditionalHttpHeaders

MunkiReport reads its configuration info from the "MunkiReport" preferences domain. By default, this info is stored in /Library/Preferences/MunkiReport.plist, but you can also use MCX, configuration profiles, or /private/var/root/Library/Preferences/MunkiReport.plist, or a combination of these locations with the normal defaults precedence:

MCX/Configuration profiles

• /private/var/root/Library/Preferences/ByHost/MunkiReport.XXXXXX.plist
• /private/var/root/Library/Preferences/MunkiReport.plist
• /Library/Preferences/MunkiReport.plist

Check client configuration

Starting with MunkiReport v5.8, running sudo munkireport-runner --show-config will return the current client configuration and where that config item is set.

Below are the supported configuration items:

BaseUrl

BaseUrl tells MunkiReport where to find the MunkiReport server. It contains the full url to the server (and subdirectory) ending in a slash (/).

defaults write /Library/Preferences/MunkiReport BaseUrl 'https://yourserver/munkireport/'

Note: The BaseUrl is set automatically when installing MunkiReport via the command line or a package, See also Client setup.

ReportItems

ReportItems contains a dictionary that tells MunkiReport where to look for the report files. The key is the name of the module, the value contains a path to the appropriate file.

<key>ReportItems</key>
<dict>
    <key>localadmin</key>
    <string>/usr/local/munki/preflight.d/cache/localadmins.txt</string>
    <key>munkiinfo</key>
    <string>/usr/local/munki/preflight.d/cache/munkiinfo.plist</string>
    <key>network</key>
    <string>/usr/local/munki/preflight.d/cache/networkinfo.txt</string>
</dict>

Note: ReportItems are set automatically when installing MunkiReport via the command line or a package, See also Client setup.

Passphrase

If you have the MunkiReport server configured to use passphrases, you need to set these on the client to allow it to report in.

defaults write /Library/Preferences/MunkiReport Passphrase 'mysecretpassphrase'

scriptTimeOut

By default, MunkiReport kills a script if it takes longer than 10 seconds to run. You can override this behavior by adding the scriptTimeOut preference key. The entry should consist of an integer containing the number of seconds that a script can run.

defaults write /Library/Preferences/MunkiReport scriptTimeOut 30

UseMunkiAdditionalHttpHeaders

If the munki repository and MunkiReport are served from the same server, it may be necessary to use the headers set in munki.

defaults write /Library/Preferences/MunkiReport UseMunkiAdditionalHttpHeaders -bool true