From a3cb2c5bd1c6cb56a3c51328757a6946b3a5cee7 Mon Sep 17 00:00:00 2001 From: compuvin Date: Tue, 3 Feb 2026 14:14:43 -0500 Subject: [PATCH 1/2] Document optional crawler script --- README.md | 27 ++++++++++++++++----------- 1 file changed, 16 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index fba9e94..571a7df 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,11 @@ To install, simply clone the repo and schedule tasks based on the information in -## Usage - -Scripts and their usage: - -IngestCSV.vbs: +## Usage + +Scripts and their usage: + +IngestCSV.vbs: This is the main script. Frequency should be daily. Pulls in a CSV file in the format (Workstation, Application, Publisher, Version) from any software collection source (we use PDQ - www.pdq.com.) Checks any new software to see if it is FOSS using two websites (www.openhub.net and www.chocolatey.org) @@ -59,12 +59,17 @@ Compares count to licenses table. Right now data needs to be entered to that tab Creates email report if any applications are over subscribed. Creates email report on top 10 highest risk software based on vulnerabilities within last year. -EnterAppDetails.vbs: -Run as needed. -Allows the admin user to quickly answer questions about newly found applications (from the Security Report) to get all of the columns filled in for the application. -This has been replaced with the web GUI but can still be used. - -

(back to top)

+EnterAppDetails.vbs: +Run as needed. +Allows the admin user to quickly answer questions about newly found applications (from the Security Report) to get all of the columns filled in for the application. +This has been replaced with the web GUI but can still be used. + +Optional/Get-InstalledApps.ps1: +Optional software crawler for small deployments. Run locally (or via scheduled task) on each workstation to collect installed applications and write them to the `smcrawler` table in MySQL. +Requires the MySQL .NET connector and access to `smapp.ini` for database credentials. The script will attempt to locate `smapp.ini` in the parent folder if it is run from the `Optional` directory. +Use this when you do not have a separate inventory source (e.g., PDQ) to generate the CSV for `IngestCSV.vbs`. + +

(back to top)

### Updating From 37d787197235e5025ef2e6d88a47f2dcc8532968 Mon Sep 17 00:00:00 2001 From: compuvin Date: Tue, 3 Feb 2026 14:19:11 -0500 Subject: [PATCH 2/2] Refine crawler usage docs --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 571a7df..446f900 100644 --- a/README.md +++ b/README.md @@ -68,6 +68,10 @@ Optional/Get-InstalledApps.ps1: Optional software crawler for small deployments. Run locally (or via scheduled task) on each workstation to collect installed applications and write them to the `smcrawler` table in MySQL. Requires the MySQL .NET connector and access to `smapp.ini` for database credentials. The script will attempt to locate `smapp.ini` in the parent folder if it is run from the `Optional` directory. Use this when you do not have a separate inventory source (e.g., PDQ) to generate the CSV for `IngestCSV.vbs`. +Quick start: +1. Ensure the MySQL .NET connector is installed on the workstation. +2. Copy `smapp.ini` from the main install directory (or create it) and confirm the `[Database]` settings. +3. Run `Optional/Get-InstalledApps.ps1` locally or schedule it to run daily on each workstation.

(back to top)

@@ -89,9 +93,9 @@ Updating is simple using git:

(back to top)

-## Roadmap - -- [ ] Create a software crawler or agent for small deployments +## Roadmap + +- [x] Create a software crawler or agent for small deployments (see `Optional/Get-InstalledApps.ps1`) - [ ] Better code documentation - [ ] Create and Integrate WhatTheFOSS list