eremaijala / recordmanager-finna

RecordManager (https://github.com/NatLibFi/RecordManager) with Finna-specific changes.

RecordManager

RecordManager is a metadata record management system intended to be used in conjunction with VuFind. It can also be used as an OAI-PMH repository and a generic metadata management utility.

See the RecordManager wiki for more information and OAI-PMH provider setup.

For a stable version, see the stable branch.

General Installation

• Minimum supported PHP version is 8.0.
• Composer is required for dependencies. Run composer install (or php /path/to/composer.phar install) in the directory where RecordManager is installed.
• The following PHP extensions are required: xml, xslt, mbstring, intl

Database Support

RecordManager can be used with MySQL, MariaDB or MongoDB.

With MongoDB, the minimum supported version is 3.6. The mongodb PECL module, version 1.15.0 or later, is required (see below for examples on installation).

MongoDB is recommended for a large number of records (typically tens of millions), though it may require more system resources than MySQL or MariaDB.

Upgrading

See CHANGELOG.md for information on changes and anything affecting backward-compatibility.

Generally upgrading should be straightforward by replacing the old version with the new one and running composer install (or php /path/to/composer.phar install). With MongoDB you need to manually check that all indexes are present (see dbscripts/mongo.js). With MySQL/MariaDB make sure all tables are present (see dbscripts/mysql.sql).

Installation Notes on CentOS 7

These are quick instructions on how to set up RecordManager. Please refer to the wiki pages for more information on the configuration and setup of RecordManager.

• Required PHP packages: php php-pear php-xml php-xsl php-devel php-mbstring php-intl

  yum install php php-pear php-xml php-devel php-mbstring php-intl
  

• MongoDB support

  RecordManager supports both MongoDB and any MySQL compatible database. You may opt to skip the MongoDB requirements if you only use MySQL.

  • Required pecl modules for MongoDB support: mongodb

    E.g. remi repos include a package for mongodb:

    yum install php81-php-pecl-mongodb

    Webtatic too:

    yum install php81w-pecl-mongodb

    If there's no package available, use pecl to install mongodb:

    yum install gcc make pecl install mongodb

    Either way, make sure it's at least v1.2.0. Earlier versions have problems with pcntl.

  • Add the extension=mongodb.so line to /etc/php.d/mongodb.ini

  • Install MongoDB from 10gen repositories (see http://www.mongodb.org/display/DOCS/CentOS+and+Fedora+Packages)

  • Adjust MongoDB settings as needed

• Copy RecordManager to /usr/local/RecordManager/

• Run composer install to install PHP dependencies. If you did not install the mongodb module above, you can also use composer install --ignore-platform-reqs to force package installation even if the underlying dependencies are missing.

• MongoDB: Create indexes with dbscripts/mongo.js

  mongo recman dbscripts/mongo.js
  

• MySQL: Create tables and indexes with dbscripts/mysql.sql and add a user

  mysql
  create database recman;
  use recman
  source dbscripts/mysql.sql;
  create user 'recman'@'localhost' identified by '<password>';
  grant all on recman.* to 'recman'@'localhost';
  

• Copy conf/recordmanager.ini.sample to conf/recordmanager.ini and modify the settings to suit your needs.

• Copy conf/datasources.ini.sample to conf/datasources.ini and modify the settings to suit your needs.

• Start using the system by executing e.g.

  ./console records:harvest --source=datasource_id
  

  or

  ./console records:import datasource_id filename
  

• Deduplicate the records:

  ./console records:deduplicate
  

• Update Solr index:

  ./console solr:update-index
  

Autocomplete for Commands (BASH only)

See ./console --help completion to see how you can enable autocompletion of commands with bash.

Creating Additional Modules

RecordManager supports modules that can modify and add new functionality. Active modules are specified in conf/modules.config.php. You can copy the provided conf/modules.config.php.sample to conf/modules.config.php and modify it accordingly.

A minimal module ("Sample" in this example) consists of the following file:

src/RecordManager/Sample/Module.php

The file needs to contain a Module class that provides the module configuration:

<?php
namespace RecordManager\Sample;

class Module
{
    public function getConfig()
    {
        return [];
    }
}

This, alone, doesn't really do anything. Please see the Customizing RecordManager wiki page for further information. See also the Finna module for an example of a module that does a number of different things.