Current version: v3.3
Home of Recogito - a Semantic Annotation tool for texts and images, developed by Pelagios Commons.
- Java 8 JDK
- SBT (version 1.0.x)
- node.js (version 10.4.1), along with npm (version 6.1.0)
and the
webpack
andwebpack-cli
npm packages (install globally vianpm install -g {package-name}
) - PostgreSQL DB (tested with version 9.5)
- ElasticSearch v5.6.5 (important: do not use ES v6.x, since this introduced breaking changes not compatible with the current version of Recogito)
- 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.)
- Clone this repository
- Create a copy of the file
conf/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, adjust
the settings in your
conf/application.conf
accordingly.) - Type
npm install
to download required JS dependencies - 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
.
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 to http://localhost:9000/admin/authorities
- Click Add Authority File to upload a gazetteer (see our Wiki for information on supported data formats).
- When running in production you must define a location where Recogito can store user
files, using an absolute path. The relevant property in the
conf/application.conf
file isrecogito.upload.dir
. - 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 - typesbt playGenerateSecret
. - Last but not least: another reminder to remove the default 'recogito' admin user - or at least change its password!
If you want to contribute to the development of Recogito, do get in touch with us with your ideas via [email protected]. 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.
Recogito is licensed under the terms of the Apache 2.0 license.