Skip to content

Installation

Ole Martin Pettersen edited this page Feb 5, 2018 · 3 revisions

Installation using the installation script

Unpackage the installation zip-package downloaded from releases.

In the installation package you'll find:

  • Install.ps1

Install.ps1

Syntax

Install.ps1 [-Url <String>]
            [-SkipDefaultConfig <switch>]
            [-SkipLoadingBundle <switch>]
            [-GenericCredential <String>]
            [-UseWebLogin <switch>]
            [-CurrentCredentials <switch>]
            [-PSCredentials <String>]
            [-Environment <String>]
            [-Logging <String>]
            [-ProjectPortalReleasePath <String>]

Parameters

Parameter Type Required Description
Url String True URL for the root site.
SkipDefaultConfig switch False Skip deployment of default configuration items. Needed for upgrade scenarios.
SkipLoadingBundle switch False Do you want to handle PnP libraries and PnP PowerShell without using bundled files? If this switch is used, you need to download and install appropriate release of PnP PowerShell yourself. See https://github.com/SharePoint/PnP-PowerShell/releases
GenericCredential String False Specify the name of a generic credential if you've set up one.
UseWebLogin switch False Use Web Login to connect to SharePoint. Useful for e.g. ADFS environments and forms based login.
CurrentCredentials switch False Use the credentials of the current user to connect to SharePoint. Useful e.g. if you install directly from the server.
PSCredentials String False Use a named credential in Windows Credential Manager on your local machine.
Environment string False SharePoint environment. SharePointPnPPowerShell2013, SharePointPnPPowerShell2016 or SharePointPnPPowerShellOnline. Defaults to SharePointPnPPowerShellOnline
Logging String False Values "file", "host" or "none". Default logging to file, alternative log to console or turn off logging.
ProjectPortalReleasePath String False Path to Project Portal release (if you want to install Project Portal aswell)

Examples

Example 1 - Installing to an existing Project Portal site collection

PS:> .\Install.ps1 -Url [URL]

Example 2 - Installing to a blank site collection

PS:> .\Install.ps1 -Url [URL] -ProjectPortalReleasePath [PROJECTPORTAL_RELEASE_PATH]