SPSConfigKit

Description

SPSConfigKit is a PowerShell script tool designed to install and configure a SharePoint Farm with PowerShell Desired Configuration.

Download the latest release, Click here!

Requirements

• Windows PowerShell 5.1 or later (ships with Windows Server 2016 and above).
• A set of DSC modules (ActiveDirectoryDsc, SharePointDsc, SqlServerDsc, OfficeOnlineServerDsc, CertificateDsc, xCredSSP, …). The full list with pinned versions is on the Getting Started wiki page.

Security — credentials are encrypted, plain-text is not supported

SPSConfigKit compiles credentials (service accounts, farm passphrase, PFX passwords) into the MOF for every node, and they must be encrypted with a DSC document-encryption certificate — compiling them in clear text is not a supported configuration. The kit ships everything needed (scripts/init/Initialize-DscEncryption.ps1 generates the certificate and patches every Cfg*.psd1 to forbid plain text) plus a post-compile guard-rail that fails if any credential slipped through in clear text:

.\scripts\test\Invoke-MofEncryptionTest.ps1 -MofPath .\scripts\sps\MOF

See the Securing Credentials wiki page for the full walkthrough, certificate rotation, and troubleshooting.

Note

Only the scripts/Secrets.sample.psd1 template (placeholder passwords) is tracked in git; the real scripts/Secrets.psd1 you fill in is git-ignored. Copy it once with Copy-Item scripts/Secrets.sample.psd1 scripts/Secrets.psd1 before compiling, so your credentials never reach the repository.

Documentation

For detailed usage, configuration, and getting started information, visit the SPSConfigKit Wiki

Changelog

A full list of changes in each version can be found in the change log