Dev GuideAPI ReferenceUser Guide
HomeDev GuideRecipesAPI Reference
Dev GuideAPI ReferenceUser GuideLegal TermsGitHubNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
Dev Guide
Legal TermsGitHubNuGetDev CommunityOptimizely AcademySubmit a ticket

episerver.packaging

Describes the <episerver.packaging> section of the configuration file for Optimizely Content Management System (CMS) versions 10 and 11.

Suggest Edits

The Configure CMS topic describes the syntax of the configuration elements.

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

<episerver.packaging>

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

<episerver.packaging> element attributes

NameDefault valueDescription
allowPrereleaseVersionsfalseIndicates whether you can install pre-release package versions on-site.
allowUnlistedfalseIndicates whether unlisted packages can be installed on site.
installationModeUIIndicates where to install add-ons. Set to Code to manage add-ons from Visual Studio; also, see Install add-ons.
packageListCacheTime0.0:5:0The length of time that package listings from remote repositories are cached.
packagesTemporaryFolder Uploaded and cached packages are temporarily stored in this location. If no value is configured the system designated temporary directory is used.
protectedPath Indicates the physical path where to install the protected add-ons. The installation sets this value to *Siteroot\modules\_protected*.
protectedVirtualPath Indicates the virtual path where to install protected add-ons. The installation sets this value to ~/<EPiServerProtectedPath>/modules where ~/<EPiServerProtectedPath> equals the protected virtual root path for the Optimizely dashboard and user interface.
publicPath Indicates the physical path where to install public add-ons. The installation sets this value to the physical path _modules subfolder in the site root directory.
publicVirtualPath Indicates the virtual path where to install public add-ons. The installation sets this value to _~/modules and is equal to the virtual root path to public Shell modules.
repositoryPath Indicates where to store installed packages. The installation sets this value to a subpath in the site VPP directory, for example, C:\\EPiServer\\VPP\&lt;SiteName>\\ModulesRepository.

📘

Note

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>

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

<add> element attributes

NameDefault valueDescription
name Required – A unique name identifying this package repository.
url Required – The full URL or path to the package repository.
isEnabledtrueEnables or disables this repository.
apiKey If you have a static API key for accessing this repository, set it here.
filterTag If this is set, only packages with this tag set are included in the listing. (Separate listings based on the same repository URL.)
requestApiKeyfalseEnable this option to request an API key from the repository. (You must enable this element attribute for the default Optimizely repository.)
sendLicensefalseEnable this option to include your Optimizely license information with the API key request. (You must enable this element attribute for the default Optimizely repository.)

Default Optimizely repository

CMS adds the Optimizely central repository feed to the packageRepositories collection implicitly by default. You can remove this default repository using the<clear /> statement.

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

Updated 7 months ago

Next