Skip to content

Dashboards

Alex Narvey edited this page Apr 11, 2022 · 10 revisions
Clone this wiki locally

Munkireport [v4.0.0 and up] comes with a default dashboard that can be overridden with a custom layout using a YAML file. You can also add more dashboards with different layouts, names and keyboard shortcuts (hotkey).

To change the default dashboard, simply add a file called default.yml to the local/dashboards directory. You can use the following YAML template as starting point:

display_name: My Awesome Dashboard
hotkey: q
row1:
    client:
    messages:
row2:
    new_clients:
    pending_apple:
    pending_munki:
row3:
    munki:
    disk_report:
    uptime:

Be sure to use 4 spaces (not 2) for indents.

You can use a widget multiple times on a row by explicitly stating the associated widget. This will be useful for (future) widgets that may accept additional data.

row1:
    uptime1: { widget: uptime }
    uptime2: { widget: uptime }
    uptime3: { widget: uptime }

More Dashboards

You can configure as many dashboards as you want! Just name the files some_name.yml and put them in the local/dashboards directory.

Dashboard search paths

If you need to, you can tell MunkiReport to use multiple locations to search for dashboard files:

DASHBOARD_SEARCH_PATHS="/path/to/dashboard/directory1, /path/to/dashboard/directory2"

Alternative Dashboard template [UNTESTED]

If you want a different dashboard template, you can switch it over by setting the DASHBOARD_TEMPLATE environment variable.

Custom Dashboard Resources

https://github.com/kevinmcox/MunkiReport-Dashboards

https://github.com/roodavis/munkireport-dashboards

https://macvfx.blog/2022/04/11/customizing-munkireport-dashboards/