From 4890b9660b5be200945474b125c3e7d30e21c2b8 Mon Sep 17 00:00:00 2001 From: Andrew Speciale <114184256+liquidz00@users.noreply.github.com> Date: Thu, 7 Mar 2024 16:25:50 -0500 Subject: [PATCH] Updated installation instructions --- README.md | 29 ++++++++++------------------- 1 file changed, 10 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 70ae883..23579c3 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,11 @@ Patcher leverages the Jamf Pro API to fetch patch management data and generate c ### Prerequisites -- Python 3.9 or higher. +> **Note**
+> Although not required, it is **highly recommended** to create an API client for use with Patcher. For more details, reference the [Jamf Pro Documentation](https://learn.jamf.com/bundle/jamf-pro-documentation-current/page/API_Roles_and_Clients.html) on API Roles and Clients. + +- Python 3.9 or higher installed. +- Git installed (via Homebrew or Developer Tools) - Access to a Jamf Pro instance with administrator privileges (for API client creation). - A Jamf Pro API Client with the following: - Read Computers, Read Patch Reporting roles @@ -26,23 +30,15 @@ Patcher leverages the Jamf Pro API to fetch patch management data and generate c - Client Secret - Bearer Token (Optional, installer script can generate one for you) -> **Note**
-> Although not required, it is **highly recommended** to create an API client for use with Patcher. For more details, reference the [Jamf Pro Documentation](https://learn.jamf.com/bundle/jamf-pro-documentation-current/page/API_Roles_and_Clients.html) on API Roles and Clients. - ### Installation -1. **Clone the Repository** +1. **Download the Installer Script** +Instead of cloning the repository, you now simply need to download and run the installer script, which will handle the setup, including cloning the repository. ```shell -git clone https://github.com/liquidz00/patcher.git -cd patcher +curl -sL https://raw.githubusercontent.com/liquidz00/patcher/main/installer.sh | bash ``` -2. **Run the Installer Script** -The installer script will guide you through setting up your Jamf Pro instance details and installing project dependencies. -```shell -chmod +x installer.sh -./installer.sh -``` -Follow the prompts to enter your Jamf Pro URL, Client ID, and Client Secret. If you already have a Bearer Token, you can pass the value to the installer script, otherwise the installer script will generate one for you. You'll also be asked to customize the report header and footer text. Optionally, you can opt to use a custom font instead of the default font [Assistant](https://fonts.google.com/specimen/Assistant). +2. **Follow the Installer Script Prompts** +The installer script will guide you through setting up your Jamf Pro instance details and installing project dependencies. Follow the prompts to enter your Jamf Pro URL, Client ID, and Client Secret. If you already have a Bearer Token, you can pass the value to the installer script, otherwise the installer script will generate one for you. You'll also be asked to customize the report header and footer text. Optionally, you can opt to use a custom font instead of the default font [Assistant](https://fonts.google.com/specimen/Assistant). ### Usage After installation, you can generate reports by running the main script. You can specify the output directory for the reports and choose to generate PDF reports alongside Excel files. @@ -57,8 +53,3 @@ To customize the UI elements like header and footer text after the initial setup ## Authors & Contributions Patcher is co-authored by [Andrew Speciale - @liquidz00](https://github.com/liquidz00) and [Chris Ball - @ball42](https://github.com/ball42). Contributions to Patcher are welcome! Please feel free to submit pull requests or create issues for bugs, questions, or new feature requests. - - - - -