source: ndgCommon/trunk/ndg/common/xmldb/setup/eXist/ReadMe.txt @ 5011

Subversion URL: http://proj.badc.rl.ac.uk/svn/ndg/ndgCommon/trunk/ndg/common/xmldb/setup/eXist/ReadMe.txt@5011
Revision 5011, 1.8 KB checked in by cbyrom, 12 years ago (diff)

Add main README.txt documentation to codebase giving an overview of
the complete codebase along with descriptions of the structure and
info on important details. Also extend the setting up eXist and the test documentation.

Line 
1Setting up eXist for use with ndgcommon
2---------------------
3
4Once installed, the eXist DB requires a little fine tuning to get things working
5properly with the ndgcommon codebase.  Details as follows:
6
7Install
8-------------
9i) Get the latest release from http://exist-db.org/download.html - NB, this should be
10at least v1.2.4
11ii) On linux, get the jar file and run using java -jar ....jar; on Windows use the exe
12iii) The install wizard will take you through the main steps and should install
13eXist without a problem
14
15
16Configuration for use with ndgcommon
17-------------
18
19i) Enable atom publishing functionality by editing the server.xml file; find the
20servlet element referring to the AtomServlet and set the 'enabled' attribute to 'yes' - i.e.:
21
22<servlet enabled="yes" 
23         context="/atom/*" 
24         class="org.exist.atom.http.AtomServlet"/>
25         
26ii) To enable eXist to look up external schema references, i.e. beyond the proxies, add
27the following java options to the java command used to launch the server:
28
29-Dhttp.proxyPort=8080 -Dhttp.proxyHost=wwwcache.rl.ac.uk -Dhttp.nonProxyHosts='*.rl.ac.uk|localhost'
30
31NB, typically startup.sh or server.sh are used to start the eXist server and these
32options can be added to the java .... start.jar command featured there.  Alternatively,
33set these options using the JAVA_OPTIONS environment variable.
34
35iii) Memory configuration:
36
37This seems to be the cause of a lot of problems with eXist.  Some tips:
38
39a) The JVM running eXist should be started with a reasonably large max memory size (using -Xmx= option) 1Gb+
40b) Adjust the default settings in conf.xml - to something like:
41
42<db-connection cacheSize="512M" collectionCache="48M" database="native"
43        files="webapp/WEB-INF/data" pageSize="4096">
44       
45- NB cacheSize should be less than half the size of the JVM memory - and preferably
46a third of the size
47       
Note: See TracBrowser for help on using the repository browser.