Skip to content
Spesh edited this page Mar 28, 2024 · 15 revisions

Patcher Wiki

Welcome to the Wiki of Patcher, an innovative tool designed for Mac Administrators. Leveraging the Jamf Pro API, Patcher streamlines the process of fetching patch management data and generating comprehensive reports, facilitating efficient tracking and reporting on software update compliance across macOS devices managed through Jamf Pro.

Introduction

Patcher is crafted with the needs of Mac Admins in mind, offering a streamlined approach to the often complex and time-consuming task of patch management. By automating the extraction and formatting of patch data, Patcher not only saves time but also ensures accuracy and consistency in the management of software updates.

Features

  • Real-Time Patch Information Export: Quickly extract up-to-date patch data for analysis.
  • Excel Spreadsheet Integration: Seamlessly export patch information into Excel for in-depth analysis and record-keeping.
  • PDF Reporting: Generate neatly formatted PDFs for easy sharing and documentation of patch statuses.
  • Customization Options: Tailored the tool to meet your specific reporting and analysis needs.
  • Ease of Use: Streamlined setup process with an installer script designed to setup the project properly for you.

Getting Started

Prerequisites

Ensure you have Python 3.9 or higher, Git, and access to a Jamf Pro instance with administrator privileges. It's highly recommended to create a dedicated API client for Patcher use, which requires Read Computers and Read Patch Reporting roles, along with Client ID and Secret. Refer to the Jamf Pro Documentation for more information.

Installation

Follow the steps below to set up Patcher:

  1. Download and run the installer script
bash -c "$(curl -fsSL https://raw.githubusercontent.com/liquidz00/Patcher/main/installer.sh)"
  1. Follow the prompts to configure your Jamf Pro instance details and install dependencies. You'll set up your Jamf Pro URL, Client ID, Secret, and Bearer Token. If you do not have a bearer token readily available, the installer can generate one for you. Customize your report's header and footer, and if desired, choose a custom font.

Usage

To generate reports, run:

python3 patcher.py --path /path/to/output/directory [--pdf]

Specify the output directory with --path and add --pdf or -f if you wish to generate PDF reports alongside Excel files. For additional command options, see the Command Options page.

Customizing Report UI

Post-installation, you can adjust UI elements like header and footer text by editing the ui_config.py file in your project directory. These changes will apply to all future reports.

Authors & Contributions

Patcher is co-authored by Andrew Speciale (@liquidz00) and Chris Ball (@ball42). Contributions are warmly welcomed, whether they are pull requests, bug reports, questions, or suggestions for new features.

Clone this wiki locally