Jeff Wallace
Aug 25, 2010
  9229
(0 votes)

EPiServer CMS - Install a Module From a Compressed File

Based on EPiServer CMS 6

EPiServer has a pretty cool way of allowing its developers to create modules which can easily be installed into a website through the Deployment Center, thus alleviating manual tasks of copying files, compiling projects, updating configs, etc.  Typically this is done by creating it through the Module Installer Project.  When poking around the good ol’ EPiServer World community you may also see references to related module “installers”.  When you download the related file(s) you may find that all you have is a .zip file with no other file inside of it that look like what one might consider a traditional installer.  In comes the Deployment Center option to “Install a Module from a Compressed File”.

Below you will find the steps to install a module from a compressed file…assuming this compressed file was created with this in mind:

1. Open the EPiServer Deployment Center.

2. Select the option to “Install a Module from a Compressed File”.

image

3. Select the “Browse” button and navigate to the relevant file you are trying to install.

image

4. Once you have found the relevant file select the “Open” button on the Browse window

image

Note that you may need to select a drop down on the bottom right hand corner of the Browse window which allows you to choose between a .epimodule or .zip file.

image

5. Select the “Next” button.

image

6. Review the “Install Options” and any other module specific information.

image

7. Select the site that you would like to install the module on followed by the “Next” button.

image

8. Select the “Install” button.

image

9. If all goes well you should see a window indicating that the install has finished.  You can safely close this window and validate that everything has installed as expected.

image

 

Cheers!

Aug 25, 2010

Comments

Sep 21, 2011 04:27 PM

Is there any documentation that describes how to package modules into a compressed file so that they can be installed in this way? Thanks.

Jan 6, 2014 05:05 PM

Hello, how can I uninstall a module, I have installed Auros.EPiSiteMap v1.0.1 EPi6, but now I want to uninstall it!

Please login to comment.
Latest blogs
World on Opti ID

We're excited to announce that world.optimizely.com is now integrated with Opti ID! What does this mean for you? New Users:  You can now log in wit...

Patrick Lam | Jun 22, 2025

Avoid Scandinavian Letters in File Names in Optimizely CMS

Discover how Scandinavian letters in file names can break media in Optimizely CMS—and learn a simple code fix to automatically sanitize uploads for...

Henning Sjørbotten | Jun 19, 2025 |

Exporting Optimizely databases causing errors

Solutions to a couple of recurring issues when migrating databases to the cloud.

Tomas Hensrud Gulla | Jun 18, 2025 |

Common Pitfalls with Search in Optimizely Graph - and How to Avoid Them

Optimizely Graph offers powerful, flexible search capabilities out of the box, making it a popular choice for headless implementations. However, li...

Michał Mitas | Jun 18, 2025