LibrarySites.Banner

28 Days of Sitecore Rocks: Sitecore Installation

In today's edition of the 28 Days of Sitecore Rocks we will be covering the Sitecore Installation tool.  This tool automates the installation of a Sitecore instance and other tasks associated with setting up a Sitecore web site.  We will also see how to extend the installation tool to automate custom tasks.

To open the Sitecore Installation tool, click the "Sitecore" menu item in the menu bar and under the "Task Lists" menu item click the "Install Sitecore Web Site."

 

Sitecore Rocks

 

With the Sitecore Installation tool open we can see all the tasks that the installation tool can perform.  They are as follows:

 

  • Create Project Folder - Task that creates the project folder.
  • Copy Web Site Files - Task that copies the web site files to the appropriate location specified.
  • Copy Database Files - Task that copies the database files to the appropriate location specified.
  • Copy Data Files - Task that copies the data files to the appropriate location specified.
  • Copy License File - Task that copies the supplied Sitecore license file to the data folder.
  • Set Data Folder in web.config - Task that sets the data folder location in the web.config.
  • Copy DMS - Task that copies the supplied Sitecore DMS files to the appropriate location.
  • Security - Task that sets the file and folder permissions.
  • Attach Databases - Task that attaches the databases in the database folder to the specified SQL Server instance.
  • Modify Connection Strings - Task that modifies the connection strings to the newly created databases.
  • Create IIS Site - Task that creates an application pool and web site in IIS.
  • Add Site to Host File - Task that inserts the new IIS web site in the hosts file.
  • Install Sitecore Rocks - Task that installs Sitecore Rocks.
  • Create Connection - Task that creates a Sitecore Rocks connection.
  • Install Packages - Task that installs the packages specified.
  • Warm Up - Task that makes a request to the web site to start up the system.
  • Open Sitecore - Task that opens the web site in a web browser.

 

All we need to do is supply some basic information and the installation tool will do the heavy lifting.

 

  • Base Folder - The base folder is where all the project files will be installed.
  • Project Name - The name of the project.
  • Project Folder - The path where the project will be created.
  • Web Site Folder - The path where the Web Site will be created.
  • Database Folder - The path where the Database files will be created.
  • Data Folder - The path where the Data folder will be created.
  • Sitecore Zip File - The Sitecore zip file from SDN.
  • License File - The Sitecore license file.
  • DMS Zip File - The Sitecore DMS zip file.
  • SQL Server Instance - The SQL Server instance name.
  • SQL User Name - The SQL Server user name.
  • SQL User Password - The SQL Server password.
  • Packages - Which packages are to be installed.

 

Sitecore Rocks

 

Each task has a pull down menu that lets us change the status of the task from pending, completed or failed.  It also gives us the ability to edit the PowerShell Script associated with the task.

 

Sitecore Rocks

 

Selecting the "Edit File" option from the tasks pull down menu will open the task XML file.  This file contains meta data to display the task in the Installation tool.

 

Sitecore Rocks

 

Selecting the "Edit Script" option from the tasks pull down menu will open the PowerShell script file.  Here we can make any modifications required.

 

Sitecore Rocks

 

We can also add custom tasks to the Installation tool by creating an XML file and PowerShell script in the Sitecore Rocks task lists folder.  This folder is typically located in the following location.

 

C:\Users\[USERNAME]\AppData\Local\Sitecore\Sitecore.Rocks\Repositories\TaskLists\InstallSitecore

 

An easy way to get started with creating custom tasks is to check out the existing tasks and modify as required.

 

The Sitecore Rocks Installation tool is one of my favorite tools for automating the installation of a Sitecore instance.  The Sitecore Rocks Installation tool can be used to get a Sitecore instance running very quickly to test a new module, build a proof of concept or start a new project.

 

Stay tuned for more Sitecore Rocks features tomorrow!
  • I know this is an old post, but what about the newly added task, "Rockify Site"?  I've been searching in vain for any detailed explanation.  It's rare that Google comes back with "no results found".