Project

General

Profile

Revision 4556

Added by daigle about 12 years ago

Added quick install/update sections to metacat installation instructions.

View differences:

metacatinstall.html
17 17

  
18 18
<head>
19 19
  <title>Metacat Installation Instructions</title>
20
  <link rel="stylesheet" type="text/css" href="./common.css">
20 21
  <link rel="stylesheet" type="text/css" href="./default.css">
21 22
</head>
22 23

  
......
40 41
</table>
41 42
<hr>
42 43

  
43
<table class="tabledefault" width="100%">
44
<td class="tablehead" colspan="2"><p class="emphasis"><h2>***Disclaimer***</h2></p></td>
45
<tr>
46
<td>
47
  <p class="emphasis">
44
<div class="header1"><p class="emphasis">***Disclaimer***</p></div>
45
<p class="emphasis">
48 46
   These installation instructions are meant for a systems administrator/DBA
49 47
   or someone who is an advanced computer user.  They are NOT meant for
50 48
   the average computer user.  Please realize that by executing these
51 49
   instructions, you may have to trouble shoot many advanced issues yourself.
52
</td>
53
</tr>
54
</table>
50
</p>
55 51

  
56
<table class="tabledefault" width="100%">
57
<td class="tablehead" colspan="2"><p><a name="The Table of Contents"><h2>The Table of Contents</h2></p></td>
58
<tr>
59
<td>
60
  <ul>
61
     <li>
62
         <a HREF="metacatinstall.html#Operating System Specific Instructions">Operating System Specific Instructions</a>
63
      </li>
64
      <li>
65
         <a HREF="metacatinstall.html#Pre-Installation">Pre-Installation</a>
66
      </li>
67
      <li>
68
         <a HREF="metacatinstall.html#Additional Software Setup">Additional Software Setup</a>
69
      </li>
70
      <li>
71
         <a HREF="metacatinstall.html#Installing Metacat">Installing Metacat</a>
72
      </li>
73
        <li>
74
         <a HREF="metacatinstall.html#Upgrade">Upgrading Existing Metacat</a>
75
      </li>
76
      <li>
77
        <a href="metacatinstall.html#Registry">Registry</a>
78
      
79
  </ul>
80
</td>
52
<div class="header1">Table of Contents</div>
53
  <div class="toc">
54
    <div class="toc1"><a href="#QuickInstructions">Quick Instructions</a></div>
55
      <div class="toc2"><a href="#QuickInstall">Quick Installation</a></div> 
56
      <div class="toc2"><a href="#QuickUpdate">Quick Update</a></div>
57
    <div class="toc1"><a href="#SourceInstall">Installing From Source Code</a></div>
58
      <div class="toc2"><a href="#WindowsXP">Windows XP</a></div>
59
      <div class="toc2"><a href="#Ubuntu8.04">Ubuntu 8.04</a></div>
60
      <div class="toc2"><a href="#MacOSX">Mac OS X</a></div>
61
    <div class="toc1"><a href="#PreInstallation">Pre-Installation</a></div>
62
      <div class="toc2"><a href="#MinRequirements">Minimum Requirements</a></div> 
63
      <div class="toc2"><a href="#AdditionalRequiredSoftware">Additional Required Software</a></div>
64
    <div class="toc1"><a href="#AdditionalSoftwareSetup">Additional Software Setup</a></div>
65
    <div class="toc1"><a href="#InstallingMetacat">Installing Metacat</a></div>
66
    <div class="toc1"><a href="#UpgradingMetacat">Upgrading Existing Metacat</a></div>
67
    <div class="toc1"><a href="#Registry">Registry</a></div>
68
  </div> 
81 69

  
82
<table class="tabledefault" width="100%">
83
<td class="tablehead" colspan="2"><p><a name="Operating System Specific Instructions"><h2>Operating System Specific Instructions</h2></p></td>
84
<tr>
85
<td>
86
  <p class="emphasis">
87
These documents are meant to outline the metacat installation process on specific platforms. They are <strong><em>not</em></strong> a substitute for the below instructions and only meant as a supplemental guideline. 
88
  </p>
89
  <ul>
90
    <li> <a href="os_specific/install_metacat_windows.html">Installing from CVS source on Windows XP</a> </li>
91
    <li> <a href="os_specific/install_metacat_ubuntu.html">Installing from CVS source on Ubuntu 6.06 (ie Dapper Drake)</a> </li>
92
    <li> <a href="os_specific/install_metacat_mac.html">Installing from CVS source on Mac OS X</a> </li>
70
<a name="QuickInstructions"></a><div class="header1">Quick Instructions</div>
93 71

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

  
99
  <div class=indent>
100
    <a name="InstallJava"></a><div class="header3">Install Java</div>
101
    <p>Install Java by typing:</p>
102
      <div class="code">sudo apt-get install sun-java5-jdk</div>
103
	<p>hit "ok" then "yes" for license agreement<p>
104
  </div>
99 105

  
100
<table class="tabledefault" width="100%">
101
<td class="tablehead" colspan="2"><p><a name="Pre-Installation"><h2>Pre-Installation</h2></p></td>
102
<tr>
103
<td>
104
  <p class="header">Minimum Requirements</p> 
106
  <div class=indent>
107
   <a name="InstallApache"></a><div class="header3">Install Apache</div>
108
	<p>Install Apache and and Mod JK packages by typing:</p>	
109
      <div class="code">sudo apt-get install apache2</div>
110
      <div class="code">sudo apt-get install libapache2-mod-jk</div>
111
    <p>Setup Mod JK apache configuration by typing:</p>
112
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/jk.conf /etc/apache2/mods-available</div>
113
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/workers.properties /etc/apache2</div>
114
    <p>Enable Apache Mod JK by typing:</p>
115
      <div class="code">sudo a2dismod jk</div>
116
      <div class="code">sudo a2enmod jk</div>
117
    <p>Set up and enable knb (Metacat) site configurations by typing:</p>
118
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/knb /etc/apache2/sites-available</div>
119
      <div class="code">sudo a2ensite knb</div>
120
    <p>Restart apache to bring in changes by typing:</p>
121
      <div class="code">sudo /etc/init.d/apache2 force-reload</div>
122
  </div>
123
     
124
  <div class=indent> 
125
    <a name="InstallTomcat"></a><div class="header3">Install Tomcat</div>
126
    <p>Install Tomcat 5.5 by typing:</p>
127
      <div class="code">sudo sudo apt-get install tomcat5.5</div> 
128
    <p>Install Metacat friendly Tomcat startup script by typing:</p>     
129
      <div class="code">sudo /etc/init.d/tomcat5.5 stop</div>    
130
      <div class="code">sudo mv /etc/init.d/tomcat5.5 /etc/init.d/tomcat5.5.bak</div>
131
      <div class="code">sudo cp &lt;metacat_package_dir&gt;/tomcat5.5 /etc/init.d/tomcat5.5</div>
132
      <div class="code">sudo chmod +x /etc/init.d/tomcat5.5</div>
133
    </p>
134
  </div>
135

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

  
165
  <div class=indent>	
166
    <a name="InstallMetacatWAR"></a><div class="header3">Install Metacat War</div> 
167
    <p>Copy the war file to Tomcat:</p>
168
	  <div class="code">sudo cp knb.war /usr/share/tomcat5.5/webapps</div>
169
	<p>Restart Tomcat:</p>  
170
	  <div class="code">sudo /etc/init.d/tomcat5.5 restart</div>
171
  </div>
172
	
173
  <div class=indent>	
174
    <a name="ConfigureMetacatInstall"></a><div class="header3">Configure Metacat</div> 
175
    <p>Refer to the documentation on <a href="./metacatconfigure.html">Metacat Confguration</a>
176
    to complete your installation of Metacat.</p>
177
  </div>
178
    
179
  <a name="QuickUpdate"></a><div class="header2">Quick Update</div>
180
  <p>These are the instructions for a system that already has Metacat installed on it, 
181
  but needs a Metacat upgrade:</p>
182
  
183
  <div class=indent>
184
    <a name="DownloadMetacatUpdate"></a><div class="header3">Download Metacat Package</div>
185
    <p>Browse to the 
186
      <a href="http://knb.ecoinformatics.org/software/download.html">KNB Software Download Page</a>.
187
      In the Metacat section, select the link that looks like:</p>
188
	  <div class="code">metacat-bin-X.X.X.tar.gz</div>
189
    <p>where X.X.X is the latest version of Metacat.  Choose to save the file locally.</p>
190
    <p>Extract the Metacat package files by typing:</p>
191
      <div class="code">tar -xvzf metacat-bin-X.X.X.tar.gz</div>
192
    <p>You should see a war file and several supporting files.  The location where these files
193
    were extracted will be refered to as the the &lt;metacat_package_dir&gt; for the remainder 
194
    of this documentation.
195
  </div>
196
  
197
  <div class=indent>
198
    <a name="BackupApplication"></a><div class="header3">Backup Existing Metacat Installation</div>
199
    <p>To be safe, it is best to backup the existing Metacat installation.  Do so by typing: </p>
200
	  <div class="code">cp <web_app_dir>/knb <web_app_dir>/knb.bak</div>
201
	  <div class="code">cp <web_app_dir>/knb.war <web_app_dir>/knb.war.bak</div>
202
	<p>Of course, you can use any backup strategy you like (or none at all).</p>
203
  </div>
204
  
205
    <div class=indent>	
206
    <a name="InstallMetacatWAR"></a><div class="header3">Install Metacat War</div> 
207
    <p>Copy the war file to Tomcat:</p>
208
	  <div class="code">sudo cp knb.war /usr/share/tomcat5.5/webapps</div>
209
	<p>Restart Tomcat:</p>  
210
	  <div class="code">sudo /etc/init.d/tomcat5.5 restart</div>
211
  </div>
212
	
213
  <div class=indent>	
214
    <a name="ConfigureMetacatInstall"></a><div class="header3">Configure Metacat</div> 
215
    <p>Refer to the documentation on <a href="./metacatconfigure.html">Metacat Confguration</a>
216
    to complete your installation of Metacat.</p>
217
  </div>
218

  
219
<a name="SourceInstall"></a><div class="header1">Installing From Source Code</div>
220
<p>These documents are meant to outline the metacat installation process on specific platforms. They are 
221
<strong><em>not</em></strong> a substitute for the below instructions and only meant as a supplemental guideline. </p>  
222
  <a name="WindowsXP"></a><div class="header2">Windows XP</div> 
223
    <p> See the <a href="os_specific/install_metacat_windows.html">Windows XP installation instructions</a>.</p>
224
  <a name="Ubuntu8.04"></a><div class="header2">Ubuntu 8.04</div>
225
    <p> See the <a href="os_specific/install_metacat_ubuntu.html">Ubuntu 8.04 installation instructions</a>.</p>
226
  <a name="MacOSX"></a><div class="header2">Mac OS X</div>
227
    <p> See the <a href="os_specific/install_metacat_mac.html">Mac OS X installation instructions</a>.</p>
228

  
229
<a name="PreInstallation"></a><div class="header1">Pre-Installation</div>
230
  <a name="MinRequirements"></a><div class="header2">Minimum Requirements</div> 
105 231
  <p>
106 232
   Installing Metacat requires a server running an SQL92 compliant database
107 233
   (Oracle 8i or Postgresql recommended) with at least 128MB RAM, and a Pentium III class
......
111 237
   installation).  These instructions assume a Linux environment but may
112 238
   work on other UNIX type environments, however this has not been tested.
113 239
  </p>
114
  <p class = "header">Additional Required Software</p>
240
  
241
  <a name="AdditionalRequiredSoftware"></a><div class="header2">Additional Required Software</div>
115 242
  <p>
116 243
   The server on which you wish to install Metacat must have the following
117 244
   software installed and running correctly before attempting to install
......
129 256
     </li>
130 257
   </ul>
131 258
  </p>
132
</td>
133
</tr>
134
</table>
135 259

  
136 260
<table class="tabledefault" width="100%">
137 261
<td class="tablehead" colspan="2"><p><a name="Additional Software Setup"><h2>Aditional Software Setup</h2></p></td>

Also available in: Unified diff