====== Configuration ======

Many features of VuFind can be customized without changing any code.  This page should help guide you through.



===== Background Information =====

The [[configuration:files|list of configuration files]] will provide an overview of available options.

Understanding VuFind's "[[configuration:local_settings_directory|local settings directory]]" and "[[configuration:inheritance|configuration file inheritance]]" concepts will help you manage your configurations.


===== Basic Options =====

Most users should take a look at these configuration options, as they are the most commonly used.

  * [[indexing:alphabetical_heading_browse|Alphabetical Heading Browse]] - How to activate traditional OPAC-style heading browsing.
  * [[configuration:authentication|Authentication]] - Managing authentication options.
  * [[configuration:autocomplete|Autocomplete]] - Provide real-time, context-sensitive suggestions.
  * [[configuration:book_previews|Book Previews]] - Linking to third-party pages that show the inside of books.
  * [[configuration:call_numbers|Call Number Configuration]] - Dealing with Dewey vs. LC call numbers.
  * [[configuration:channels|Channels]] - Allow users to explore your collection in a non-linear way.
  * [[configuration:usage_stats|Collecting Usage Statistics]] - Measuring user behavior.
  * [[configuration:combining_search_types|Combining Search Types]] - Offering results from multiple data sources (Solr, Summon, WorldCat, etc.)
  * [[configuration:third-party_content|Connecting to Third-Party Content]] - Getting VuFind talking to Summon, WorldCat, etc.
  * [[configuration:cookie_consent|Cookie Consent]] - Displaying a cookie consent dialog and settings.
  * [[configuration:course_reserves|Course Reserves]] - Displaying course/instructor-specific reserves.
  * [[development:architecture:user_interface|Customizing the User Interface]]
  * [[configuration:search_customization|Customizing and Tuning Search Options]]
  * [[configuration:facets|Customizing Facets]]
  * [[configuration:dynamic_covers|Dynamic Cover Images]]
  * [[configuration:email_alerts|Email Alerts]] - Notify users of new search results; "selective dissemination of information."
  * [[configuration:ill|Interlibrary Loan]]
  * [[configuration:openurls|OpenURLs]]
  * [[configuration:ils|Real-Time ILS Integration]] - Take full advantage of your existing integrated library system.
  * [[configuration:Record Versions]] - Link together records representing different versions of a work (i.e. FRBR).
  * [[configuration:highlighting|Search Result Highlighting]] - Help explain search results by highlighting matched terms.
  * [[configuration:feedback|Soliciting User Feedback]] - Receive feedback/communication from your users.
  * [[configuration:static_pages|Static Pages]] - Create informational pages within your instance.
  * [[indexing:stop_words_and_synonyms|Stop Words and Synonyms]] - Improve search results by giving certain words special treatment.
  * [[indexing:tracking_record_changes|Tracking Record Changes]] - Special features needed for optimal RSS and OAI-PMH server support.
  * [[configuration:external_content|Use of External Content]] - Cover images, reviews, excerpts, biographies, etc.
  * [[configuration:user_privacy|User Privacy]]


===== Advanced Options =====

This section covers more specialized customizations that are of interest to a smaller group of users but may still be useful.

  * [[configuration:blender|Blended Search]] - How to set up support for blended search results (a single results list for records from multiple diverse source indexes).
  * [[indexing:deduplication|Deduplication]] - How to set up support for deduplicated records.
  * [[configuration:ezproxy|EZproxy Configuration]] - EZproxy settings for external links and EZproxy user authentication.
  * [[configuration:geographic_features|Geographic Features]] - How to set up and configure the geographic search and display interface.
  * [[indexing:hierarchies_and_collections|Hierarchies and Collections]] - How to set up hierarchical document structures in your index.
  * [[indexing:websites|Indexing Websites]] - Using VuFind to index a website.
  * [[configuration:oauth2_oidc|OAuth2 and OpenID Connect (OIDC) Authorization Server]] - Letting users authorize access to other services with OAuth2 / OpenID Connect.
  * [[configuration:record_caching|Record Caching]] - Storing copies of records in the local database for future reference.
  * [[configuration:solr_shards|Using Solr Shards]] - How to combine results from multiple Solr servers.
  * [[configuration:permission_options|Using Permission options]] - Configuring the behavior of pages if a permission has been denied.
  * [[configuration:using_vufind_as_the_site_root|Using VuFind as the Site Root]] - Configuring VuFind to reside at the domain level rather than in a directory.
  * [[configuration:using_vufind_without_solr|Using VuFind without Solr]] - VuFind is most commonly used with a local Solr index, but it can also serve as a front-end for other services.
===== Non-Core Options =====

A few VuFind features are not available in the core distribution but can be merged in using custom [[development:recommended_tools:git|Git]] branches. [[development:git-branches|This page]] provides more details.

See also the [[administration:third-party_add-ons|Third-party Add-ons]] page for notes on using external tools to enhance VuFind.