Installing Ingredients

An Ingredient in EPrints is a modular package or extension (such as `image_tiles`) that adds specific functionality to an EPrints repository flavour.

This guide explains how to install an ingredient by cloning its source repository and registering it in your flavour's inclusion configuration file.

Clone the Ingredient Repository

Navigate to your EPrints ingredients directory (`/opt/eprints3/ingredients/`) and clone the git repository.

For example, to install the image_tiles ingredient:

cd /opt/eprints3/ingredients/
git clone https://github.com/eprints/image_tiles

Note: Ensure the resulting destination directory path matches `/opt/eprints3/ingredients/image_tiles`.

Register the Ingredient in the Flavour Include File

To activate the ingredient, you must declare it in your flavour's `inc` configuration file located at:

`/opt/eprints3/flavours/<flavour_name>_lib/inc` the most common flavour name is pub_lib

1. Open the `inc` file in a text editor (e.g., `nano` or `vim`):

   nano /opt/eprints3/flavours/<flavour_name>_lib/inc
   

2. Add the ingredient path line above the site library inclusion line (typically `#site_lib` or `site_lib`):

   ingredients/image_tiles
   

Configuration File Example

Your `inc` file structure should look similar to this:

# Active ingredients
ingredients/image_tiles

# Site core library
site_lib

Step 3: Restart Apache

For EPrints to pick up the changes to the flavour configuration, restart the web server:

sudo systemctl restart apache2