About Features Downloads Getting Started Documentation Events Support GitHub

Site Tools


configuration:local_settings_directory

Local Settings Directory

A key concept of VuFind 2.x and later is the “local settings directory.” This directory should contain all of your customized configuration files. Storing all of your modified settings in one place makes it easier to upgrade VuFind and also allows you to create multiple distinct configurations for a single instance of VuFind.

Although this convention offers power and convenience, it can lead to some confusion. When editing configurations, always be sure you edit the “local” version. You should not modify the default configurations found in the “config/local” subdirectory of your VuFind home directory. Always copy configuration files into your local directory before changing them.

Default Settings Directory

VuFind's distribution includes a default settings directory called “local.” If you accept default settings when running VuFind's installer, this is where all of your configurations will be found. (For example, on most Linux systems, config.ini will be found at /usr/local/vufind/local/config/vufind/config.ini).

Environment Variable

When running command-line scripts, you should make sure that a VUFIND_LOCAL_DIR environment variable is set so that scripts know where to find your local settings. If you fail to set up this environment variable, VuFind may attempt to load default settings instead of using your modified configurations.

Further Reading

See some useful applications of the local directory on the installing multiple instances page.

configuration/local_settings_directory.txt · Last modified: 2015/12/21 11:47 by demiankatz