Sign in Register
  • Examine
    Documentation / Reference / Searching / Examine
    Created: - Last update: November 30, 2022
    Examine Examine uses Lucene as its search and index engine Searching using Examine with Lucene can be powerful and fast What is Examine The Examine documentation is found here httpsshazwazzagithubioExaminehttpsshazwazzagithubioExamine and the source code repository for Examine is here httpsgit…
  • Examine
    Documentation / Reference / Searching / Examine
    Created: - Last update: November 30, 2022
    Examine Examine uses Lucene as its search and index engine Searching using Examine with Lucene can be very powerful and fast What is Examine Examine allows you to index and search data quickly Examine is a library that sits on top of LuceneNethttpslucenenetapacheorg a high performance search e…
  • Examine Management
    Documentation / Reference / Searching / Examine / examine management
    Created: - Last update: November 30, 2022
    Examine Management Provides an overview of the available Examine functionality available directly within the Umbraco backoffice Overview The Umbraco backoffice allows you to view details about your examine indexes and searches along with those that power the internal CMS search all in one plac…
  • Examine Configuration
    Documentation / Reference / Configuration for Umbraco 7 and 8 / ExamineSettings
    Created: - Last update: February 01, 2023
    Examine Configuration This shows all of the configuration options for Examine None of these options are required and if not specified will use the Examine default values xml xml version10 encodingutf8 configuration Define configuration sections configSections section nameExamine typ…
  • Examine Manager
    Documentation / Reference / Searching / Examine / examine manager
    Created: - Last update: November 30, 2022
    Examine Manager The ExamineExamineManager is a singleton object which exposes all of the index and search providers which are registered in the configuration of the application As with all singletons in Umbraco we recommend reviewing the Common Pitfalls AntiPatternsCommonPitfallsindexmd page to…
  • Examine Events
    Documentation / Reference / Searching / Examine / examine events
    Created: - Last update: February 01, 2023
    Examine Events Examine events are ways to modify the data being indexed TransformingIndexValues The TransformingIndexValues event allows you to manipulate the data that will be indexed during an index operation With this event you can add remove or modify the data that is going into the index…
  • Searching
    Documentation / Reference / Searching
    Created: - Last update: November 30, 2022
    Searching Search in Umbraco is powered by Examine out of the box which is a Lucenebased search and index engine for Umbraco Umbraco provides everything required to have powerful and fast search up and running on your website but you can also extend or replace the available configuration to exactl…
  • ExamineIndexconfig
    Documentation / Reference / Configuration for Umbraco 7 and 8 / ExamineIndex
    Created: - Last update: February 01, 2023
    ExamineIndexconfig The ExamineIndexconfig file contains the configuration for the Examine IndexSets used for storing indexed content in an Umbraco installation See ExamineSettingsconfigExamineSettingsindexmd for the details of how to configure the methods for populating and searching an IndexSet…
  • PDF indexes and multisearchers
    Documentation / Reference / Searching / Examine / pdfindex multisearcher
    Created: - Last update: November 30, 2022
    PDF indexes and multisearchers note This document has been verified for Umbraco 8 If you are using Umbraco 9 or later versions please refer to the note on the Examine documentation landing pageindexmd for more details If you want to index PDF files and search for them you will need to use the…
  • Quick start
    Documentation / Reference / Searching / Examine / Quick Start
    Created: - Last update: November 30, 2022
    Quick start This guide will help you get setup quickly using Examine with minimal configuration options Umbraco ships Examine with 2 internal indexes which should not be used for searching when returning results on a public website because it indexes content that has not been published yet It als…
  • Custom indexing
    Documentation / Reference / Searching / Examine / Indexing
    Created: - Last update: November 30, 2022
    Custom indexing note This document has been verified for Umbraco 8 If you are using Umbraco 9 or later versions please refer to the note on the Examine documentation landing pageindexmd for more details Examine has changed a bit in Umbraco 8 and by a bit we mean a lot In Umbraco 7 everything w…
  • Standalone File System
    Documentation / Fundamentals / Setup / Server Setup / Load Balancing / file system replication
    Created: - Last update: November 30, 2022
    Standalone File System note No file replication is configured deployment handles updating files on the different servers If the file system on your servers isnt performing any file replication then no Umbraco configuration file changes are necessary However Media will need to be configured to…
  • Running Umbraco on Azure Web Apps
    Documentation / Fundamentals / Setup / Server Setup
    Created: - Last update: November 30, 2022
    Running Umbraco on Azure Web Apps This section describes best practices with running Umbraco on Azure Web Apps What is Azure Web Apps This has been called a few names in the past many people still know Azure Web Apps as Azure Web Sites App Service is a fully Managed Platform for professional…
  • File Storage on SANNASClustered File ServerNetwork Share
    Documentation / Fundamentals / Setup / Server Setup / Load Balancing
    Created: - Last update: November 30, 2022
    File Storage on SANNASClustered File ServerNetwork Share Documentation about setting up load balanced environments using shared file systems Overview Configuring your servers to work using a centrally located file system that is shared for all of your IIS instances can be tricky and can take a…
  • Flexible load balancing
    Documentation / Fundamentals / Setup / Server Setup / Load Balancing
    Created: - Last update: November 30, 2022
    Flexible load balancing Information on how to deploy Umbraco in a flexible Load Balanced scenario and other details to consider when setting up Umbraco for load balancing Traditional load balancing must be used for Umbraco versions less than 730 Be sure you read the Overviewindexmd before you b…
  • Understanding Umbraco the BootManager
    Documentation / Reference / Events / Understanding Bootmanagers
    Created: - Last update: February 28, 2023
    Understanding Umbraco the BootManager After IIS started the W3 process Umbraco will begin launching There is a bootstrapper for the Umbraco Application which initializes all objects The responsible objects for the startup are the CoreBootManagerhttpsourumbracocomapidocsv7csharpapiUmbracoCoreCor…
  • Configuration Files
    Documentation / Reference / Configuration for Umbraco 7 and 8
    Created: - Last update: February 01, 2023
    Configuration Files The release of V8 has moved many of the previous configuration options from XML configuration files in the usual config folder to be configurable through code The following Configuration Files remain in Umbraco 8 webconfigwebconfig The heart of your web application that h…
  • Configuration Files
    Documentation / Reference / Configuration for Umbraco 7 and 8
    Created: - Last update: December 05, 2022
    Configuration Files This section will explain the many configuration options in Umbraco and what they do webconfigwebconfigindexv7md This file can be found at the following path webconfig 404handlersconfig404handlersindexv7md Configuration file for legacy NotFoundHandlers This file can be fo…
  • Quick start
    Documentation / Reference / Searching / Examine / Quick Start
    Created: - Last update: November 30, 2022
    Quick start This guide will help you get set up quickly using Examine with minimal configuration options Umbraco ships Examine with 3 indexes internal external and members The internal index should not be used for searching when returning results on a public website because it includes content th…
  • Multi version documentation conventions
    Documentation / Contribute / File Naming Conventions
    Created: - Last update: January 31, 2023
    Multi version documentation conventions To support multi version documentation we work according to the conventions you can read about in this article File naming Naming conventions for documentation files The current version of a documentation article will be the normal existing filename for…
  • Working with Record data
    Documentation / Add ons / UmbracoForms / Developer / Working With Data
    Created: - Last update: November 30, 2022
    Working with Record data Umbraco Forms includes some helper methods that return records of a given form which can be used to output records in your templates using Razor Working with records in bulk The methods can be found by injecting the UmbracoFormsCoreServicesIRecordReaderService interfac…
  • CacheRefresher Events
    Documentation / Reference / Events / CacheRefresher Events
    Created: - Last update: January 23, 2023
    CacheRefresher Events Cache refresher events are executed when the Umbraco Cache is updated They can be useful to use in load balanced environments since they fire whenever the cache is updated on each server whereas Content or Media Service events eg ContentServicePublished event are only trigge…
  • Dashboards
    Documentation / Extending / Dashboards
    Created: - Last update: November 30, 2022
    Dashboards Each section of the Umbraco backoffice has its own set of default dashboards The dashboard area of Umbraco is used to display an editor for the selected item in the tree If no item is selected for example when the section first loads then the default set of section dashboards are displ…
  • Searchable Trees ISearchableTree
    Documentation / Extending / Section Trees / Searchable Trees
    Created: - Last update: November 30, 2022
    Searchable Trees ISearchableTree When you type a search term into the Umbraco backoffice search field youll see search results from all the Section Trees that your user account has permissions to access Content Section Dashboardsimagesbackofficesearchv8png The results are grouped by ection Tree…
  • Searchable Trees ISearchableTree
    Documentation / Extending / Section Trees / Searchable Trees
    Created: - Last update: November 30, 2022
    Searchable Trees ISearchableTree When you type a search term into the Umbraco backoffice search field youll see search results from all the Section Trees that your user account has permissions to access Content Section Dashboardsimagesbackofficesearchpng The results are grouped by ection Tree e…
  • Using MVC Child Actions in Umbraco
    Documentation / Reference / Templating / Mvc / child actions
    Created: - Last update: February 01, 2023
    Using MVC Child Actions in Umbraco This section will demonstrate how to use MVC Child Actions when rendering a page in Umbraco What is an MVC Child Action A Child Action in ASPNET MVC is kind of similar to that of a User Control in ASPNET web forms It allows for a controller to execute for a p…
  • What new in Umbraco 8
    Documentation / Fundamentals / New in V8
    Created: - Last update: February 03, 2023
    What new in Umbraco 8 In this article you can learn more about the biggest new features that comes out of the box with Umbraco 8 Video has been made private replace or remove iframe width800 height450 titleWhat new in Umbraco 8 srchttpswwwyoutubecomembedg5qwzmxiWJUrel0 frameborder0 allowautopla…
  • Developers Reference
    Documentation / Reference
    Created: - Last update: November 30, 2022
    Developers Reference Developers Reference primarily consists of API references of the different core Umbraco APIs In many cases the references come with code snippets with examples For a more indepth study of the different APIs consult the usingumbraco and extendingumbraco sections of the documen…
  • Running Umbraco on Azure Web Apps
    Documentation / Fundamentals / Setup / Server Setup / azure web apps
    Created: - Last update: November 30, 2022
    Running Umbraco on Azure Web Apps This section describes best practices with running Umbraco on Azure Web Apps What are Azure Web Apps They have been called a few names in the past many people still know Azure Web Apps as Azure Web Sites App Service is a fully Managed Platform for profession…
  • Developers Reference
    Documentation / Reference
    Created: - Last update: November 30, 2022
    Developers Reference Developers Reference primarily consists of API references of the different core Umbraco APIs In many cases the references come with code snippets with examples For a more indepth study of the different APIs consult the usingumbraco and extendingumbraco sections of the documen…
  • Troubleshooting slow startup
    Documentation / Reference / Events / Troubleshooting Slow Startup
    Created: - Last update: February 28, 2023
    Troubleshooting slow startup Slow startup can occur if No Examine indexes exist Models builder is used in Pure Live modeTemplatingModelsbuilderBuilderModesmdpurelivemodels Depending on the number of models compilation the first time will take some time You can use the other modes DLL AppData o…
  • Webconfig
    Documentation / Reference / Configuration for Umbraco 7 and 8 / webconfig
    Created: - Last update: February 01, 2023
    Webconfig This section defines the appSetting parameters found in the webconfig Explicit settings These are settings that require a value in the appSettings section of the webconfig file UmbracoCoreConfigurationStatus Holds the version number of the currently installed version of Umbraco …
  • Upgrading to version 7
    Documentation / Fundamentals / Setup / Upgrading
    Created: - Last update: November 30, 2022
    Upgrading to version 7 This document should be used as a reference not a step by step guide Upgrading will largely depend on what version of Umbraco you are currently running what packages you have installed and the many aspects of your own Umbraco installation The standard upgrade instructionsh…
  • Common Pitfalls AntiPatterns
    Documentation / Reference / Common Pitfalls
    Created: - Last update: November 30, 2022
    Common Pitfalls AntiPatterns This section is ultra important It will describe many common pitfalls that developers fall in to Some of the antipatterns mentioned here can bring your site to a grinding halt cause memory leaks or make your site unstable or perform poorly Make sure you read this sec…
  • Inversion of Control Dependency injection
    Documentation / Reference / Using Ioc
    Created: - Last update: November 30, 2022
    Inversion of Control Dependency injection Umbraco 80 now supports dependency injection out of the box This means that you no longer have to install an external package such as Autofac in order to register your dependencies Umbraco Composition represents only a minimalist DI abstraction defined…
  • Version specific upgrades
    Documentation / Fundamentals / Setup / Upgrading / version specific
    Created: - Last update: December 05, 2022
    Version specific upgrades This document covers specific upgrade steps if a version requires them most versions do not require specific upgrade steps and most of the time you will be able to upgrade directly from your current version to the latest version Follow the steps in the general upgrade g…
  • UmbracoHelper
    Documentation / Reference / Querying / UmbracoHelper
    Created: - Last update: November 30, 2022
    UmbracoHelper UmbracoHelper is the unified way to work with published contentmedia on your website You can use the UmbracoHelper to querytraverse Umbraco published data UmbracoHelper also has a variety of helper methods that are useful when working in your views and controllers How to referenc…
  • UmbracoHelper
    Documentation / Reference / Querying / UmbracoHelper
    Created: - Last update: November 30, 2022
    UmbracoHelper UmbracoHelper is the unified way to work with published contentmedia on your website Whether you are using MVC or WebForms you will be able to use UmbracoHelper to querytraverse Umbraco published data UmbracoHelper also has a variety of helper methods that are useful when working i…
  • Configuration
    Documentation / Add ons / UmbracoForms / Developer / Configuration
    Created: - Last update: January 11, 2024
    Configuration With Umbraco Forms it possible to customize the functionality with various configuration values Editing configuration values The configuration for Umbraco Forms can be changed by modifying the XML based config file found at AppPluginsUmbracoFormsUmbracoFormsconfig UploadStorageDi…
  • Source Control
    Documentation / Fundamentals / Code / Source Control
    Created: - Last update: November 30, 2022
    Source Control Umbraco Cloud If you are running your site on Umbraco Cloud and why wouldnt you be then source control is very much part of the experience have a look at the Technical overview of an Umbraco Cloud EnvironmentUmbracoCloudGettingStartedEnvironments and the information on Working…
  • UmbracoMapper
    Documentation / Reference / Mapping
    Created: - Last update: November 30, 2022
    UmbracoMapper Often in code there is a need to map one object properties to another type of object and the type of objects are not related by inheritance or interface Think database layer object passing information to a presentation layer ViewModel etc In these circumstances it can save time and…
  • Source Control
    Documentation / Fundamentals / Code / Source Control
    Created: - Last update: February 07, 2023
    Source Control Umbraco Cloud If you are running your site on Umbraco Cloud and why wouldnt you be then source control is very much part of the experience have a look at the Technical overview of an Umbraco Cloud EnvironmenthttpsourumbracocomdocumentationUmbracoCloudGettingStartedEnvironments…