Skip to content

Document Optional/Get-InstalledApps.ps1 usage in README #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
compuvin wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Document Optional/Get-InstalledApps.ps1 usage in README #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a3cb2c5
Document optional crawler script
compuvin Feb 3, 2026
37d7871
Refine crawler usage docs
compuvin Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 23 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ To install, simply clone the repo and schedule tasks based on the information in


<!-- USAGE EXAMPLES -->
## 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)
Expand All @@ -59,12 +59,21 @@ 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.

<p align="right">(<a href="#readme-top">back to top</a>)</p>
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`.
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.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

### Updating

Expand All @@ -84,9 +93,9 @@ Updating is simple using git:
<p align="right">(<a href="#readme-top">back to top</a>)</p>

<!-- ROADMAP -->
## 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

Expand Down