Skip to content

Commit

Permalink
Updated help files
Browse files Browse the repository at this point in the history
  • Loading branch information
ykuijs committed Apr 3, 2019
1 parent 672e6cb commit 978f0e0
Show file tree
Hide file tree
Showing 5 changed files with 148 additions and 11 deletions.
16 changes: 5 additions & 11 deletions Modules/SharePointDsc/en-US/about_SPInstall.help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -17,17 +17,11 @@
is not supported. For examples to install SharePoint Foundation using DSC, see:
https://github.com/PowerShell/SharePointDsc/wiki/SPInstall (Example 3)

## Installing from network locations

If you wish to install SharePoint from a network location this can
be done, however you must disable User Account Control (UAC) on the server
to allow DSC to run the executable from a remote location, and also set
the PsDscRunAsCredential value to run as an account with local admin
permissions as well as read access to the network location.

It is *not recommended* to disable UAC for security reasons. The recommended
approach is to copy the installation media to the local nodes first and
then execute the installation from there.
NOTE 2:
When files are downloaded from the Internet, a Zone.Identifier alternate data
stream is added to indicate that the file is potentially from an unsafe source.
To use these files, make sure you first unblock them using Unblock-File.
SPInstall will throw an error when it detects the file is blocked.

## Multilingual support

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@
You have to extract this package before installing, using the following command:
.\serverlanguagepack.exe /extract:[Extract Folder]

NOTE:
When files are downloaded from the Internet, a Zone.Identifier alternate data
stream is added to indicate that the file is potentially from an unsafe source.
To use these files, make sure you first unblock them using Unblock-File.
SPInstallLanguagePack will throw an error when it detects the file is blocked.

.PARAMETER BinaryDir
Key - String
The directory that contains all of the SharePoint binaries
Expand Down
4 changes: 4 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPSearchServiceApp.help.txt
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@
Write - boolean
Should this search service application be a cloud based service app

.PARAMETER AlertsEnabled
Write - boolean
Should alerts be enabled for this search service application

.PARAMETER Ensure
Write - string
Allowed values: Present, Absent
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,19 @@
Write - string
Specifies a custom form URL to use for Self Service Site Creation. This is only used when CreateIndividualSite is true. Must be an absolute URL or empty to use built in form (_layouts/_layouts/15/scsignup.aspx)

.PARAMETER ManagedPath
Write - string
Specifies the managed path in which site collections have to be created (SP2019 only)

.PARAMETER AlternateUrl
Write - string
Specifies the URL of the web application in which site collections have to be created (SP2019 only)

.PARAMETER UserExperienceVersion
Write - string
Allowed values: Modern, Classic, Latest
Specifies the if the site collection has to be created as modern or classic site (SP2019 only)

.PARAMETER InstallAccount
Write - String
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5
Expand Down Expand Up @@ -153,3 +166,29 @@
}


.EXAMPLE
This example shows how to configure self-service site creation with a custom form for a web application


Configuration Example
{
param(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)
Import-DscResource -ModuleName SharePointDsc

node localhost {
SPSelfServiceSiteCreation SSC
{
WebAppUrl = "http://example.contoso.local"
Enabled = $true
ManagedPath = "sites"
UserExperienceVersion = "Modern"
PsDscRunAsCredential = $SetupAccount
}
}
}


94 changes: 94 additions & 0 deletions Modules/SharePointDsc/en-US/about_SPSitePropertyBag.help.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
.NAME
SPSitePropertyBag

# Description

**Type:** Distributed
**Requires CredSSP:** No

This resource is used to work with SharePoint Property Bags at the site
collection level. The account that runs this resource (PsDscRunAsCredential
or InstallAccount) must be a site collection administrator.

The default value for the Ensure parameter is Present. When not specifying
this parameter, the property bag is configured.

.PARAMETER Url
Key - string
The URL of the site collection

.PARAMETER Key
Key - string
The key of the SPSite property

.PARAMETER Value
Write - String
Value of the SPSite property

.PARAMETER Ensure
Write - string
Allowed values: Present, Absent
Set to present to ensure the SPSite property exists, or absent to ensure it is removed

.PARAMETER InstallAccount
Write - String
POWERSHELL 4 ONLY: The account to run this resource as, use PsDscRunAsCredential if using PowerShell 5


.EXAMPLE
This example shows how add property bag value in a site collection.


Configuration Example
{
param
(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)

Import-DscResource -ModuleName SharePointDsc

node localhost
{
SPSitePropertyBag Site_APPCodeProperty
{
PsDscRunAsCredential = $SetupAccount
Url = "https://web.contoso.com"
Key = "KeyToAdd"
Value = "ValueToAddOrModify"
Ensure = "Present"
}
}
}


.EXAMPLE
This example shows how remove a property bag value in a site collection.


Configuration Example
{
param
(
[Parameter(Mandatory = $true)]
[PSCredential]
$SetupAccount
)

Import-DscResource -ModuleName SharePointDsc

node localhost
{
SPSitePropertyBag Site_APPCodeProperty
{
PsDscRunAsCredential = $SetupAccount
Url = "https://web.contoso.com"
Key = "KeyToRemove"
Ensure = "Absent"
}
}
}


0 comments on commit 978f0e0

Please sign in to comment.