Metadata Server

Description

This is an metadata server implementing the IIIF Presentation API (version 1.0).

Dependencies

This is intended to be a complete and up-to-date list of the project's dependencies; versions in requirements.txt reflect what's currently deployed at Harvard. Use of virtualenv is recommended.

• Web server (Tested with Apache2 and mod_wsgi)
• git
• Elasticsearch
• Libraries (with their associated development packages)
  • bzip2
  • libxml2
  • libxslt
  • openssl
  • sqlite
• Python 2.7
• Python packages (Install with pip)
  • django
  • elasticsearch
  • firebase-token-generator
  • lxml
  • pysqlite
  • python-dotenv

Additionally, sample deployment files for Capistrano and capistrano-django are provided, which depend on:

• Ruby 2.x
• Bundler

These are NOT a requirement for running the app.

Configuration

This application uses python-dotenv to load environment variables from a .env file, which you must provide for the application to run. An example with all possible settings is provided below:

SECRET_KEY=thirtyPlusRandomCharactersUsedToSignSession  # Must be set
ALLOWED_HOSTS=example.com;otherexamplehost.org          # semicolon separated list of hosts
DEBUG=True                                              # Only in development - DO NOT SET IN PRODUCTION
ELASTICSEARCH_URL=localhost:9200                        # omit for default
ELASTICSEARCH_INDEX=manifests                           # omit for default

Refreshing Manifests

A Django manage.py task has been provided to recreate a manifest that is loaded into the system (say, because the parser changed). To use it, run the following from inside the application's virtualenv:

manage.py refresh_manifests $SOURCE(:$IDENTIFIER)

If an $IDENTIFIER isn't provided, it will refresh all manifests of $SOURCE.

This task can be run from a remote host via capistrano, e.g.:

cap $STAGE manage:refresh $SOURCE(:$IDENTIFIER)

Dev Notes

Additional notes of interest to developers located here.

Continuous Integration for K8s

The Continuous Integration Workflow github action in .github/workflows/ci.yml in the IDS-INFRA repo is triggered whenever a new PR is created on the main branch. It will automatically pull down the repo and build a new image of the app using the Dockerfile in the app's repo. Note that this is built using the apache_base image [https://github.huit.harvard.edu/LTS/apache_base]. The base image does not need to be rebuilt in most cases except when apache itself needs to be updated. To do that, pull down the apache_base image from its repo and follow its readme on how to build and publish manually to artifactory. Then redeploy the app images triggering the CI github action.