About Features Downloads Getting Started Documentation Events Support GitHub

Love VuFind®? Consider becoming a financial supporter. Your support helps build a better VuFind®!

Site Tools

Warning: This page has not been updated in over over a year and may be outdated or deprecated.


:!: This feature was introduced in VuFind 4.0.

VuFind's “channels” interface allows users to explore your collection in a non-linear, multi-dimensional way. It is designed to encourage browsing and serendipity. You have a high degree of control over how channels of content are populated.

Basic Concept

The “channels” interface provides multiple lists of records organized into categories.

There is a channels home page which can be configured to provide interesting content to start an exploration of the collection. Additionally, any user search and any record within VuFind can be used as the seed for a custom page of related channels.

The mechanism that makes this possible is a collection of channel provider classes which take a search or record as input and produce a list of related records as output.


See the channels.ini file for a complete list of channel providers and their configuration options, as well as for comments on how to select which channels are displayed in each possible context.

If you want to display links to related channels, you can turn on the Channels recommendation module in searches.ini (or other backend-specific config files) and/or the Channels related record module in the [Record] section of config.ini.

If you want to make the channels interface the default homepage for your VuFind instance, simply set defaultModule to “Channels” in config.ini.

To build a custom channel provider, see this page for details.

configuration/channels.txt · Last modified: 2020/09/22 14:29 by demiankatz