Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/vufind-org/vufind/llms.txt

Use this file to discover all available pages before exploring further.

VuFind is an open source discovery environment that gives library patrons a single, unified interface to search across your catalog, institutional repositories, and third-party databases. Built on PHP and Apache Solr, VuFind integrates with 30+ integrated library systems and supports multiple external search backends including EDS, Primo, Summon, and WorldCat.

Quick Start

Get VuFind running on your server in minutes with our step-by-step setup guide

Installation

Full installation instructions for Linux, Windows, and package-based deployments

Configuration

Configure search backends, authentication, ILS drivers, and site settings

API Reference

Explore VuFind’s REST API for search, records, and authority data

What VuFind does

VuFind replaces or supplements your library’s OPAC with a modern, faceted search experience. Patrons can search across bibliographic records, find holdings information from your ILS, place holds, manage their accounts, and discover related materials — all from one interface.

30+ ILS Drivers

Connects to Folio, Koha, Sierra, Alma, Voyager, Symphony, and many more

Multiple Search Backends

Solr, EDS, Primo, Summon, WorldCat, LibGuides, and ProQuest FSG

Flexible Authentication

LDAP, Shibboleth, CAS, OpenID Connect, ILS-native, and database auth

Themeable UI

Bootstrap 5 themes with full local override support and mobile-responsive layouts

REST API

Expose search and record data to external applications via a documented REST API

Multi-language

Ships with 40+ translations and a flexible i18n system for custom strings

Get started

1

Install VuFind

Download the latest release and run php install.php to configure your environment. VuFind requires PHP 8.2+ and Apache Solr.
2

Connect your ILS

Edit config/vufind/config.ini to point VuFind at your integrated library system. Choose from 30+ supported drivers in the [Catalog] section.
3

Index your records

Import MARC records using the provided import scripts, or configure OAI-PMH harvesting to keep your index in sync automatically.
4

Customize and deploy

Apply your institution’s branding through the theme system, configure facets and search fields to match your collection, then go live.
VuFind is community-maintained open source software released under the GPL-2.0 license. The source code is available at vufind-org/vufind on GitHub.

Build docs developers (and LLMs) love