Repository files navigation

Current version:v3.3

Home ofRecogito - a Semantic Annotation tool for texts andimages, developed byPelagios Commons.

• Java 8 JDK
• SBT (version 1.0.x)
• node.js (version 10.4.1), along withnpm (version 6.1.0)and thewebpack andwebpack-cli npm packages (install globally vianpm install -g {package-name} )
• PostgreSQL DB (tested with version 9.5)
• ElasticSearch v5.6.5(important: do notuse ES v6.x, since this introduced breaking changes not compatible with the current version of Recogito)
• To use image annotation, you need to have thevips imageprocessing system installed. If vips is not available on the command line, Recogito is set toreject uploaded images as 'unsupported content'. (Note: on Ubuntu, 'libvips-tools' is thepackage you need.)

• Clone this repository
• Create a copy of the fileconf/application.conf.template and name itconf/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, adjustthe settings in yourconf/application.conf accordingly.)
• Typenpm install to download required JS dependencies
• Typesbt run to start the application in development mode.
• Point your browser tohttp://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 thepassword - for production use!
• To generate an Eclipse project, typesbt eclipse.

You can import gazetteers through the administration dashboard.

• Log in with a user that has admin privileges (such as the default 'recogito' user created automatically)
• Point your browser tohttp://localhost:9000/admin/authorities
• ClickAdd Authority File to upload a gazetteer (seeour Wikifor information on supported data formats).

• When running in production youmust define a location where Recogito can store userfiles, using an absolute path. The relevant property in theconf/application.conf file isrecogito.upload.dir.
• To test production mode before deploying, typesbt runProd
• To change to a different port (than default 9000), typesbt "runProd -Dhttp.port=9876"
• For full production deployment, refer to the currentPlay Frameworkdocs
• Be sure to set a random application secret inconf/application.conf. Play includes a utilityto generate one for you - typesbt playGenerateSecret.
• Last but not least: another reminder to remove the default 'recogito' admin user - or at leastchange its password!

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

Recogito was developed predominantely as part of the Pelagios 6 & 7 research projects. Investigativeteam:

• Elton Barker
• Leif Isaksen
• Rebecca Kahn
• Rainer Simon
• Valeria Vitale

Recogito is licensed under the terms of theApache 2.0 license.