Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

In the previous step, you defined the location of the VIVO home directory, by specifying vitro.home in the build.properties file. If that directory does not exist, create it now.

Note

What user account owns the VIVO directories?

In many operating systems, the issue of file permissions is important. Who owns the files? Who is authorized to read them, or to write new files?

When running the VIVO build script, it must have permission to read and write to:

  • the VIVO distribution directory
  • the Tomcat webapps directory
  • the VIVO home directory

When VIVO is started under Tomcat, Tomcat must have permission to read and write to:

  • the Tomcat webapps directory
  • the VIVO home directory

There are several ways to make this work. People who are experimenting with VIVO often use their own account to create the VIVO distribution directory, to run the build script, and to run Tomcat.

In more formal environments, it may be necessary to run Tomcat as a service, under its own account. In that case, some people choose to run the build script with root privilege, and then assign the resulting files to Tomcat:

Code Block
sudo ant all
sudo chown -R tomcat /usr/local/vivo/home
sudo chown -R tomcat /usr/local/tomcat/webapps/vivo*

When installing on Microsoft Windows, this is not usually a problem.

 

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

Code Block
ant all

to build VIVO 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 includes several steps:

  • collecting the source files from the distribution directory,
  • compiling the Java source code,
  • running unit tests,
  • preparing the Solr search engine,
  • deploying VIVO and Solr to Tomcat.

Did it work?

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

Panel

BUILD SUCCESSFUL

Total time: 1 minute 49 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.

Panel

BUILD FAILED

Total time: 35 seconds

...

 

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

Code Block
ant all

to build VIVO 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 includes several steps:

  • collecting the source files from the distribution directory,
  • compiling the Java source code,
  • running unit tests,
  • preparing the Solr search engine,
  • deploying VIVO and Solr to Tomcat.

Did it work?

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

Panel

BUILD SUCCESSFUL

Total time: 1 minute 49 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.

Panel

BUILD FAILED

Total time: 35 seconds

The output of the build may include 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. If the output ends with a success message, these warnings may be ignored.

Note

What user account owns the VIVO directories?

In many operating systems, the issue of file permissions is important. Who owns the files? Who is authorized to read them, or to write new files?

When running the VIVO build script, it must have permission to read and write to:

  • the VIVO distribution directory
  • the Tomcat webapps directory
  • the VIVO home directory

When VIVO is started under Tomcat, Tomcat must have permission to read and write to:

  • the Tomcat webapps directory
  • the VIVO home directory

There are several ways to make this work. People who are experimenting with VIVO often use their own account to create the VIVO distribution directory, to run the build script, and to run Tomcat.

In more formal environments, it may be necessary to run Tomcat as a service, under its own account. In that case, some people choose to run the build script with root privilege, and then assign the resulting files to Tomcat:

Code Block
sudo ant all
sudo chown -R tomcat /usr/local/vivo/home
sudo chown -R tomcat /usr/local/tomcat/webapps/vivo*

When installing on Microsoft Windows, this is not usually a problem.

Running VIVO

Configure Tomcat

...