Configuring episerver.packaging (CMS 8)

This is a pseudocode description of the element structure of the <episerver.packaging> configuration section. Refer to the Configuration section for an explanation of the syntax used in the description of the configuration elements.

Each element name below is also a link leading to the detailed information for that element.

<episerver.packaging>
        <packageRepositories/>
</episerver.packaging>

<episerver.packaging>

XML

<episerver.packaging repositoryPath="string"
        publicVirtualPath="string" 
        publicPath="string" 
        protectedVirtualPath="string" 
        protectedPath="string" 
        packagesTemporaryFolder="string"
        packageListCacheTime="TimeSpan"
        allowPrereleaseVersions="bool"
        allowUnlisted="bool"
        installationMode="InstallationMode"
>
    <a href="#packageRepositories"><packageRepositories /></a>
</episerver.packaging>

<episerver.packaging> Element Attributes

Name	Default Value	Description
repositoryPath		Installed packages are stored in this location. During installation this value is set to subpath in site VPP directory, for example C:\EPiServer\VPP\<SiteName>\ModulesRepository
publicVirtualPath		Virtual path where public add-ons are installed. During installation this value is set to ~/modules and is equal to virtual root path to public Shell modules.
publicPath		Physical path where public add-ons should be installed. During installation this value is set to physical path to modules subfolder in the site root directory.
protectedVirtualPath		Virtual path where protected add-ons are installed. During installation this value is set to ~/<EPiServerProtectedPath>/modules where ~/<EPiServerProtectedPath> is equal to protected virtual root path for EPiServer Dashboard and UI.
protectedPath		Physical path where protected add-ons should be installed. This value is set to Siteroot\modules\_protected\ during installation.
packagesTemporaryFolder		Uploaded and cached packages are temporarily stored in this location. If no value is configured the system designated temporary directory is used.
packageListCacheTime	0.0:5:0	The length of time that package listings from remote repositories are cached.
allowPrereleaseVersions	false	Indicates whether pre-release package versions can be installed on site.
allowUnlisted	false	Indicates whether unlisted packages can be installed on site.
installationMode	UI	Indicates where add-ons are installed. Set to Code to manage add-ons from Visual Studio.

Note that virtual path providers should be configured to map virtual paths of public and protected add-ons to corresponding physical paths where public and protected add-ons are installed. By default additional virtual path provider is registered to map virtual and physical paths for protected add-ons.

<packageRepositories>

XML

<packageRepositories>
      <add name="string"
           url="string"
           isEnabled="bool"
           apiKey="string"
           requestApiKey="bool"
           sendLicense="bool"
           filterTag="string" />
      ...
</packageRepositories>

<add> Element Attributes

Name	Default Value	Description
name		*Required*. A unique name identifying this package repository.
url		*Required*. The full URL or path to the package repository.
isEnabled	true	Enables or disables this repository.
apiKey		If you have a static API key for accessing this repository, it should be set here.
requestApiKey	false	If you want to request an API key from the repository this option should be enabled. (This is required for the default EPiServer repository.)
sendLicense	false	Whether your EPiServer license information should be included with the API key request. (This is required for the default EPiServer repository.)
filterTag		If this is set, only packages with this tag set are included in the listing. (This can be used to separate listings based on the same repository url.)

Default EPiServer repository

EPiServer central repository feed is added to the packageRepositories collection implicitly by default. You can remove this default repository repository using clear statement.

XML

<packageRepositories>
      <clear />
      <add name="string" url="string" />
</packageRepositories>