source: DASISH/t5.6/backend/annotator-backend/trunk/annotator-backend/INSTALL.txt @ 4217

DASISH annotator back-end installation 
------------------------------------

Contents:
- Requirements
- Installation and configuration 
-- placing war-file and ds#webannotator.xml
-- The fragment to be present in Tomcat's context.xml 
-- The fragment to be present in Tomcat's web.xml 
- Testing 


= Requirements =

* annotator-backend-XXX-mpi-deploy.tar.gz package 
* Tomcat >=6
* PostgreSQL >=9.2.4 database for keeping annotations



= Installation and configuration   =
=========================================================================================
== Placing war-file and ds#webannotator.xml at the tomcat's conf/Catalina/localhost ==

You must deploy the annotator's .war file to the tomcat-webuser. Make a directory for the 
application, like e.g. lat/webapps/dasish-web-annotator on lux16,  and deploy .war there following
the standard TLA procedure.

Then the corresponding ds#webannotator.xml looks as follows: 

<?xml version='1.0' encoding='utf-8'?>
<Context path="/ds/webannotator"
  docBase="/lat/webapps/dasish-web-annotator/current"
  debug="0" reloadable="true" crossContext="true">
</Context>


=============================================================================================
== context.xml ===

The file must contain the fragment for the database, like e.g.on lux16:

         <Resource
                 name="jdbc/DASISHAnnotator"
                 auth="Container"
                 type="javax.sql.DataSource"
                 driverClassName="org.postgresql.Driver"
                 url="jdbc:postgresql://localhost/dasish"                
                 username="XXXXXXX"  
                 password="YYYYYYY"  
                 maxActive="20"
                 maxIdle="5"    
                 maxWait="4000" />


=============================================================================================
== web.xml ===

So far no parameters to be placed in the "global" web.xml 


=============================================================================================

= Testing  =

If the application is succesfully deployed, you will get the jsp page after requesting

<server uri>/ds/webannotator

Note that the path "ds/webannotator" is the same as mentioned in  ds#webannotator.xml above.

On this web-page there is a number of test GET requests there which you can send if you want 
to check if it works. For this you will need a login and a password. Ask the dasish backend's 
responsible developer (Olha). 

If you want to test POST, PUT and DELETE requests use e.g.

-- chrome REST console, see
https://chrome.google.com/webstore/detail/rest-console/cokgbflfommojglbmbpenpphppikmonn

-- or a FireFox add-on "Rest client", 
see https://addons.mozilla.org/nl/firefox/addon/restclient/

NOTE that POST and PUT 

For Posting/Putting files of cached representations use curl, e.g. 

curl -u <user>:<password> -H "Content-Type: multipart/mixed" -F 
"metadata=@cachedInfoToAdd.xml; type=application/xml " -F "content=@artnouveauspain.png; 
type=image/png" -X POST 
http://localhost:8080/annotator-backend/api/targets/00000000-0000-0000-0000-000000000033/fragment/"(1,1)"/cached -i -v