Skip to content

Commit

Permalink
Minor tweaks, readme, version number
Browse files Browse the repository at this point in the history
  • Loading branch information
Rainer Simon committed Jan 12, 2018
1 parent 2f630c7 commit 19dd578
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 14 deletions.
23 changes: 11 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Recogito 2
# Recogito

[![Project Stats](https://www.openhub.net/p/recogito2/widgets/project_thin_badge.gif)](https://www.openhub.net/p/recogito2)

Home of [Recogito v2.0](http://recogito.pelagios.org) - a Linked Data annotation tool for texts and images, developed by
[Pelagios](http://commons.pelagios.org). Track our progress on
Home of [Recogito](http://recogito.pelagios.org) - a Linked Data annotation tool for texts and
images, developed by [Pelagios](http://commons.pelagios.org). Track our progress on
[Waffle.io](http://waffle.io/pelagios/recogito2).

## Prerequisites

* Java 8 JDK
* [SBT](http://www.scala-sbt.org/) (tested with version 1.0.2)
* PostgreSQL DB
* [SBT](http://www.scala-sbt.org/) (version 1.0.x)
* PostgreSQL DB (tested with version 9.3)
* __Important: as of version 2.2, Recogito requires an installation of
[ElasticSearch v5.6.5](https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-5).
Automatic fallback to an embedded ElasticSearch index is no longer supported.__
* To use image annotation, you need to have the [vips](http://www.vips.ecs.soton.ac.uk/) 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
Expand Down Expand Up @@ -45,20 +48,16 @@ Home of [Recogito v2.0](http://recogito.pelagios.org) - a Linked Data annotation

## Running in production

* To test production mode before deploying, type `sbt testProd`
* 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](https://www.playframework.com/documentation/2.5.x/Production)
docs](https://www.playframework.com/documentation/2.6.x/Production)
* Be sure to set a random application secret in `conf/application.conf`. Play includes a utility
to generate one for you - type `sbt playGenerateSecret`.
* Production deployment requires an installation of
[ElasticSearch v2.4.4](https://www.elastic.co/downloads/past-releases/elasticsearch-2-4-4).
(Recogito will automatically create an embedded ElasticSearch index if cannot find a running
cluster. However we strictly recommend this only for development purposes!).
* 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
Recogito is licensed under the terms of the
[Apache 2.0 license](https://github.com/pelagios/recogito2/blob/master/LICENSE).
2 changes: 1 addition & 1 deletion build.sbt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name := """recogito2"""

version := "1.2"
version := "2.2"

scalaVersion := "2.11.11"

Expand Down
2 changes: 1 addition & 1 deletion conf/db.conf.xml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
</generate>

<target>
<packageName>models.generated</packageName>
<packageName>services.generated</packageName>
<directory>app</directory>
</target>
</generator>
Expand Down

0 comments on commit 19dd578

Please sign in to comment.