A Linked Data annotation tool for texts and images
Scala JavaScript HTML CSS Other
Latest commit 5d2721f Feb 16, 2017 @rsimon rsimon Minor edit

README.md

Recogito 2

Home of Recogito v2.0 - a Linked Data annotation tool for texts and images, developed by Pelagios. Track our progress on Waffle.io.

Prerequisites

  • Java 8 JDK
  • Play Framework v2.5.0
  • PostgreSQL DB
  • To use image annotation, you need to have the vips image processing system installed. If vips is not available on the command line, Recogito is set to reject uploaded images as 'unsupported content'. (Note: on Ubuntu, 'libvips-tools' is the package you need.)

Installation

  • Clone this repository
  • Create a copy of the file conf/application.conf.template and name it conf/application.conf. Make any environment-specific changes there. (For the most part, the defaults should be fine.)
  • Create a database named 'recogito' on your Postgres DB server. (If you want a different name, adjust the settings in your conf/application.conf accordingly.)
  • Type activator run to start the application in development mode.
  • Point your browser to http://localhost:9000
  • Recogito automatically creates a single user with administrator privileges with username 'recogito' and password 'recogito'. Be sure to remove this user - or at least change the password - for production use!
  • To generate an Eclipse project, type activator eclipse.

Importing gazetteers

Running in production

  • To test production mode before deploying, type activator testProd
  • For full production deployment, refer to the current Play Framework docs
  • Be sure to set a random application secret in conf/application.conf. Play includes a utility to generate one for you - type activator playGenerateSecret.
  • Production deployment requires and ElasticSearch installation. (Recogito will automatically create an embedded ElasticSearch index if cannot find a running cluster. However we strictly recommend this only for development purposes!) For the time being, we recommend to stick to ElasticSearch version 1.7.
  • Last but not least: another reminder to remove the default 'recogito' admin user - or at least change its password!

License

Recogito v2.0 is licensed under the terms of the Apache 2.0 license.