Project

General

Profile

1 4637 daigle
<!--
2
  *   '$RCSfile$'
3
  *     Purpose: web page describing the installation of Metacat
4
  *   Copyright: 2000 Regents of the University of California and the
5
  *               National Center for Ecological Analysis and Synthesis
6
  *     Authors: Chad Berkley
7
  *
8
  *    '$Author: daigle $'
9
  *    '$Date: 2008-11-24 11:57:40 -0800 (Mon, 24 Nov 2008) $'
10
  *    '$Revision: 4621 $'
11
  *
12
  *
13
  -->
14
15
<!DOCTYPE html PUBLIC "-//W3C//DTD html 4.0//EN">
16
<html>
17
18
<head>
19
  <title>Metacat Source Download and Build Instructions</title>
20
  <link rel="stylesheet" type="text/css" href="./common.css">
21
  <link rel="stylesheet" type="text/css" href="./default.css">
22
</head>
23
24
<body>
25
26
<table class="tabledefault" width="100%">
27
<tr><td rowspan="2"><img src="./images/KNBLogo.gif"></td>
28
<td colspan="7">
29
<div class="title">Metacat Source Download and Build Instructions</div>
30
</td>
31
</tr>
32
<tr>
33
  <td><a href="/" class="toollink"> KNB Home </a></td>
34
  <td><a href="/data.html" class="toollink"> Data </a></td>
35
  <td><a href="/people.html" class="toollink"> People </a></td>
36
  <td><a href="/informatics" class="toollink"> Informatics </a></td>
37
  <td><a href="/biodiversity" class="toollink"> Biocomplexity </a></td>
38
  <td><a href="/education" class="toollink"> Education </a></td>
39
  <td><a href="/software" class="toollink"> Software </a></td>
40
</tr>
41
</table>
42
<hr>
43
44
<div class="header1">Table of Contents</div>
45
  <div class="toc">
46
    <div class="toc1"><a href="#Intro">Introduction</a></div>
47
    <div class="toc1"><a href="#GetSource">Get Metacat Source</a></div>
48
      <div class="toc2"><a href="#SourceDistribution">Source Distribution</a></div>
49
      <div class="toc2"><a href="#SVN">SVN Checkout</a></div>
50
    <div class="toc1"><a href="#BuildFromSource">Build From Source</a></div>
51
      <div class="toc2"><a href="#PrepareBuild">Prepare Build</a></div>
52
      <div class="toc2"><a href="#DoAntBuild">Do Ant Build</a></div>
53
  </div>
54
55
<a name="Intro"></a><div class="header1">Introduction</div>
56
  <p>Metacat source can be downloaded either by getting and extracting the
57
  source distribution, or by checking out the code from the repository.</p>
58
59
  <p>Reasons for choosing one versus the other might be:</p>
60
  <ul>
61
  <li>Source Distribution - this is a faster download since the code is compressed.  You
62
  might choose this if you want a stable versioned release, but you prefer to have
63
  all of your applications built on the server where it will run.  (Although it shouldn't
64
  matter where a java application is built.)</li>
65
  <li>SVN Checkout - there are several reasons for choosing a checked out version of
66
  the code.  One is that you may want to build from the head of the code to pick up
67
  new changes that are not yet in a versioned build.  Conversely, you may want to build
68
  off of an older tag, to avoid an issue that was introduced in a build.  Lastly, you
69
  may want to develop and submit code to the Metacat repository</li>
70
  </ul>
71
72
  <p>In order to check out Metacat, you will need both Subversion (SVN) and CVS clients
73
  installed and configured on your system.  This is because, while Metacat has been
74
  migrated to SVN, some of its supporting libraries (eml, utlities and seek) have not
75
  yet been migrated.  Eventually, SVN will be the only versioning client you will need.
76
  You will need to make sure you have the appropriate permissions on these systems</p>
77
78
  <p>For more information on installing SVN and CVS, please visit the following sites:
79
80
  <ul>
81
  <li><a href="http://subversion.tigris.org">The Subversion homepage</a></li>
82
  <li><a href="http://ximbiot.com/cvs/wiki/">The Ximbiot CVS homepage</a></li>
83
  </ul>
84
85
  </p>You will also need Apache Ant to do the build.  If you have not already
86
  installed Ant, you can get it at:
87
88
  <ul>
89
  <li><a href="http://ant.apache.org/">The Apache Ant homepage</a></li>
90
  </ul>
91
92
<a name="GetSource"></a><div class="header1">Get Metacat Source</div>
93
94
  <a name="SourceDistribution"></a><div class="header2">Source Distribution</div>
95
    <p>To get the Metacat source distribution, browse to the
96
      <a href="http://knb.ecoinformatics.org/software/download.html">KNB Software Download Page</a>.
97
      In the Metacat section, for Linux based systems, select the link that looks like:</p>
98
	  <div class="code">metacat-src-X.X.X.tar.gz</div>
99
	  <p>for Windows systems, select the link that looks like:</p>
100
	  <div class="code">metacat-src-X.X.X.zip</div>
101
    <p>where X.X.X is the latest version of Metacat.  Choose to save the file locally in the directory
102
    where your source should live.</p>
103
    <p>Extract the Metacat package files on Linux systems by typing:
104
      <div class="code">tar -xvzf metacat-src-X.X.X.tar.gz</div>
105
    <p>or, on Windows, use your system unzip utility to extract the zip file.</p>
106
    <p>You should see the full Metacat source tree.</p>
107
108
  <a name="SVN"></a><div class="header2">SVN Checkout</div>
109
    <p>To check out the code from SVN, go to the directory where you would like the code
110
    to live and type:</p>
111
      <div class="code">svn co https://code.ecoinformatics.org/code/metacat/tags/METACAT_&lt;rev&gt; metacat</div>
112
    Where &lt;rev&gt; is the version of the code you want to check out (like 1_9). </p>
113
114
    <p>If you are trying to check out the head, type:</p>
115
      <div class="code">svn co https://code.ecoinformatics.org/code/metacat/trunk metacat</div>
116
117
    <p>You should see a list of files as they check out.</p>
118
119
  <a name="BuildFromSource"></a><div class="header1">Build From Source</div>
120
     <p>You should now have the Metacat source in a directory named "metacat" in your
121
     code directory (We will refer to the metacat source directory as &lt;metacat_src_dir&gt;.
122
123
  <a name="PrepareBuild"></a><div class="header2">Prepare Build</div>
124
    <p>Edit the file at:</p>
125
      <div class="code">&lt;metacat_src_dir&gt;/build.properties</div>
126
    <p>Make sure that the "build.tomcat.dir" property is set to your tomcat installation
127
    directory.  For instance:</p>
128
      <div class="code">build.tomcat.dir=/usr/local/tomcat</div>
129
    <p>Metacat will use some of the native Tomcat libraries during the build.</p>
130
131
    <p>If your cvs user is something other than the user your are logged in as, you
132
    will need to change the ${env.USER} part of the cvsroot property to be your cvs
133
    user.  For instance:</p>
134
      <div class="code">cvsroot=:ext:cvs-user@cvs.ecoinformatics.org:/cvs</div>
135
    <p> where your cvs user name is "cvs-user"</p>
136
137
  <a name="DoAntBuild"></a><div class="header2">Do Ant Build</div>
138
    <p>In the &lt;metacat_src_dir&gt;, run: </p>
139
      <div class="code">ant fullclean build-metacat</div>
140
141
    <p>You will see the individual modules get built.  You will be prompted
142
    for your cvs password several times.  You should see a "BUILD SUCCESSFUL"
143
    message at the end.</p>
144
145
    <p>You should see a new file named:</p>
146
      <div class="code">&lt;metacat_src_dir&gt;/dist/knb.war</div>
147
    <p>This file will be used during the
148
      <a href="./metacat-install.html#InstallingMetacat">Metacat Installation</a>.</p>
149
150
  <br>
151
152
</body>
153
</html>