new development branch 'vf_cat_on_tools_crl_edu'

2023-07-06 : vf_cat_on_tools_crl_edu is for putting a copy of @ryan-jacobs work on our public tools server, in order to have a full working instance for development of changes to catalog.crl.edu.

DEVNOTE: create and link the issue, about new links to worldcat.org that might prefill their ILL form.

Below this line is original @ryan-jacobs before 2023-07-06

Center for Research Libraries VuFind®

This is the Center for Research Libraries instance of VuFind®.

About

VuFind® is an open source discovery environment for searching a collection of records. To learn more, visit https://vufind.org.

MAMP Setup

CRL uses MAMP for local development.

MAMP Development Requirements

• MAMP
• Java JDK
• Git
• Globally-installed Composer
• Copy of SQL Database

MAMP Local Development Steps

1. First, git clone this repository.
2. If necessary, adjust MAMP's PHP version based on compatibility with VuFind.
3. Ensure that your command line is using MAMP's PHP. For example:

   PHP_VERSION=`ls /Applications/MAMP/bin/php/ | sort -n | tail -1`
   export PATH="/Applications/MAMP/bin/php/${PHP_VERSION}/bin:$PATH"

4. Edit /Applications/MAMP/bin/php/php7.4.12/conf/php.ini. Uncomment the (last?) line to enable XDebug and add the following contents at the end:

   memory_limit = 2048M
   error_reporting = E_ALL
   display_errors = On
   sendmail_path = "env -i /usr/sbin/sendmail -t -i"    
   date.timezone = "Europe/Helsinki"
   error_log = /Users/[your id]/Library/Logs/php_errors.log

   [opcache]    
   opcache.enable=0

   [XDebug]
   xdebug.remote_enable=true
   xdebug.remote_autostart=true
   xdebug.remote_host=127.0.0.1
   xdebug.remote_port=9000
   xdebug.remote_handler=dbgp
   xdebug.show_exception_trace=0

5. When running install.php be sure to enter a module name of "CRL". This will ensure CRL extensions are loaded.
6. Copy VuFind's local/httpd-vufind.conf.sample to /Applications/MAMP/conf/apache/extra/httpd-vufind.conf
7. Add the following line to the end of /Applications/MAMP/conf/apache/httpd.conf:

   Include /Users/crl/Projects/vufind/local/httpd-vufind.conf

8. Restart MAMP

Environment Startup

composer install
php install.php

Start-up SOLR

./solr.sh start

Navigate to: http://localhost/vufind/Install/Home.

If the installation was successful, you should see an "Auto Configure" screen (pictured below). Some items on the list will be marked "Failed" with "Fix" links next to them. Review each item and follow the prompts.

Auto Configure

• Basic Configuration...OK
• Cache...OK
• Database...OK
• Dependencies...OK
• ILS...Failed [Fix]()
• Solr...OK
• Security... OK

LESS

As of this writing, all VuFind style development is done using LESS.

To compile LESS, ensure grunt is installed and run grunt less

Other notes

• To set up VuFind's database, you will need to have the root password you set when installing MySQL.
• The DB setup creates a new DB and DB user when you provide the root/admin credentials.
• Additional steps are required to establish a dev environment that is capable of running a harvest. For dev environments setup for this purposes note that:
  • A call to local/import/import.sh will do a complete wipe and rebuild of the solr index, which may take multiple days. Use with caution.
  • A call to local/import/incremental.sh will fetch changes since the last import. This can be run frequently.
  • The last import timestamp is saved in local/harvest/crl/last_harvest.txt. This file can be manually manipulated for special needs. For example, running a complete in-place re-harvest (allowing exsiting index data to remain while all records are re-fetched) can be accomplished by setting the date in local/harvest/crl/last_harvest.txt to a time in the very distanct past and running local/import/incremental.sh.