Semantic Annotation Without the Pointy Brackets
Clone or download
Latest commit 0b447d2 Oct 21, 2018

README.md

Recogito

Current version: v3.1

Home of Recogito - a Semantic Annotation tool for texts and images, developed by Pelagios Commons. Track our progress on Waffle.io.

Prerequisites

  • Java 8 JDK
  • SBT (version 1.0.x)
  • NEW: as we are introducing React in some UI areas, a number of additional dependencies must be installed. Note that this is not needed for v3.1 yet, only if you build from the current master!
    • node.js (version 4.2.6)
    • npm (version 6.1.0)
    • webpack and webpack-cli packages (via npm)
  • PostgreSQL DB (tested with version 9.5)
  • Important: as of version 2.2, Recogito requires an installation of ElasticSearch v5.6.5. Automatic fallback to an embedded ElasticSearch index is no longer supported.
  • 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 sbt 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 sbt eclipse.

Importing gazetteers

Documentation on how to import gazetteers is on the Wiki.

Running in production

  • To test production mode before deploying, type sbt runProd
  • To change to a different port (than default 9000), type sbt "runProd -Dhttp.port=9876"
  • 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 sbt playGenerateSecret.
  • Last but not least: another reminder to remove the default 'recogito' admin user - or at least change its password!

Contributing to development

If you want to contribute to the development of Recogito, do get in touch with us with your ideas via commons@pelagios.org. Or want to contribute and don't know where to start? The easiest way to get started is by helping out with the translation of the user interface and help resources. Check the Wiki for more information.

License

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