search

TrimarcJake / Locksmith

A small tool built to find and fix common misconfigurations in Active Directory Certificate Services.
https://github.com/TrimarcJake/Locksmith
Other
901 stars 89 forks source link

Add Prerequisites Section to README #147

Closed mrhousz closed 1 week ago

mrhousz commented 4 months ago

Environment:

Windows 10 22H2, July security updates, No RSAT PowerShell 5.1 and PowerShell 7.4.4 Locksmith installed from PS Gallery Invoke-Locksmith script downloaded

Issue:

The prompt to install Active Directory PowerShell module if it is missing only works when running Invoke-Locksmith as a script. image

As a module, Active Directory PowerShell is required to load the module, therefore the functions added in Issue #92 are not available. image

Potential fixes/clarifications:

I was hesitant to open this since I don't really know that there is a 'fix' and the errors given are pretty clear, but it seemed like something that could potentially be confusing and could use some clarification in the documentation.

Add a 'Prerequisites' to the documentation under Installation > Module? Update comment based help to note that functions only available in script mode?

TrimarcJake commented 4 months ago

I agree that this isn't a bug to be fixed but is a failure of documentation. A Prerequisites section would be a nice addition to the README.

Do you want to handle this one after you work through resolving #146?

mrhousz commented 4 months ago

I'd be up for handling this one after resolving #146.

From: Jake Hildreth @.> Sent: Tuesday, July 30, 2024 4:18:33 AM To: TrimarcJake/Locksmith @.> Cc: mrhousz @.>; Author @.> Subject: Re: [TrimarcJake/Locksmith] Active Directory PowerShell module installation prompt only works in script mode (Issue #147)

I agree that this isn't a bug to be fixed but is a failure of documentation. A Prerequisites section would be a nice addition to the README.

Do you want to handle this one after you work through resolving #146https://github.com/TrimarcJake/Locksmith/issues/146?

— Reply to this email directly, view it on GitHubhttps://github.com/TrimarcJake/Locksmith/issues/147#issuecomment-2258108290, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AMLESRYTGE2P6JN5WA4SALTZO5ZATAVCNFSM6AAAAABLVVFPA2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDENJYGEYDQMRZGA. You are receiving this because you authored the thread.Message ID: @.***>

TrimarcJake commented 1 week ago

Ope! Already handled. Sorry, Ray!