From 622862d5f7ec7b5d3f2cbbc5c310b3324b4e825b Mon Sep 17 00:00:00 2001 From: j2blake Date: Wed, 23 Nov 2011 16:04:49 +0000 Subject: [PATCH] NIHVIVO-3278 Add a note to the VIVO and Vitro install docs telling how to set URIencoding to permit searching on international characters. --- doc/install.html | 46 ++++++++++++++++++++++++++++++-------------- doc/upgrade-1.4.html | 7 +++++++ 2 files changed, 39 insertions(+), 14 deletions(-) diff --git a/doc/install.html b/doc/install.html index 4c7d83ce..1255718e 100644 --- a/doc/install.html +++ b/doc/install.html @@ -219,8 +219,7 @@ Compile and deploy
  • - Set Tomcat JVM parameters and - security limits + Configure Tomcat
  • Start Tomcat @@ -765,15 +764,15 @@

    to build VIVO and deploy to Tomcat's webapps directory.

    -

    VI. Set Tomcat JVM parameters and security - limits

    +

    VI. Configure Tomcat

    +

    Set JVM parameters

    - Currently, VIVO copies the contents of your RDF database into + VIVO copies small sections of your RDF database into memory in order to serve Web requests quickly (the in-memory copy and the underlying database are kept in synch as edits are performed).

    - VIVO will require more memory than that allocated to Tomcat by + VIVO may require more memory than that allocated to Tomcat by default. With most installations of Tomcat, the "setenv.sh" or "setenv.bat" file in Tomcat's bin directory is a convenient place to set the memory parameters. If this file does not exist in Tomcat's @@ -781,26 +780,45 @@
    For example:

    - 
                        export CATALINA_OPTS="-Xms2048m -Xmx1024m -XX:MaxPermSize=128m"
    + 
                        export CATALINA_OPTS="-Xms512m -Xmx512m -XX:MaxPermSize=128m"

    - This sets Tomcat to allocate an initial heap of 2048 megabytes, a - maximum heap of 1024 megabytes, and a PermGen space of 128 megs. 1024 - megabytes is a minimum practical heap size for production installations - storing data for large academic institutions, and additional heap space - is preferable. For testing with small sets of data, 256m to 512m should - be sufficient. + This sets Tomcat to allocate an initial heap of 512 megabytes, a + maximum heap of 512 megabytes, and a PermGen space of 128 megs. Lower + values may suffice, especially for small test installations.

    If an OutOfMemoryError is encountered during VIVO execution, it can be remedied by increasing the heap parameters and restarting Tomcat.

    +

    Set security limits

    - Security limits: VIVO is a multithreaded web application that may + VIVO is a multithreaded web application that may require more threads than are permitted under your Linux installation's default configuration. Ensure that your installation can support the required number of threads by making the following edits to /etc/security/limits.conf: 

                        apache	hard	nproc	400
                        tomcat6	hard	nproc	1500
    +

    Set URI encoding

    +

    + In order for Solr to correctly search for international characters (>127), + you must configure Tomcat to conform to the URI standard by + accepting percent-encoded UTF-8. +

    +

    + Edit Tomcat's conf/server.xml and add the following attribute to each of the + Connector elements: URIEncoding="UTF-8". + 

    +                    <Server ...>
+                      <Service ...>
+                        <Connector ... URIEncoding="UTF-8"/>
+                          ...
+                        </Connector>
+                      </Service>
+                    </Server>
+
    +

    +

    +

    VII. Start Tomcat

    Most Tomcat installations can be started by running startup.sh diff --git a/doc/upgrade-1.4.html b/doc/upgrade-1.4.html index 98de8eb3..70540cd1 100644 --- a/doc/upgrade-1.4.html +++ b/doc/upgrade-1.4.html @@ -46,6 +46,13 @@ (jblake) +

    Tomcat configuration

    +
      +
    • Specify URI encoding +
      • + (jblake) +
    +