From 3804cf4d7044952cf00fe49d0358fa2ca9148adf Mon Sep 17 00:00:00 2001 From: j2blake Date: Tue, 10 May 2011 18:51:41 +0000 Subject: [PATCH] NIHVIVO-2429 Add some overview for novice installers, and make minor corrections. --- doc/developers.txt | 4 +-- doc/install.html | 75 +++++++++++++++++++++++++++++++++++++++++----- 2 files changed, 69 insertions(+), 10 deletions(-) diff --git a/doc/developers.txt b/doc/developers.txt index 72df76ea..3fd9a3d3 100644 --- a/doc/developers.txt +++ b/doc/developers.txt @@ -6,7 +6,7 @@ Instructions for VIVO developers ------------------------------------------------------------------------------- If you are working from the VIVO distribution files, you should follow the -instructions in "install.txt", in this directory. +instructions in "install.html", in this directory. ------------------------------------------------------------------------------- @@ -25,7 +25,7 @@ Follow these steps: the Vitro working area (created in step 2). For example: vitro.core.dir = ../vitro - 4) Follow the instructions in "install.txt" to complete the installation, + 4) Follow the instructions in "install.html" to complete the installation, omitting step III. ------------------------------------------------------------------------------- diff --git a/doc/install.html b/doc/install.html index 40e1df51..206382bd 100644 --- a/doc/install.html +++ b/doc/install.html @@ -88,14 +88,15 @@

@@ -103,6 +104,58 @@ Subversion, the instructions are slightly different. Please consult developers.txt in this directory.

+

Where does VIVO live on your computer?

+

+ Before beginning the installation, let's look at the four locations + on your computer that will hold VIVO. +

+

The VIVO distribution directory

+

+ This is created when you unpack the VIVO distribution file + (see Step III, below). + This is where you will create your deploy.properties file + (see Step V, below), + and where you will make any modifications to the VIVO theme or code. + You can create this wherever you choose. +

+

VIVO inside Tomcat

+

+ When you run the build script to compile and deploy VIVO + (see Step VI, below), + the files will be deployed to a directory inside Tomcat. + This is the actual executing code for VIVO, + but you won’t need to look at it or change it. + If you need to change VIVO, + make the changes in the distribution directory, + and run the build script again. + Tell the build script where to find Tomcat by setting + tomcat.home in the deploy.properties file + (see Step V, below). +

+

The VIVO home directory

+

+ VIVO will use this area to store some of the data it uses. + Uploaded image files are stored here, + and the search index is stored here also. + You can create this wherever you choose. + Tell VIVO where to find the home directory by setting + vitro.home.directory in the deploy.properties file + (see Step V, below). + You must create this directory before starting VIVO, + and you must ensure that Tomcat has permission to read and write + to this directory when it runs. +

+

The MySQL database

+

+ Essentially all of the data that you store in VIVO will be + given to MySQL for storage. + The actual location of this data depends on what system you have, + and on how you install MySQL + (see Step I, below). + but you won’t need to know the location. + You will access the data through VIVO, + or occasionally through the MySQL client application. +

Steps to Installation

    @@ -164,7 +217,7 @@ (Not OpenJDK)
  1. - Apache Tomcat 6.x or higher, http://tomcat.apache.org + Apache Tomcat 6.x, http://tomcat.apache.org
  2. Apache Ant 1.7 or higher, http://ant.apache.org @@ -186,6 +239,9 @@ versions may result in strange error messages related to table formatting or other unexpected problems.

    +

    + * Note that VIVO is not yet compatible with Tomcat 7. +

    II. Create an empty MySQL database

    Decide on a database name, username, and password. Log into your @@ -244,7 +300,8 @@

    V. Specify deployment properties

    - At the top level of the unpacked distribution, copy the file example.deploy.properties + At the top level of the VIVO distribution directory, + copy the file example.deploy.properties to a file named simply deploy.properties. This file sets several properties used in compilation and deployment.

    @@ -596,8 +653,8 @@

    VI. Compile and deploy

    - At the command line, from the top level of the unpacked - distribution directory, type: + At the command line, + from the top level of the VIVO distribution directory, type: 

                    ant all

    @@ -615,6 +672,8 @@ 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 bin directory, + you can create it.
    For example:

    @@ -645,8 +704,8 @@ in Tomcat's bin directory. Point your browser to "http://localhost:8080/vivo/" to test the application. If Tomcat does not start up, or the VIVO application is not visible, check - the catalina.out - file in Tomcat's logs directory. + the files in Tomcat's logs directory. Error messages are commonly + found in catalina.out or localhost.log

    IX. Log in and add RDF data