Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/islandora/crayfish
A collection of Islandora microservices, lovingly known as Crayfish.
https://github.com/islandora/crayfish
islandora
Last synced: 8 days ago
JSON representation
A collection of Islandora microservices, lovingly known as Crayfish.
- Host: GitHub
- URL: https://github.com/islandora/crayfish
- Owner: Islandora
- License: mit
- Created: 2016-05-12T14:49:21.000Z (over 8 years ago)
- Default Branch: 4.x
- Last Pushed: 2023-12-07T21:17:34.000Z (about 1 year ago)
- Last Synced: 2024-11-18T09:43:21.816Z (about 1 month ago)
- Topics: islandora
- Language: PHP
- Homepage:
- Size: 2.15 MB
- Stars: 9
- Watchers: 35
- Forks: 29
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
#  Crayfish
[](https://php.net/)
[](https://github.com/Islandora/Crayfish/actions)
[](./CONTRIBUTING.md)
[](./LICENSE)
[](https://codecov.io/gh/Islandora/Crayfish)
## Introduction
A collection of Islandora 8 microservices, lovingly known as Crayfish. Some of the microservices are built specifically for use with a Fedora Repository and API-X, while others are just for general use within Islandora 8.
## Requirements
The minimum requirements for any microservice are
* PHP 7.3+
* [Composer](https://getcomposer.org/)
Many microservices have extra installation requirements. Please see the README of each microservice for additional details.
## Services
Crayfish contains the following services
* [CrayFits](./CrayFits): FITS as a microservice.
* [Homarus](./Homarus): FFmpeg as a microservice.
* [Houdini](./Houdini): ImageMagick as a microservice.
* [Hypercube](./Hypercube): Tesseract as a microservice.
* [Milliner](./Milliner): Microservice that converts Drupal entities into Fedora resources.
* [Recast](./Recast): Microservice that remaps Drupal URIs to add Fedora to Fedora links based on associated Drupal URIs in RDF.
See the individual services for more information on their endpoints.
## Security
Crayfish microservices use JWTs to handle authentication like the rest of the Islandora 8.
It is disabled by default. To enable, set `security enabled` to `true` in `cfg/cfg.php` for any microservice.
You can also set the path to an xml configuration file for security a la [Syn][9] with the `security config` parameter.
## Development
If you would like to contribute, please get involved by attending our weekly
[Tech Call][5]. 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][6] or
[Corporate Contributor License Agreement][7]. Please see the
[Contributors][8] pages on Islandora.ca for more information.
We recommend using the [islandora-playbook][10] to get started. If you want to pull down the submodules for development, don't forget to run `git submodule update --init --recursive` after cloning.
## Maintainers
* [Jonathan Green](https://github.com/jonathangreen)
This project has been sponsored by:
* American Philosophical Society
* Born-Digital
* discoverygarden inc.
* LYRASIS
* McMaster University
* PALS
* University of Limerick
* University of Manitoba
* UPEI
* Simon Fraser University
* York University
## License
[MIT](https://opensource.org/licenses/MIT)
[5]: https://github.com/Islandora/documentation/wiki
[6]: http://islandora.ca/sites/default/files/islandora_cla.pdf
[7]: http://islandora.ca/sites/default/files/islandora_ccla.pdf
[8]: http://islandora.ca/resources/contributors
[9]: https://github.com/Islandora/Syn/blob/main/conf/syn-settings.example.xml
[10]: https://github.com/Islandora-Devops/islandora-playbook