diff --git a/doc/install.html b/doc/install.html index c409b190c..cd048e367 100644 --- a/doc/install.html +++ b/doc/install.html @@ -67,7 +67,7 @@

Vitro inside Tomcat

When you run the build script to compile and deploy Vitro - (see installation step VI, below), + (see installation step V, below), the files will be deployed to a directory inside Tomcat. This is the actual executing code for Vitro, but you won’t need to look at it or change it. If you need to change @@ -86,7 +86,7 @@ build.properties file (see installation step IV, below). You must create this directory before starting Vitro, you must create the runtime.properties file in this directory - (see Step V, below), and you + (see Step VI, below), and you must ensure that Tomcat has permission to read and write to this directory when it runs.

@@ -186,10 +186,10 @@ Specify build properties
  • - Specify runtime properties + Compile and deploy
  • - Compile and deploy + Specify runtime properties
  • Configure Tomcat @@ -226,20 +226,19 @@

    @@ -320,8 +319,8 @@

    These properties are used in compilation and deployment. They will be incorporated into Vitro when it is compiled in - Step VI. If you want to change these properties at - a later date, you will need to stop Tomcat, repeat Step VI, + Step V. If you want to change these properties at + a later date, you will need to stop Tomcat, repeat Step V, and restart Tomcat.

    @@ -394,22 +393,64 @@ -

    V. Specify runtime properties

    +

    V. Compile and deploy

    - In Step IV, you defined the location of the Vitro home directory, + In Step IV, you defined the location of the VIVO home directory, by specifying vitro.home in the build.properties file. Create that directory now.

    - In the webapp/config subdirectory of the Vitro distribution, you will find a file called - example.runtime.properties. Copy this to the Vitro home directory you have created, - renaming the copy to runtime.properties. - Edit the file to suit your installation, as described in the following table. + At the command line, change to the webapp directory inside the Vitro distribution + directory. Then type: +

    +
        ant all
    +

    + to build Vitro and deploy to Tomcat's webapps directory. +

    +

    + The build script may run for as much as five minutes, + and creates more than 100 lines of output. + The process comprises several steps: +

    +

    +

    + The output of the build may include a variety of warning messages. + The Java compiler may warn of code that is outdated. + Unit tests may produce warning messages, + and some tests may be ignored if they do not produce consistent results. +

    +
    + BUILD SUCCESSFUL
    Total time: 1 minute 49 seconds +
    +

    + If the output ends with a success message, the build was successful. + Proceed to the next step. +

    +
    + BUILD FAILED
    Total time: 35 seconds +
    +

    + If the output ends with a failure message, the build has failed. + Find the cause of the failure, fix the problem, and run the script again. +

    + +

    VI. Specify runtime properties

    +

    + The build process in Step V created a file called example.runtime.properties + in your Vitro home directory (vitro.home in the build.properties file). + Rename this file to runtime.properties, and + edit the file to suit your installation, as described in the following table.

    These properties are loaded when Vitro starts up. If you want to change these properties at a later date, you will need to restart Tomcat for them to take - effect. You will not need to repeat Step VI. + effect. You will not need to repeat Step V.

    Windows: @@ -800,47 +841,6 @@ -

    VI. Compile and deploy

    -

    - At the command line, change to the webapp directory inside the Vitro distribution - directory. Then type: -

    -
        ant all
    -

    - to build Vitro and deploy to Tomcat's webapps directory. -

    -

    - The build script may run for as much as five minutes, - and creates more than 100 lines of output. - The process comprises several steps: -

    -

    -

    - The output of the build may include a variety of warning messages. - The Java compiler may warn of code that is outdated. - Unit tests may produce warning messages, - and some tests may be ignored if they do not produce consistent results. -

    -
    - BUILD SUCCESSFUL
    Total time: 1 minute 49 seconds -
    -

    - If the output ends with a success message, the build was successful. - Proceed to the next step. -

    -
    - BUILD FAILED
    Total time: 35 seconds -
    -

    - If the output ends with a failure message, the build has failed. - Find the cause of the failure, fix the problem, and run the script again. -

    VII. Configure Tomcat

    Set JVM parameters

    @@ -921,8 +921,8 @@ problem is detected, the normal Vitro pages will redirect to a startup status page describing the problem. You can stop tomcat, attempt to fix the problem and - proceeded from Step VI. The - startup status page may offer a continue link which + proceed from Step V. If the problem is not serious, the + startup status page may offer a continue link which will allow you to use VIVO in spite of the problems.

    diff --git a/webapp/build.xml b/webapp/build.xml index 6b60d1fe4..00f61f423 100644 --- a/webapp/build.xml +++ b/webapp/build.xml @@ -102,6 +102,24 @@ + + + + + + + Tomcat home directory '${tomcat.home}' does not exist. + Check the value of 'tomcat.home' in your build.properties file. + + + + + + + + '${tomcat.home}' does not refer to a valid Tomcat instance: it has no 'webapps' sub-directory. + Check the value of 'tomcat.home' in your build.properties file." +