Project

General

Profile

1
<!-- 
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-12-03 08:56:36 -0800 (Wed, 03 Dec 2008) $'
10
  *    '$Revision: 4646 $'
11
  *
12
  *
13
  -->
14
  
15
<!DOCTYPE html PUBLIC "-//W3C//DTD html 4.0//EN">
16
<html>
17

    
18
<head>
19
  <title>Metacat Installation 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 UNIX Installation 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="#QuickInstructions">Quick Instructions</a></div>
47
      <div class="toc2"><a href="#QuickInstall">Quick Installation</a></div> 
48
      <div class="toc2"><a href="#QuickUpdate">Quick Update</a></div>
49
    <div class="toc1"><a href="#PreInstallation">Pre-Installation</a></div>
50
      <div class="toc2"><a href="#MinRequirements">Minimum Requirements</a></div> 
51
      <div class="toc2"><a href="#AdditionalRequiredSoftware">Additional Required Software</a></div>
52
    <div class="toc1"><a href="#AdditionalSoftwareSetup">Additional Software Setup</a></div>
53
      <div class="toc2"><a href="#AdditionalSoftwareJava">Java</a></div> 
54
      <div class="toc2"><a href="#AdditionalSoftwareOracle">Oracle</a></div>
55
      <div class="toc2"><a href="#AdditionalSoftwarePostgres">PostgreSQL</a></div>
56
      <div class="toc2"><a href="#AdditionalSoftwareAnt">Ant</a></div>
57
      <div class="toc2"><a href="#AdditionalSoftwareTomcat">Tomcat</a></div>
58
    <div class="toc1"><a href="#DownloadingMetacat">Download Metacat and Get War File</a></div>
59
      <div class="toc2"><a href="#DownloadMetacatBinary">Download Metacat Binary and Create War File</a></div>
60
      <div class="toc2"><a href="#DownloadMetacatSource">Download Metacat Source and Create War File</a></div>
61
    <div class="toc1"><a href="#InstallingMetacat">Installing Metacat</a></div>
62
      <div class="toc2"><a href="#CreateMetacatDirs">Create Metacat Directories</a></div>
63
      <div class="toc2"><a href="#InstallMetacatWar">Install Metacat War</a></div>
64
    <div class="toc1"><a href="#UpgradingMetacat">Upgrading Existing Metacat</a></div>
65
      <div class="toc2"><a href="#UpgradeStopMetacat">Stop the Running Metacat</a></div>
66
      <div class="toc2"><a href="#UpgradeDownloadMetacat">Download Latest Metacat Application</a></div>
67
      <div class="toc2"><a href="#UpgradeMetacatWar">Upgrade Metacat War</a></div>
68
   <div class="toc1"><a href="#RestartTomcat">Restart Tomcat</a></div>
69
      <div class="toc2"><a href="#UpgradeTroubleshooting">Troubleshooting</a></div>
70
      <div class="toc2"><a href="#UpgradeConfigureMetacat">Configure Metacat</a></div>       
71
    <div class="toc1"><a href="#Registry">Web Based Registry</a></div>
72
<!--
73
    <div class="toc1"><a href="#VersionNotes">Version Installation Notes</a></div>
74
      <div class="toc2"><a href="#1_9InstallNotes">1.9 Installation Notes</a></div> 
75
-->
76
  </div> 
77

    
78
<a name="QuickInstructions"></a><div class="header1">Quick Instructions</div>
79

    
80
  <a name="QuickInstall"></a><div class="header2">Quick Installation</div>  
81
  <p>These are the installation instructions for a system that has Ubuntu 8.04 installed
82
  and has never had Metacat installed on it:</p>
83
 
84
  <div class=indent>
85
    <a name="DownloadMetacatInstall"></a><div class="header3">Download Metacat Package</div>
86
    <p>Browse to the 
87
      <a href="http://knb.ecoinformatics.org/software/download.html">KNB Software Download Page</a>.
88
      In the Metacat section, select the link that looks like:</p>
89
	  <div class="code">metacat-bin-X.X.X.tar.gz</div>
90
    <p>where X.X.X is the latest version of Metacat.  Choose to save the file locally.</p>
91
    <p>Extract the Metacat package files by typing:</p>
92
      <div class="code">tar -xvzf metacat-bin-X.X.X.tar.gz</div>
93
    <p>You should see a war file and several supporting files.  The location where these files
94
    were extracted will be refered to as the the &lt;metacat_package_dir&gt; for the remainder 
95
    of this documentation.
96
  </div>
97
  
98
  <div class=indent>
99
    <a name="CreateDirs"></a><div class="header3">Create Metacat Directories</div>
100
    <p>Create the metacat utility base directory by typing:</p>
101
      <div class="code">sudo mkdir /var/metacat</div>
102
	  <div class="code">sudo chown -R &lt;tomcat_user&gt; /var/metacat</div>
103
    <p>where &lt;tomcat_user&gt; is the user that will start Tomcat.  If you are 
104
	starting Tomcat as the root user, you do not need to run the chown command.</p>
105
  </div>
106

    
107
  <div class=indent>
108
    <a name="InstallJava"></a><div class="header3">Install Java</div>
109
    <p>Install Java by typing:</p>
110
      <div class="code">sudo apt-get install sun-java5-jdk</div>
111
	<p>hit "ok" then "yes" for license agreement<p>
112
  </div>
113

    
114
  <div class=indent>
115
   <a name="InstallApache"></a><div class="header3">Install Apache</div>
116
	<p>Install Apache and and Mod JK packages by typing:</p>	
117
      <div class="code">sudo apt-get install apache2 libapache2-mod-jk</div>
118
    <p>Set up Mod JK apache configuration by typing:</p>
119
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/jk.conf /etc/apache2/mods-available</div>
120
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/workers.properties /etc/apache2</div>
121
    <p>Enable Apache Mod JK by typing:</p>
122
      <div class="code">sudo a2dismod jk</div>
123
      <div class="code">sudo a2enmod jk</div>
124
    <p>Set up and enable knb (Metacat) site configurations by typing:</p>
125
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/knb /etc/apache2/sites-available</div>
126
      <div class="code">sudo a2ensite knb</div>
127
    <p>If you want to run an LSID server along with the Metacat server, set up and enable the authority service site 
128
      configurations by typing:</p>
129
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/authority /etc/apache2/sites-available</div>
130
      <div class="code">sudo a2ensite authority</div>
131
    <p>Restart apache to bring in changes by typing:</p>
132
      <div class="code">sudo /etc/init.d/apache2 force-reload</div>
133
  </div>
134
     
135
  <div class=indent> 
136
    <a name="InstallTomcat"></a><div class="header3">Install Tomcat</div>
137
    <p>Install Tomcat 5.5 by typing:</p>
138
      <div class="code">sudo sudo apt-get install tomcat5.5</div> 
139
    <p>Install Metacat friendly Tomcat startup script by typing:</p>     
140
      <div class="code">sudo /etc/init.d/tomcat5.5 stop</div>    
141
      <div class="code">sudo mv /etc/init.d/tomcat5.5 /etc/init.d/tomcat5.5.bak</div>
142
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/tomcat5.5 /etc/init.d/tomcat5.5</div>
143
      <div class="code">sudo chmod +x /etc/init.d/tomcat5.5</div>
144
    </p>
145
  </div>
146

    
147
  <div class=indent>    
148
    <a name="InstallPostgres"></a><div class="header3">Install PostgreSQL Database</div> 
149
    <p>Install PostgreSQL by typing:</p>
150
      <div class="code">sudo apt-get install postgresql</div>
151
    <p>Change to postgres user:</p>
152
      <div class="code">sudo su - postgres</div>
153
    <p>Setup empty Metacat database instance editing the postgreSQL configuration file:</p>  
154
      <div class="code">gedit /etc/postgresql/8.3/main/pg_hba.conf</div>
155
    <p>and adding the following line:</p>
156
      <div class="code">host metacat metacat 127.0.0.1 255.255.255.255 password</div>
157
    <p>Save the file, then create the metacat instance:</p>
158
      <div class="code">createdb metacat</div>
159
    <p>Log into postgreSQL by typing:</p>
160
	  <div class="code">psql metacat</div>
161
	<p>and create the metacat user by typing at the psql prompt:</p>
162
	  <div class="code">CREATE USER metacat WITH UNENCRYPTED PASSWORD 'your_password';</div>
163
	<p>where your_password is whatever password you would like for the metacat user.</p>
164
	<p>Exit PostgreSQL by typing</p>
165
	  <div class="code">\q</div>
166
	<p>Restart the PostgreSQL database to bring in changes:</p>
167
	  <div class="code">/etc/init.d/postgresql-8.3 restart</div>
168
	<p>Log out of the postgres user account by typing:</p>
169
	  <div class="code">logout</div>
170
	<p>Test the installation and metacat account by typing:</p>
171
	  <div class="code">psql -U metacat -W -h localhost metacat</div>
172
	<p>Log back out of postgreSQL:</p>
173
	  <div class="code">\q</div>
174
  </div>
175

    
176
  <div class=indent>	
177
    <a name="QuickInstallMetacatWar"></a><div class="header3">Install Metacat War</div> 
178
    <p>Copy the war file to Tomcat:</p>
179
	  <div class="code">sudo cp &lt;metacat_package_dir&gt;/knb.war /usr/share/tomcat5.5/webapps</div>
180
	<p>Restart Tomcat:</p>  
181
	  <div class="code">sudo /etc/init.d/tomcat5.5 restart</div>
182
  </div>
183
  
184
  <div class=indent>	
185
    <a name="QuickInstallLsidWar"></a><div class="header3">Install LSID War</div> 
186
    <p>If you want to run an LSID server along with the Metacat server, copy the 
187
    authority.war file to Tomcat:</p>
188
	  <div class="code">sudo cp &lt;metacat_package_dir&gt;/authority.war /usr/share/tomcat5.5/webapps</div>
189
	<p>Restart Tomcat:</p>  
190
	  <div class="code">sudo /etc/init.d/tomcat5.5 restart</div>
191
  </div>
192
	
193
  <div class=indent>	
194
    <a name="ConfigureMetacatInstall"></a><div class="header3">Configure Metacat</div> 
195
    <p>Refer to the documentation on <a href="./metacatconfigure.html">Metacat Confguration</a>
196
    to complete your installation of Metacat.</p>
197
  </div>
198
    
199
  <a name="QuickUpdate"></a><div class="header2">Quick Update</div>
200
  <p>These are the instructions for a system that already has Metacat installed on it, 
201
  but needs a Metacat upgrade:</p>
202
  
203
  <div class=indent>
204
    <a name="DownloadMetacatUpdate"></a><div class="header3">Download Metacat Package</div>
205
    <p>Browse to the 
206
      <a href="http://knb.ecoinformatics.org/software/download.html">KNB Software Download Page</a>.
207
      In the Metacat section, select the link that looks like:</p>
208
	  <div class="code">metacat-bin-X.X.X.tar.gz</div>
209
    <p>where X.X.X is the latest version of Metacat.  Choose to save the file locally.</p>
210
    <p>Extract the Metacat package files by typing:</p>
211
      <div class="code">tar -xvzf metacat-bin-X.X.X.tar.gz</div>
212
    <p>You should see a war file and several supporting files.  The location where these files
213
    were extracted will be refered to as the the &lt;metacat_package_dir&gt; for the remainder 
214
    of this documentation.
215
  </div>
216
  
217
  <div class=indent>
218
    <a name="BackupApplication"></a><div class="header3">Backup Existing Metacat Installation</div>
219
    <p>To be safe, it is best to backup the existing Metacat installation.  Do so by typing: </p>
220
	  <div class="code">cp <web_app_dir>/knb <web_app_dir>/knb.&lt;yyyymmdd&gt;</div>
221
	  <div class="code">cp <web_app_dir>/knb.war <web_app_dir>/knb.war.&lt;yyyymmdd&gt;</div>
222
	<p>Of course, you can use any backup strategy you like (or none at all).</p>
223
  </div>
224
  
225
    <div class=indent>	
226
    <a name="QuickUpdateMetacatWar"></a><div class="header3">Install Metacat War</div> 
227
    <p>Copy the war file to Tomcat:</p>
228
	  <div class="code">sudo cp knb.war /usr/share/tomcat5.5/webapps</div>
229
	<p>Restart Tomcat:</p>  
230
	  <div class="code">sudo /etc/init.d/tomcat5.5 restart</div>
231
  </div>
232
  
233
  <div class=indent>	
234
    <a name="QuickUpdateLsidWar"></a><div class="header3">Update LSID War</div> 
235
    <p>If you want to run an LSID server along with the Metacat server, copy the 
236
    authority.war file to Tomcat:</p>
237
	  <div class="code">sudo cp &lt;metacat_package_dir&gt;/authority.war /usr/share/tomcat5.5/webapps</div>
238
	<p>Restart Tomcat:</p>  
239
	  <div class="code">sudo /etc/init.d/tomcat5.5 restart</div>
240
  </div>
241
	
242
  <div class=indent>	
243
    <a name="ConfigureMetacatInstall"></a><div class="header3">Configure Metacat</div> 
244
    <p>Refer to the documentation on <a href="./metacatconfigure.html">Metacat Confguration</a>
245
    to complete your installation of Metacat.</p>
246
  </div>
247

    
248
<!--
249
<a name="SourceInstall"></a><div class="header1">Installing From Source Code</div>
250
<p>These documents are meant to outline the metacat installation process on specific platforms. They are 
251
<strong><em>not</em></strong> a substitute for the below instructions and only meant as a supplemental guideline. </p>  
252
  <a name="WindowsXP"></a><div class="header2">Windows XP</div> 
253
    <p> See the <a href="os_specific/install_metacat_windows.html">Windows XP installation instructions</a>.</p>
254
  <a name="Ubuntu8.04"></a><div class="header2">Ubuntu 8.04</div>
255
    <p> See the <a href="os_specific/install_metacat_ubuntu.html">Ubuntu 8.04 installation instructions</a>.</p>
256
  <a name="MacOSX"></a><div class="header2">Mac OS X</div>
257
    <p> See the <a href="os_specific/install_metacat_mac.html">Mac OS X installation instructions</a>.</p>
258
-->
259

    
260
<a name="PreInstallation"></a><div class="header1">Pre-Installation</div>
261
  <a name="MinRequirements"></a><div class="header2">Minimum Requirements</div> 
262
  <p>
263
   Installing Metacat requires a server running an SQL92 compliant database
264
   (Oracle 8i or Postgresql recommended) with at least 128MB RAM, and a Pentium III class
265
   processor or higher.  The amount of disk space required depends on the
266
   size of your RDBMS tablespace (which should be at least 10 MB, 
267
   however Metacat itself requires only about 1 MB of free space after 
268
   installation).  These instructions assume a Linux environment but may
269
   work on other UNIX type environments, however this has not been tested.
270
  </p>
271
  
272
  <a name="AdditionalRequiredSoftware"></a><div class="header2">Additional Required Software</div>
273
  <p>
274
   The server on which you wish to install Metacat must have the following
275
   software installed and running correctly before attempting to install
276
   Metacat.
277
   <ul>
278
     <li><a href="http://www.oracle.com">Oracle 8i</a> (or another SQL92
279
         compliant RDBMS like Postgres)</li>
280
     <li><a href="http://jakarta.apache.org/ant/index.html">Apache Jakarta-Ant</a>
281
     </li>
282
     <li><a href="http://jakarta.apache.org/tomcat/index.html">Apache Jakarta-Tomcat</a>
283
       <p class="emphasis">Note: For a more robust web serving environment, 
284
       Apache web server should
285
       be installed along with Tomcat and the two should be integrated
286
       as described on the Apache web site.</p>
287
     </li>
288
   </ul>
289
  </p>
290

    
291
<a name="AdditionalSoftwareSetup"></a><div class="header1">Additional Software Setup</div>
292
  <a name="AdditionalSoftwareJava"></a><div class="header2">Java</div>
293
  <p>You'll need a recent Java SDK; J2SE 1.4.2 or later is required.  The latest metacat release
294
  has been tested most extensively with <a href="http://java.sun.com/j2se/1.5.0/">J2SE 5.0</a>
295
  and this is the recommended version.
296
  Make sure that JAVA_HOME environment variable is properly set and that both
297
  java and javac are on your PATH. 
298
  </p>
299
  <a name="AdditionalSoftwareOracle"></a><div class="header2">Oracle 8i</div>
300
  <p>The Oracle RDBMS must be installed and running as a daemon on the system.
301
   In addition the JDBC listener must be enabled.  You can enable it by
302
   logging in as your Oracle user and typing the following:</p>
303
   
304
     <div class="code">lsnrctl start</div>
305
     
306
   <p>Your instance should have a table space of at least 5 MB (10 MB or higher 
307
   recommended).  You should also have a username specific to Metacat
308
   created and enabled.  This user must have most normal permissions 
309
   including CREATE SESSION, CREATE TABLE, CREATE INDEX, CREATE TRIGGER, 
310
   EXECUTE PROCEDURE, EXECUTE TYPE, etc.  If an action is unexplainably 
311
   rejected by Metacat it is probably because the user permissions are not
312
   correctly set.</p>
313
   
314
  <a name="AdditionalSoftwarePostgreSQL"></a><div class="header2">PostgreSQL</div>
315
  <p>PostgreSQL can be easily installed on most linux distributions and on
316
  Windows (using cygwin) and Mac OS X.  Using Fedora Core or RedHat Linux,
317
  you can install the rpms for postgres and then run </p>
318
  
319
    <div class="code">/etc/init.d/postgresql start</div> 
320
    
321
  <p>in order to start the database. 
322
  On Ubuntu and other Debian-based Linux distributions, you can use the apt-get command
323
  to install postgres: 
324
    <div class="code">sudo apt-get install postgresql-8.0</div> and 
325
  then run 
326
    <div class="code">/etc/init.d/postgresql-8.0 start</div> to start.
327
  
328
  This initializes the data files.  You need to do a bit of configuration
329
  to create a database and set up a user account and allow internet access
330
  via jdbc.  See the postgres documentation for this, but here is a quick 
331
  start:
332
  <ul>
333
     <li>Switch to the "postgres" user account 
334
       <div class="code">sudo su - postgres</div></li>
335
     <li>Edit "data/pg_hba.conf", adding the following line to the file:<br>
336
       <div class="code">host   metacat  metacat      127.0.0.1         255.255.255.255   password</div>
337
     If your host uses IPv6 addresses, you may need this line instead:
338
       <div class="code">host   metacat  metacat      ::1               ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff password</div></li>
339
     <li>If you are using Postgresql pre-8.0, you must edit the "data/postgres.conf" file and uncomment and edit the line
340
     starting with "tcpip_socket" so that it reads 
341
       <div class="code">tcpip_socket = true</div></li>
342
     <li>Create metacat database by typing: 
343
       <div class="code">createdb metacat</div></li>
344
     <li>Log in using the postgres account and create a new "metacat" user account by typing:
345
       <div class="code">psql metacat</div> 
346
     <ul>
347
        <li>In postgres, run <div class="code">CREATE USER metacat WITH UNENCRYPTED PASSWORD 'apasswordyoulike';</div></li>
348
        <li>This creates a new account called metacat on the database named metacat</li>
349
        <li>Note: there are many ways to do this, so others such as using 
350
        ENCRYPTED passwords will work fine.</li>
351
     </ul>
352
     </li>
353
     <li>Exit the postgres account back to root and restart the postgres 
354
     database by typing:
355
       <div class="code">/etc/init.d/postgresql restart</div></li>
356
     <li>Test logging into the postgres db using the metacat account with 
357
     the following command: 
358
       <div class="code">psql -U metacat -W -h localhost metacat</div></li>
359
  </ul>
360
  </p>
361
  
362
  <a name="AdditionalSoftwareAnt"></a><div class="header2">Ant</div>
363
  <p>
364
   Ant is a Java based build application similar to Make on UNIX systems.  
365
   It takes in installation parameters from a file in the root installation
366
   directory named "build.xml".  The Metacat CVS module contains a default
367
   build.xml file that may require some modification upon installation.  Ant
368
   should be installed on the system and the "ant" executable shell script 
369
   should be available in the users path. The latest metacat release was tested with 
370
   Ant 1.6.5. <!-- We note that the current build is 
371
   not working with Ant 1.6.x, so you'll need to use an earler version.  We have 
372
   successfully used Ant 1.5.1, 1.5.2, and some earlier versions. -->
373
  </p>
374
  
375
  <a name="AdditionalSoftwareTomcat"></a><div class="header2">Tomcat</div>
376
  <p>
377
    Install Tomcat into the directory of your choice. The directory in which 
378
    you install Tomcat itself will be referred to as the &lt;tomcat_home&gt;.
379
    We recommend that you install Tomcat version 5.5.  If you are running 
380
    Ubuntu/Debian, you can get Tomcat by typing:</p>
381
      <div class="code">sudo apt-get install tomcat5.5</div>
382
    Otherwise, you can get Tomcat from <a href=" http://jakarta.apache.org/tomcat/index.html">the Apache Tomcat page</a>.
383
  </p>
384

    
385
<a name="DownloadingMetacat"></a><div class="header1">Download Metacat and Get War File</div>
386
 <p>There are several ways to wind up with a Metacat war file, which is needed for 
387
 installation.  These are: </p>
388
    <ul>
389
      <li>Download Metacat binary distribution - which will have a pre-built war file.</li>
390
      <li>Download Metacat source distribution - which will then need to be built in order to create a war file.</li>
391
      <li>Download Metacat source from SVN - which will then need to be built in order to create a war file.</li>
392
    </ul>
393
  <p>Since downloading the binary distribution is the easiest and most common install, it
394
  will be discussed here in detail.  Links to source download/build instructions are also
395
  included in case you would like to go that route.</p>
396
  <a name="DownloadMetacatBinary"></a><div class="header2">Download Metacat Binary and Create War File</div>
397

    
398
    <p>Browse to the 
399
      <a href="http://knb.ecoinformatics.org/software/download.html">KNB Software Download Page</a>.
400
      In the Metacat section, for Linux based systems, select the link that looks like:</p>
401
	  <div class="code">metacat-bin-X.X.X.tar.gz</div>
402
	  <p>for Windows systems, select the link that looks like:</p>
403
	  <div class="code">metacat-bin-X.X.X.zip</div>
404
    <p>where X.X.X is the latest version of Metacat.  Choose to save the file locally.</p>
405
    <p>Extract the Metacat package files on Linux systems by typing:
406
      <div class="code">tar -xvzf metacat-bin-X.X.X.tar.gz</div>
407
    <p>or, on Windows, use your system unzip utility to extract the zip file.</p>
408
    <p>You should see a war file and several supporting files.  The location where these files
409
    were extracted will be refered to as the the &lt;metacat_package_dir&gt; for the remainder 
410
    of this documentation.
411
    
412
  <a name="DownloadMetacatSource"></a><div class="header2">Download Metacat Source and Create War File</div>
413

    
414
    <p>If you would like to download the Metacat source distribution or checkout the source
415
    code from SVN, go to the  
416
      <a href="./metacat-source-build.html">Download and Build Metacat From Source</a> page.
417

    
418
<a name="InstallingMetacat"></a><div class="header1">Installing Metacat</div>
419
  <p>This section is only for a new installation. If you are upgrading an existing Metacat, please skip
420
  this section and go to the next one - <a href="#UpgradingMetacat">Upgrading Existing Metacat</a></p>
421
  
422
  <p>Tomcat will look for it's application files (war files) in a configured directory.  
423
  This is typically the &lt;tomcat_home&gt;/webapps directory, but your instance of Tomcat may 
424
  be configured to look in a different directory.  We will refer to your Tomcat application directory 
425
  as &lt;tomcat_app_dir&gt;.</p>
426
     
427
  <a name="CreateMetacatDirs"></a><div class="header2">Create Metacat Directories</div>
428
    <p>Metacat uses a base directory to store such things as store data and metadata,
429
    temporary files and configuration backups.  This directory should be outside of the 
430
    Tomcat application directory since the application directory gets wiped out during an
431
    upgrade. Create the metacat utility base directory 
432
    by typing:</p>
433
      <div class="code">sudo mkdir <metacat_base_dir></div>
434
    <p>(Typically <metacat_base_dir> is '/var/metacat'.)  Remeber the directory you 
435
    choose, since you will be asked to configure Metacat to point to it after startup.</p>
436
    
437
    <p>Change the ownership of the directory by typing:</p>   
438
	  <div class="code">sudo chown -R &lt;tomcat_user&gt; /var/metacat</div>
439
    <p>where &lt;tomcat_user&gt; is the user that will start Tomcat.  If you are 
440
	starting Tomcat as the root user, you do not need to run the chown command.</p>
441
	
442
  <a name="InstallMetacatWar"></a><div class="header2">Install Metacat War</div> 
443
    <p>Copy the war file to Tomcat:</p>
444
	  <div class="code">sudo cp knb.war &lt;tomcat_app_dir&gt;</div>
445
	  
446
  <a name="ApacheConfig"></a><div class="header2">Configure Apache</div> 
447
    <p>You have the option of running Tomcat stand-alone or with with the Apache web
448
    server.  Running with Apache is the more traditional setup since Apache is a 
449
    more robust web server.  There are some initial setup steps to get Apache talking
450
    to the Metacat application at the </p>
451
	  <a href="./metacat-apache-config.html"> the Metacat Apache Configuration page</a></p>
452

    
453
<a name="UpgradingMetacat"></a><div class="header1">Upgrading Existing Metacat</div>
454
  <a name="protocol"></a>
455
  <p>The following instructions are for upgrading an existing Metacat.
456
  
457
  <a name="UpgradeStopMetacat"></a><div class="header2">Stop the Running Metacat</div>
458
   <p>To do this, login as the user that runs your tomcat server (often "tomcat"),
459
   go to &lt;tomcat_home&gt;/bin and type:</p>
460
   
461
   <div class="code">./shutdown.sh</div>  
462
  
463
  <a name="UpgradeDownloadMetacat"></a><div class="header2">Download Latest Metacat Application</div>
464
    <p>Browse to the 
465
      <a href="http://knb.ecoinformatics.org/software/download.html">KNB Software Download Page</a>.
466
      In the Metacat section, select the link that looks like:</p>
467
	  <div class="code">metacat-bin-X.X.X.tar.gz</div>
468
    <p>where X.X.X is the latest version of Metacat.  Choose to save the file locally.</p>
469
    <p>Extract the Metacat package files by typing:</p>
470
      <div class="code">tar -xvzf metacat-bin-X.X.X.tar.gz</div>
471
    <p>You should see several files:</p>
472
    
473
    <ul>
474
    <li>knb.war - the Metacat application web archive file.</li>
475
    <li>knb - the web definition file used by Apache on ubuntu/debian Linux systems.</li>
476
    <li>jk.conf - the JkMount configuration file used by Apache on ubuntu/debian Linux systems.</li>
477
    <li>workers.properties - the workers definition file used by Apache on ubuntu/debian Linux systems.</li>
478
    <li>tomcat5.5 - the Tomcat startup script for Tomcat 5.5 installed with apt-get on ubuntu/debian Linux systems.</li>
479
    <li>authority - the optional LSID Server application web archive file.</li>
480
    </ul>
481
    
482
    <p>The location where these files
483
    were extracted will be refered to as the the &lt;metacat_package_dir&gt; for the remainder 
484
    of this documentation.</p>
485
 
486
   <a name="UpgradeMetacatWar"></a><div class="header2">Upgrade Metacat War</div> 
487
    <p>Tomcat will look for it's application files (war files) in a configured directory.  
488
    This is typically the &lt;tomcat_home&gt;/webapps directory, but your instance of Tomcat may 
489
    be configured to look in a different directory.  We will refer to your Tomcat application directory 
490
    as &lt;tomcat_app_dir&gt;.</p>
491
    
492
    <p>If desired, back up your existing war file with a date:</p>
493
      <div class="code">sudo mv &lt;tomcat_app_dir&gt;/knb.war &lt;tomcat_app_dir&gt;/knb.war.&lt;yyyymmdd&gt;</div>
494
    
495
    <p>Copy the war file to the Tomcat applications directory:</p>
496
	  <div class="code">sudo cp knb.war &lt;tomcat_app_dir&gt;</div>
497
	<p>Remove (or rename) the existing application directory:</p>
498
	  <div class="code">sudo rm -rf &lt;tomcat_home&gt;/webapps/knb</div>
499
	  <p> or </p>
500
	  <div class="code">sudo mv &lt;tomcat_home&gt;/webapps/knb &lt;tomcat_home&gt;/webapps/knb.&lt;yyyymmdd&gt;</div>
501
	<p>Restart Tomcat:</p>  
502
	  <div class="code">sudo /etc/init.d/tomcat5.5 restart</div>
503
	<p>Tomcat will expand your war file into a new application directory at startup time.</p>
504
 
505
  <a name="RestartTomcat"></a><div class="header1">Restart Tomcat</div>
506
    <p>Once you have successfully installed Metacat, there is one more step.  Tomcat
507
    (and Apache if you have Tomcat integrated with it) must be restarted.  To do
508
    this, login as the user that runs your tomcat server (often "tomcat"),
509
    go to &lt;tomcat_home&gt;/bin and type: </p>
510
   
511
      <div class="code">./startup.sh</div>
512
   
513
    <p>In the Tomcat startup messages you should see something in the log file like:</p>
514
   
515
      <div class="code">Metacat: [WARN]: Metacat (1.8.0) initialized. [edu.ucsb.nceas.metacat.MetaCatServlet]</div>
516
     
517
    If you see that message Tomcat has successfully loaded the Metacat servlet.
518
    Next, try to run your new servlet.  Go to a web browser and type:</p>
519
   
520
      <div class="code">http://yourserver.yourdomain.com/yourcontext/</div>
521
     
522
    <p>You should substitute your context name for "yourcontext" in the url above.
523
    If everything is working correctly, you should see a query page followed
524
    by an empty result set.  Note that if you do not have Tomcat integrated with
525
    Apache you will probably have to type</p>
526
   
527
    <div class="code">http://yourserver.yourdomain.com:8080/yourcontext/</div>
528

    
529
  <a name="UpgradeTroubleshooting"></a><div class="header2">Troubleshooting</div>
530
  <p>If you see something like: 
531
  
532
    <div class="code">java.lang.InternalError: Can't connect to X11 window server using 'yourservanme:0.0' as the value of the DISPLAY variable.</div>
533
  
534
  <p>You should add this line: </p>
535
  
536
    <div class="code">JAVA_OPTS="-Djava.awt.headless=true $JAVA_OPTS"</div> 
537
  <p>at the first line of the catalina.sh file in the tomcat bin directory. The reason is that 
538
  GeoServer uses X11 windows to draw graphics.</p>
539
  
540
  <a name="UpgradeConfigureMetacat"></a><div class="header2">Configure Metacat</div>
541
  <p>Once you see the Metacat configuration screen, you can follow the instructions in the 
542
  <a href="./metacatconfigure.html"> Configuring Metacat Section</a> 
543
  to complete the internal configuration of Metacat.</p>
544

    
545
<a name="Registry"></a><div class="header1">Web Based Registry</div>
546
  <p>The registry allows users to upload simple metadata documents directly from the web.  See the separate 
547
  <a href="registry_installation.html">Registry Installation Guide</a>.</p><br/><br/>
548
</body>
549
</html>
(23-23/62)