Metacat

    <div class="toc1"><a href="#Intro">Introduction</a></div> 

      <div class="toc2"><a href="#DifferentOptions">Different Installation Options</a></div> 

      <div class="toc2"><a href="#ThisDoc">Organization Of This Page</a></div>

      <div class="toc2"><a href="#DownloadMetacatBinary">Download Metacat Binary and Get War File</a></div>

      <div class="toc2"><a href="#DownloadMetacatSourceDist">Download Metacat Source Distribution</a></div>

      <div class="toc2"><a href="#DownloadMetacatSourceSVN">Download Metacat Source From SVN</a></div>

      <div class="toc2"><a href="#CreateSourceWar">Create War From Source</a></div>

      <div class="toc2"><a href="#InstallMetacatWar">Install Metacat Binary (War)</a></div>

      <div class="toc2"><a href="#InstallMetacatSource">Install Metacat From Source</a></div>

      <div class="toc2"><a href="#UpgradeMetacatWar">Upgrade Metacat Binary (War)</a></div>

      <div class="toc2"><a href="#UpgradeMetacatSource">Upgrade Metacat From Source</a></div>

<a name="Intro"></a><div class="header1">Introduction</div>

  <a name="DifferentOptions"></a><div class="header2">Different Installation Options</div>

  <p>There are many different options to consider when installing Metacat.  Some of these

  are: </p>

  <ul>

  <li>Operating System - Metacat is a Java servlet application.  As such, you can run

  it on many different operating system.  It has been tested against Linux, MacOS and 

  MicroSoft Windows.  The optimal installation is on Ubuntu Linux.</li>

  <li>Tomcat standalone or in conjunction with Apache web server - The Tomcat server 

  can be run alone as a web server.  However, it is not as robust a server,

  and does't allow for the same level of customization as Apache.  The recommended 

  configuration is Tomcat running in conjunction with Apache</li>

  <li>Binary versus source installation - There are three ways to get and install 

  the Metacat installation.

    <ul>

  	<li>Binary Distribution Installation - download the Metacat war distribution and install it 

  	into the web applications directory</li>

  	<li>Source Distribution Installation - download the source code distribution, build it and 

  	install the resultant war file into the web application directory.</li>

  	<li>Source Checkout Installation - check the source code out from the Subversion 

  	repository, build it and install the resultant war file into the web application directory.</li>

  	</ul>

  The recommended installation procedure is binary distribution installation.</li>

  </ul>

  <p>The administrator will need to decide which combinations of these option are best

  suited to their system</p>

  <a name="ThisDoc"></a><div class="header2">Organization Of This Page</div>

  <p> The first couple of sections on this page deal with quick command line 

  instructions for installing and upgrading Metacat in the optimal environment, which

  is a binary distribution installation with Apache on Ubuntu Linux.</p>

  <p>The remainder of the page deals with more detailed instructions including other 

  installation options.</p>

    <p>Refer to the documentation on <a href="./metacat-configure.html">Metacat Confguration</a>

    <p>Refer to the documentation on <a href="./metacat-configure.html">Metacat Confguration</a>

<a name="DownloadMetacatBinary"></a><div class="header2">Download Metacat Binary and Get War File</div>

<a name="DownloadMetacatSourceDist"></a><div class="header2">Download Metacat Source Distribution</div>	

  <p>To get the Metacat source distribution, browse to the 

      <a href="http://knb.ecoinformatics.org/software/download.html">KNB Software Download Page</a>.

      In the Metacat section, for Linux based systems, select the link that looks like:</p>

	  <div class="code">metacat-src-X.X.X.tar.gz</div>

	  <p>for Windows systems, select the link that looks like:</p>

	  <div class="code">metacat-src-X.X.X.zip</div>

    <p>where X.X.X is the latest version of Metacat.  Choose to save the file locally in the directory 

    where your source should live.</p>

    <p>Extract the Metacat package files on Linux systems by typing:

      <div class="code">tar -xvzf metacat-src-X.X.X.tar.gz</div>

    <p>or, on Windows, use your system unzip utility to extract the zip file.</p>

    <p>Rename the metacat-X.X.X directory to metacat.</p>

    <p>Note that you do not need to create the war file directly with a source installation

    since the Ant build file has an "install" target that will build and deploy the war

    for you.  See the <a href="#InstallingMetacat">Installing Metacat</a> for instructions.</p>

<a name="DownloadMetacatSourceSVN"></a><div class="header2">Download Metacat Source From SVN</div>

  <p>If you are checking out Metacat code from the SVN repository, you will need both 

  Subversion (SVN) and CVS clients installed and configured on your system.  Both are needed

  because, while Metacat has been migrated to SVN, some of its supporting libraries (eml, 

  utilities and seek) have not yet been migrated.  Eventually, SVN will be the only versioning 

  client you will need.  You will need to make sure you have the appropriate accounts on these 

  systems.  You won't have to worry about SVN or CVS if you are installing from a Metacat

  source distribution.  These have all the required dependencies built in.</p>

  <p>If you have not already installed Subversion and you are running Ubuntu/Debian, you can 

  get it by typing:</p>

    <div class="code">sudo apt-get install subversion</div>

  <p>Otherwise, you can get if from <a href="http://subversion.tigris.org">The Subversion homepage</a></p>

  <p>If you have not already installed CVS and you are running Ubuntu/Debian, you can 

  get it by typing:</p>

    <div class="code">sudo apt-get install cvs</div>

  <p>Otherwise, you can get it from <a href="http://ximbiot.com/cvs/wiki/">The Ximbiot CVS homepage</a></p>

  <p>To check out the code from SVN, go to the directory where you would like the code 

    to live and type:</p>

      <div class="code">svn co https://code.ecoinformatics.org/code/metacat/tags/METACAT_&lt;rev&gt; metacat</div>

    <p>Where &lt;rev&gt; is the version of the code you want to check out (like 1_9). </p>

    <p>If you are trying to check out the head, type:</p>

      <div class="code">svn co https://code.ecoinformatics.org/code/metacat/trunk metacat</div>

    <p>You should see a list of files as they check out.</p>

    <p>Note that you do not need to create the war file directly with a source installation

    since the Ant build file has an "install" target that will build and deploy the war

    for you.  See the <a href="#InstallingMetacat">Installing Metacat</a> for instructions.</p>

    <p>(Typically <metacat_base_dir> is '/var/metacat'.)  Remember the directory you 

  <a name="InstallMetacatWar"></a><div class="header2">Install Metacat Binary (War)</div> 

  <a name="InstallMetacatSource"></a><div class="header2">Install Metacat From Source</div> 

    <p>You will need Apache Ant to do the build.  If you have not already 

    installed Ant and you are running Ubuntu/Debian, you can get it by typing:</p>

      <div class="code">sudo apt-get install ant</div>

    <p>Otherwise, you can get ant from

    <a href="http://ant.apache.org/">The Apache Ant homepage</a></p>

    <p>You should now have the Metacat source in a directory named "metacat" in your

    code directory (We will refer to the metacat source directory as <metacat_src_dir>.

    <p>To prepare for the build, edit the file at:</p>

      <div class="code">&lt;metacat_src_dir&gt;/build.properties</div> 

    <p>Make sure that the "build.tomcat.dir" property is set to your tomcat installation

    directory.  For instance:</p>

      <div class="code">build.tomcat.dir=/usr/local/tomcat</div>

    <p>Metacat will use some of the native Tomcat libraries during the build.</p>

    <p>Make sure that the "app.deploy.dir" property is set to your application deployment

    directory.  For instance:</p>

      <div class="code">app.deploy.dir=/usr/local/tomcat/webapps</div>

    <p>If your cvs user is something other than the user your are logged in as, you

    will need to change the ${env.USER} part of the cvsroot property to be your cvs 

    user.  For instance:</p>

      <div class="code">cvsroot=:ext:cvs-user@cvs.ecoinformatics.org:/cvs</div>

    <p> where your cvs user name is "cvs-user"</p> 

    <p>In the &lt;metacat_src_dir&gt;, run: </p>

      <div class="code">ant clean install</div>

    <p>You will see the individual modules get built.  You will be prompted

    for your cvs password several times.  You should see a "BUILD SUCCESSFUL"

    message at the end.</p>

    <p>You should see a new file named knb.war in your application deployment directory.</div>

   <a name="UpgradeMetacatWar"></a><div class="header2">Upgrade Metacat Binary (War)</div> 

  <a name="UpgradeMetacatSource"></a><div class="header2">Upgrade Metacat From Source</div>

    <p>The steps to upgrade Metacat from source are the same as installing from source.  See

    the <a href="#InstallMetacatSource">Install Metacat From Source</a> section above.</p>

  <a href="./metacat-configure.html"> Configuring Metacat Section</a>