Getting started with Umbraco

This is the general concept of getting started with Solis Search for Umbraco. This assumes you have a Visual Studio solution with an Umbraco website running.

1. Install Solis Search using preferred method below. We recommend Nuget packages for easy updating.
2. Install Apache Solr if not done, then go to your web project into Usercontrols/SolisSearch/Apache Solr to find the schema.xml and solrconfig.xml that is needed to create the core in Apache Solr. Create the core using the Apache Solr admin interface with the provided schema.xml and solrconfig.xml. The schema expects som textfiles for synonyms, stopwords and protwords to exist for enabled languages. Just create empty files in the core folder if required.
3. After the core is created in Apache Solr, goto the config folder in your web project and locate the SolisSearch.config file and update the address attribute in the SolrServer section to point to your newly configured core in Apache Solr.
4. Compile the project and login to the Umbraco backend and you should find the Solis Search tab on the root node of your Content tree in the Content section. There you can see if you're connected to the core and click Rebuild index to test default configuration.
5. If configuration is correct you can now start developing and configure how your properties should be indexed by adding your document types to SolisSearch.config.

Umbraco package installation

1. Download Solis Search Umbraco package from the download page
2. From the developer section in Umbraco, install Local package
3. Add a new index to your Apache Solr installation using the schema.xml and solrconfig.xml from the installation package in UserControls/SolisSearch/Apache Solr. A common setup of stopword files is expected, see Apache Solr section.

Install from NuGet

You can install Solis Search from NuGet directly into your solution. When using Umbraco CMS you need the following pacakges

SolisSearch	Solis Search core library which contains the SearchRepository. The package should also be included in the project where you manage the search logic if that is different from your web project.
SolisSearch.Umbraco	This is the indexer for Umbraco CMS
SolisSearch.Umbraco.Web	The admin gui plugin for Solis Search in Umbraco. It will be visible on the root node in the content section of Umbraco

 

Manual installation

1. Download Solis Search Manual installation distribution package from the download page
2. Copy SolisSearch.dll and SolisSearch.Web.dll to the bin folder, and the SolisSearchControl.ascx to the usercontrols directory of your Umbraco website.
3. Register Solis Search Configuration in the configsections in your web.config and define your SolisSearch section with an external configSource file, in this example the file is placed in the config directory of your Umbraco website:
   

    <configSections>
       <section name="SolisSearch" type="SolisSearch.Configuration.SolisSearchConfigurationSection, SolisSearch"/>
     ...
     </configSections>
     <SolisSearch configSource="config\SolisSearch.config" />

4. Register the path to the SolisSearchControl in dashboard.config in the config folder of your Umbraco in a suitable place for your editors to monitor the Solr index.
   Example dashboard.config with the SolisSearchControl.ascx registered in the StartupDashboardSection:
   

    <section alias="StartupDashboardSection">
       <access>
         <deny>translator</deny>
       </access>
       <areas>
         <area>content</area>
       </areas>
       <tab caption="Get Started">
         <control showOnce="true" addPanel="true" panelCaption="">
           /umbraco/dashboard/startupdashboardintro.ascx
         </control>
         <control showOnce="true" addPanel="true" panelCaption="">
           /umbraco/dashboard/startupdashboardkits.ascx
         </control>
         <control showOnce="true" addPanel="true" panelCaption="">
           /umbraco/dashboard/startupdashboardvideos.ascx
         </control>
       </tab>
       <tab caption="Last Edits">
         <control addPanel="true" MaxRecords="30">/umbraco/dashboard/latestEdits.ascx</control>
       </tab>
       <tab caption="Change Password">
         <control addPanel="true">/umbraco/dashboard/changepassword.ascx</control>
       </tab>
       <tab caption="Solis Search">
         <control addPanel="true">/usercontrols/solissearch/SolisSearchControl.ascx</control>
       </tab>
     </section>

5. Add a new index to your Apache Solr installation using the schema.xml and solrconfig.xml from the installation package in UserControls/SolisSearch/Apache Solr. A common setup of stopword files is expected, see Apache Solr section.