search

dsccommunity / SharePointDsc

The SharePointDsc PowerShell module provides DSC resources that can be used to deploy and manage a SharePoint farm
MIT License
247 stars 107 forks source link
configuration-as-code desired-state-configuration desiredstateconfiguration devops dsc dsc-resources microsoft powershell sharepoint

readme

SharePointDsc

Build Status Azure DevOps coverage (branch) Azure DevOps tests PowerShell Gallery (with prereleases) PowerShell Gallery

The SharePointDsc PowerShell module (formerly known as xSharePoint) provides DSC resources that can be used to deploy and manage a SharePoint farm.

Please leave comments, feature requests, and bug reports in the issues tab for this module.

Information about this module, new releases and tips/tricks will be shared on the SharePointDsc blog.

Code of Conduct

This project has adopted this Code of Conduct.

Releases

For each merge to the branch master a preview release will be deployed to PowerShell Gallery. Periodically a release version tag will be pushed which will deploy a full release to PowerShell Gallery.

Contributing

If you would like to modify SharePointDsc module, please feel free. Please refer to the Contribution Guidelines for information about style guides, testing and patterns for contributing to DSC resources.

Also check out common DSC Community contributing guidelines.

Installation

To manually install the module, download the source code and unzip the contents of the \Modules\SharePointDsc directory to the $env:ProgramFiles\WindowsPowerShell\Modules folder

To install from the PowerShell gallery using PowerShellGet (in PowerShell 5.0) run the following command:

Find-Module -Name SharePointDsc -Repository PSGallery | Install-Module

To confirm installation, run the below command and ensure you see the SharePoint DSC resoures available:

Get-DscResource -Module SharePointDsc

Requirements

The minimum PowerShell version required is 5.0, available for all currently supported operating systems. The preferred version is PowerShell 5.1, which ships with Windows 10 or Windows Server 2016. This is discussed on the SharePointDsc wiki.

Documentation and examples

For a full list of resources in SharePointDsc and examples on their use, check out the SharePointDsc wiki. You can also review the "examples" directory in the SharePointDSC module for some general use scenarios for all of the resources that are in the module.

Changelog

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