Homarus

Homarus

Introduction

FFmpeg as a microservice.

Installation

• Install ffmpeg. On Ubuntu, this can be done with sudo apt-get install ffmpeg.
• Clone this repository somewhere in your web root (example: /var/www/html/Crayfish/Homarus).
• Copy /var/www/html/Crayfish/Homarus/cfg/config.default.yml to /var/www/html/Crayfish/Homarus/cfg/config.yml
• Copy /var/www/html/Crayfish/Hypercube/syn-settings.xml to /var/www/html/Crayfish/Homarus/syn-settings.xml
• Install composer. [Install instructions here.][4]
• $ cd /path/to/Homarus and run $ composer install
• Then either
  • For production, configure your web server appropriately (e.g. add a VirtualHost for Homarus in Apache) OR
  • For development, run the PHP built-in web server $ php -S localhost:8888 -t src from Homarus root.

Apache2

To use Homarus with Apache you need to configure your Virtualhost with a few options:

• Redirect all requests to the Homarus index.php file
• Make sure Hypercube has access to Authorization headers

Here is an example configuration for Apache 2.4:

Alias "/homarus" "/var/www/html/Crayfish/Homarus/src"
<Directory "/var/www/html/Crayfish/Homarus/src">
  FallbackResource /homarus/index.php
  Require all granted
  DirectoryIndex index.php
  SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1
</Directory>

This will put the Homarus at the /homarus endpoint on the web server.

Configuration

If your ffmpeg installation is not on your path, then you can configure homarus to use a specific executable by editing executable entry in config.yaml.

You also will need to set the fedora base url entry to point to your Fedora installation.

Usage

This will return the an AVI file for the test video file in Fedora.

curl -H "Authorization: Bearer islandora" -H "Accept: video/x-msvideo" -H "Apix-Ldp-Resource:http://localhost:8080/fcrepo/rest/testvideo" http://localhost:8000/homarus/convert --output output.avi

Maintainers

Current maintainers:

• Natkeeran

Development

If you would like to contribute, please get involved by attending our weekly Tech Call. We love to hear from you!

If you would like to contribute code to the project, you need to be covered by an Islandora Foundation Contributor License Agreement or Corporate Contributor License Agreement. Please see the Contributors pages on Islandora.ca for more information.

We recommend using the islandora-playbook to get started.

License

MIT