Revision 3214
Added by Duane Costa over 17 years ago
docs/user/metacatinstall.html | ||
---|---|---|
64 | 64 |
processor or higher. The amount of disk space required depends on the |
65 | 65 |
size of your RDBMS tablespace (which should be at least 10 MB, |
66 | 66 |
however Metacat itself requires only about 1 MB of free space after |
67 |
installation. These instructions assume a Linux environment but may |
|
67 |
installation). These instructions assume a Linux environment but may
|
|
68 | 68 |
work on other UNIX type environments, however this has not been tested. |
69 | 69 |
</p> |
70 | 70 |
<p class = "header">Additional Required Software</p> |
... | ... | |
94 | 94 |
<tr> |
95 | 95 |
<td> |
96 | 96 |
<p class="header">Java</p> |
97 |
<p>You'll need a recent Java SDK; j2sdk1.4.2 or later is required. The latest metacat release |
|
98 |
has been tested with the <a href="http://java.sun.com/javase/downloads/index.jsp">Sun J2SE Development Kit 5.0 </a>. |
|
97 |
<p>You'll need a recent Java SDK; J2SE 1.4.2 or later is required. The latest metacat release |
|
98 |
has been tested most extensively with <a href="http://java.sun.com/j2se/1.5.0/">J2SE 5.0</a> |
|
99 |
and this is the recommended version. |
|
99 | 100 |
Make sure that JAVA_HOME environment variable is properly set and that both |
100 | 101 |
java and javac are on your PATH. |
101 | 102 |
</p> |
... | ... | |
166 | 167 |
<p> |
167 | 168 |
Install Tomcat into the directory of your choice. The directory in which |
168 | 169 |
you install Tomcat itself will be referred to as the "$CATALINA_HOME". |
169 |
We recommend that you install Tomcat version 5.0. More details about
|
|
170 |
Tomcat installation is available <a href=" http://jakarta.apache.org/tomcat/index.html">here</a>.
|
|
170 |
We recommend that you install Tomcat version 5.5. More details about
|
|
171 |
Tomcat installation are available <a href=" http://jakarta.apache.org/tomcat/index.html">here</a>.
|
|
171 | 172 |
</p> |
172 | 173 |
</td> |
173 | 174 |
</tr> |
... | ... | |
193 | 194 |
<a href="@server@/software/download.html">download</a> a gzipped tar file |
194 | 195 |
from this site. |
195 | 196 |
</p> |
196 |
<p><h2>Edit <code>build.properties</code> File</h2></p> |
|
197 | 197 |
<p> |
198 |
|
|
199 |
<h2>Edit <code>build.properties</code> File</h2></p> |
|
200 |
<p> |
|
198 | 201 |
Once you have either checked out or unzipped and untarred the source |
199 | 202 |
distribution, you can begin the installation process. Change into the |
200 | 203 |
metacat directory and edit the file called "<code>build.properties</code>". You will need |
... | ... | |
202 | 205 |
your system. |
203 | 206 |
</p> |
204 | 207 |
<p> |
205 |
The properties that you will likely need to change will include |
|
206 |
<code>tomcat</code>, <code>tomcatversion</code>, <code>webapps</code>, |
|
207 |
<code>context</code>, <code>server</code>, <code>httpserver</code>, |
|
208 |
<code>database</code>, <code>jdbc-connect</code>, <code>jdbc-base</code>, |
|
209 |
<code>user</code>, <code>password</code>, <code>datafilepath</code>, |
|
210 |
<code>inlinedatafilepath</code>, <code>cvsroot</code>, |
|
211 |
<code>default-style</code>, and <code>administrators</code>. |
|
212 |
Each is described in detail in the table below. |
|
208 |
The properties that you will likely need to change will include: |
|
209 |
<ul> |
|
210 |
<li><code>tomcat</code></li> |
|
211 |
<li><code>deploy.dir</code></li> |
|
212 |
<li><code>metacat.context</code></li> |
|
213 |
<li><code>config.hostname</code></li> |
|
214 |
<li><code>config.port</code></li> |
|
215 |
<li><code>config.port.https</code></li> |
|
216 |
<li><code>ldapUrl</code></li> |
|
217 |
<li><code>database</code></li> |
|
218 |
<li><code>jdbc-connect</code></li> |
|
219 |
<li><code>jdbc-base</code></li> |
|
220 |
<li><code>user</code></li> |
|
221 |
<li><code>password</code></li> |
|
222 |
<li><code>datafilepath</code></li> |
|
223 |
<li><code>inlinedatafilepath</code></li> |
|
224 |
<li><code>default-style</code></li> |
|
225 |
<li><code>administrators</code></li> |
|
226 |
<li><code>authority.context</code></li> |
|
227 |
<li><code>config.lsidauthority</code></li> |
|
228 |
</ul> |
|
229 |
|
|
230 |
Each is described in detail in the following table: |
|
213 | 231 |
</p> |
214 |
Properties you will likely need to change: |
|
215 | 232 |
<br><br> |
216 | 233 |
<table border="1"> |
217 | 234 |
<tr> |
... | ... | |
225 | 242 |
<td>Default: |
226 | 243 |
<code>/usr/local/devtools/jakarta-tomcat</code> |
227 | 244 |
<br><br>Example: |
228 |
<code>C:/Tomcat5</code></td> |
|
245 |
<code>C:/Tomcat-5.5</code></td>
|
|
229 | 246 |
</tr> |
230 | 247 |
<tr> |
231 |
<td>tomcatversion</td> |
|
232 |
<td>The tomcatversion property is the version of your Tomcat. You should |
|
233 |
put tomcat4, or tomcat5 here. |
|
234 |
</td> |
|
235 |
<td>Default: |
|
236 |
<code>tomcat5</code> |
|
237 |
<br><br>Example: |
|
238 |
<code>tomcat5</code> |
|
239 |
</td> |
|
240 |
</tr> |
|
241 |
<tr> |
|
242 |
<td>webapps</td> |
|
243 |
<td>The webapps property is the location in which your tomcat servlet |
|
244 |
contexts are installed. This is typically "TOMCAT_HOME/webapps", |
|
245 |
where TOMCAT_HOME is the same value that you entered for the 'tomcat' |
|
248 |
<td>deploy.dir</td> |
|
249 |
<td>The deploy.dir property is the location in which your tomcat servlet |
|
250 |
contexts are deployed. This is typically "${tomcat}/webapps", |
|
251 |
where ${tomcat} is the same value that you entered for the 'tomcat' |
|
246 | 252 |
property above. |
247 | 253 |
</td> |
248 | 254 |
<td>Default: |
249 | 255 |
<code>/var/www/org.ecoinformatics.knb</code> |
250 | 256 |
<br><br>Example: |
251 |
<code>C:/Tomcat5/webapps</code> |
|
257 |
<code>C:/Tomcat-5.5/webapps</code>
|
|
252 | 258 |
</td> |
253 | 259 |
</tr> |
254 | 260 |
<tr> |
255 |
<td>context</td> |
|
256 |
<td>The context property is the name of the servlet context in which you |
|
261 |
<td>metacat.context</td>
|
|
262 |
<td>The metacat.context property is the name of the servlet context in which you
|
|
257 | 263 |
want Metacat to be installed. This will determine the installation |
258 | 264 |
directory for the servlet and many of the URLs that are used to access |
259 | 265 |
the installed Metacat server.</td> |
... | ... | |
264 | 270 |
</td> |
265 | 271 |
</tr> |
266 | 272 |
<tr> |
267 |
<td>server</td>
|
|
268 |
<td>The server property is hostname of for the server on which Metacat is
|
|
273 |
<td>config.hostname</td>
|
|
274 |
<td>The config.hostname property is the hostname of the server on which Metacat is
|
|
269 | 275 |
running (note that you should not include the 'http://' in the server |
270 |
property). The server setting should include the port number |
|
271 |
appended to the end if Tomcat is running stand-alone (see example). |
|
276 |
property). |
|
272 | 277 |
</td> |
273 | 278 |
<td>Default: |
274 | 279 |
<code>knb.ecoinformatics.org</code> |
275 | 280 |
<br><br>Example: |
276 |
<code>somehost.university.edu:8080</code>
|
|
281 |
<code>somehost.university.edu</code> |
|
277 | 282 |
</td> |
278 | 283 |
</tr> |
279 | 284 |
<tr> |
280 |
<td>httpserver</td> |
|
281 |
<td>httpserver is the plain HTTP address on which Metacat is running |
|
282 |
(note that you should not include the 'http://' in the httpserver |
|
283 |
property). |
|
284 |
The httpserver setting should include the HTTP plain port number |
|
285 |
appended to the end if Tomcat is running stand-alone (see example).</td> |
|
285 |
<td>config.port</td> |
|
286 |
<td>The config.port property is the HTTP plain port number that is used to connect to Metacat. |
|
287 |
If Tomcat is running stand-alone, the value will typically be 8080.</td> |
|
286 | 288 |
<td>Default: |
287 |
<code>knb.ecoinformatics.org</code>
|
|
289 |
<code>80</code>
|
|
288 | 290 |
<br><br>Example: |
289 |
<code>somehost.university.edu:8080</code>
|
|
291 |
<code>8080</code> |
|
290 | 292 |
</td> |
291 | 293 |
</tr> |
292 | 294 |
<tr> |
295 |
<td>config.port.https</td> |
|
296 |
<td>The config.port.https property is the HTTP secure port number that is used to connect to Metacat. |
|
297 |
If Tomcat is running stand-alone, the value will typically be 8443.</td> |
|
298 |
<td>Default: |
|
299 |
<code>80</code> |
|
300 |
<br><br>Example: |
|
301 |
<code>8443</code> |
|
302 |
</td> |
|
303 |
</tr> |
|
304 |
<tr> |
|
293 | 305 |
<td>ldapUrl</td> |
294 | 306 |
<td>URL to the LDAP server. The LDAP server is used in the default |
295 | 307 |
authentication module to authenticate and identify users of the |
... | ... | |
305 | 317 |
<td>database</td> |
306 | 318 |
<td>Select the database to use for metadata storage. |
307 | 319 |
Valid values are <code>oracle</code>, <code>postgresql</code>, or |
308 |
<code>sqlserver</code>. Note that sqlserver support is minimal and |
|
320 |
<code>sqlserver</code>. <em>Note that sqlserver support is minimal and
|
|
309 | 321 |
probably will not work without substantial changes on your part, |
310 |
possibly including code changes. We have not revcently tested on
|
|
311 |
sqlserver. |
|
322 |
possibly including code changes. We have not recently tested on |
|
323 |
sqlserver.</em>
|
|
312 | 324 |
</td> |
313 | 325 |
<td>Default: |
314 |
<code>oracle</code>
|
|
326 |
<code>postgresql</code>
|
|
315 | 327 |
<br><br>Other possible values: |
316 |
<code>postgresql</code>
|
|
328 |
<code>oracle</code>
|
|
317 | 329 |
<code>sqlserver</code> |
318 | 330 |
</td> |
319 | 331 |
</tr> |
... | ... | |
321 | 333 |
<td>jdbc-connect</td> |
322 | 334 |
<td>The JDBC connection string used to connect to the database.</td> |
323 | 335 |
<td>Default: |
324 |
<code>jdbc:oracle:thin:@metacat.nceas.ucsb.edu:1521:knb</code> |
|
336 |
<code>jdbc-connect=jdbc:postgresql://localhost/metacat</code> |
|
337 |
<br><br>Example: |
|
338 |
<code>jdbc:oracle:thin:@somehost.university.edu:1521:metacat</code> |
|
325 | 339 |
</td> |
326 | 340 |
<tr> |
327 | 341 |
<td>jdbc-base</td> |
328 |
<td>The base directory for locating JDBC jar files (not needed for postgresql).</td> |
|
342 |
<td>The base directory for locating JDBC jar files. When using the postgresql database, the default setting of './lib' can be used, |
|
343 |
while oracle and sqlserver databases will require a different setting since these jar files are not included in the Metacat |
|
344 |
distribution.</td> |
|
329 | 345 |
<td>Default: |
330 |
<code>/usr/oracle/jdbc/lib</code>
|
|
346 |
<code>./lib</code>
|
|
331 | 347 |
<br><br>Example: |
332 |
<code>C:/jdev10g/jdbc/lib</code><br>
|
|
348 |
<code>/usr/oracle/jdbc/lib</code><br>
|
|
333 | 349 |
</td> |
334 | 350 |
</tr> |
335 | 351 |
<tr> |
336 | 352 |
<td>user</td> |
337 |
<td>The database user name that you set up to use Metacat. For example, |
|
338 |
an Oracle username.</td> |
|
353 |
<td>The database user name that you set up to use Metacat.</td> |
|
339 | 354 |
<td>Default: |
340 |
<code>knb</code>
|
|
355 |
<code>metacat</code>
|
|
341 | 356 |
<br><br>Example: |
342 |
<code>metacatdb</code>
|
|
357 |
<code>metacatuser</code>
|
|
343 | 358 |
</td> |
344 | 359 |
</tr> |
345 | 360 |
<tr> |
... | ... | |
357 | 372 |
<td>Default: |
358 | 373 |
<code>/var/metacat/data</code> |
359 | 374 |
<br><br>Example: |
360 |
<code>C:/Tomcat5/data/knb/data</code>
|
|
375 |
<code>C:/Tomcat-5.5/data/metacat/data</code>
|
|
361 | 376 |
</td> |
362 | 377 |
</tr> |
363 | 378 |
<tr> |
... | ... | |
367 | 382 |
<td>Default: |
368 | 383 |
<code>/var/metacat/inline-data</code> |
369 | 384 |
<br><br>Example: |
370 |
<code>C:/Tomcat5/data/knb/inlinedata</code>
|
|
385 |
<code>C:/Tomcat-5.5/data/metacat/inlinedata</code>
|
|
371 | 386 |
</td> |
372 | 387 |
</tr> |
373 | 388 |
<tr> |
374 | 389 |
<td>default-style</td> |
375 | 390 |
<td>The default-style parameter defines the "style-set" that is to be used |
376 | 391 |
by default when the qformat parameter is missing or set to "html" |
377 |
during a query. It is set to "knb", which is one of the styles that
|
|
392 |
during a query. It is set to "default", which is one of the styles that
|
|
378 | 393 |
ships with the default metacat distribution. Other possible settings |
379 | 394 |
are shown in the examples to the right.</td> |
380 | 395 |
<td>Default: |
381 |
<code>knb</code> |
|
382 |
<br><br>Examples: |
|
383 |
<pre><code>default esa knb2 nceas nrs obfs specnet</code></pre> |
|
396 |
<code>default</code> |
|
397 |
<br><br>Examples:<code>esa kepler knb knb2 knp lter ltss nceas nrs obfs pisco specnet</code> |
|
384 | 398 |
</td> |
385 | 399 |
</tr> |
386 | 400 |
<tr> |
387 | 401 |
<td>administrators</td> |
388 | 402 |
<td>The administrators parameter lists the accounts that are allowed to |
389 | 403 |
perform administrative actions such as rebuilding indices for |
390 |
documents. The list can can contain more than one account separated
|
|
404 |
documents. The list can contain more than one account separated |
|
391 | 405 |
by colons.</td> |
392 | 406 |
<td>Default: |
393 | 407 |
<code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code> |
... | ... | |
440 | 454 |
<td>cgi-prefix</td> |
441 | 455 |
<td> </td> |
442 | 456 |
<td>Default: |
443 |
<code>http://knb.ecoinformatics.org/cgi-bin</code>
|
|
457 |
<code>http://${httpserver}/cgi-bin</code>
|
|
444 | 458 |
</td> |
445 | 459 |
</tr> |
446 | 460 |
<tr> |
461 |
<td>cvsroot</td> |
|
462 |
<td>CVS access to retrieve latest EML. Only used by |
|
463 |
developers in building the release.</td> |
|
464 |
<td>Default: |
|
465 |
<code><pre>:ext:${env.USER}@cvs.ecoinformatics.org:/cvs</pre></code> |
|
466 |
Example: |
|
467 |
<code><pre>:ext:myaccount@cvs.ecoinformatics.org:/cvs</pre></code> |
|
468 |
</td> |
|
469 |
</tr> |
|
470 |
<tr> |
|
447 | 471 |
<td>knb-site-url</td> |
448 | 472 |
<td>This is the URL to the web context root for the knb site. |
449 | 473 |
It is used for the qformat=knb skin only.</td> |
... | ... | |
452 | 476 |
</td> |
453 | 477 |
</tr> |
454 | 478 |
<tr> |
479 |
<td>timedreplication</td> |
|
480 |
<td>Determines whether timed replication to other metacat servers is being used.</td> |
|
481 |
<td>Default: |
|
482 |
<code>false</code> |
|
483 |
<br><br>Other possible values: |
|
484 |
<code>true</code> |
|
485 |
</td> |
|
486 |
</tr> |
|
487 |
<tr> |
|
488 |
<td>firsttimedreplication</td> |
|
489 |
<td>The time for starting first timed replication if timedreplication is true. |
|
490 |
(See comments in build.properties file for additional details.)</td> |
|
491 |
<td>Default: |
|
492 |
<code>10:00 PM</code> |
|
493 |
<code> </code> |
|
494 |
</td> |
|
495 |
</tr> |
|
496 |
<tr> |
|
497 |
<td>timedreplicationinterval</td> |
|
498 |
<td>The interval to next timed replication if timedreplication is true. |
|
499 |
The value is in milliseconds and default value is 48 hours.</td> |
|
500 |
<td>Default: |
|
501 |
<code>172800000</code> |
|
502 |
<code> </code> |
|
503 |
</td> |
|
504 |
</tr> |
|
505 |
<tr> |
|
455 | 506 |
<td>forcereplicationwaitingtime</td> |
456 | 507 |
<td>The waiting time before replication is forced to begin after |
457 | 508 |
uploading a package. The default value should usually suffice.</td> |
... | ... | |
460 | 511 |
<code> </code> |
461 | 512 |
</td> |
462 | 513 |
</tr> |
463 |
<tr> |
|
464 |
<td>cvsroot</td> |
|
465 |
<td>CVS access to retrieve latest EML. Only used by |
|
466 |
developers in building the release.</td> |
|
467 |
<td>Default: |
|
468 |
<code><pre>:ext:${env.USER}@cvs.ecoinformatics.org:/cvs</pre></code> |
|
469 |
Example: |
|
470 |
<code><pre>:ext:myaccount@cvs.ecoinformatics.org:/cvs</pre></code> |
|
471 |
</td> |
|
472 |
</tr> |
|
473 | 514 |
</table> |
474 | 515 |
<p> |
475 | 516 |
Metacat has a number of additional settable properties in file |
476 |
<code>metacat/lib/metacat.properties</code>. Under most circumstances,
|
|
517 |
<code>lib/metacat.properties</code>. Under most circumstances, |
|
477 | 518 |
you will not need to modify this file because the properties of interest |
478 | 519 |
to you can be controlled by editing <code>build.properties</code> as |
479 | 520 |
described above. To learn more about Metacat's additional properties, |
... | ... | |
602 | 643 |
<li>build/src/upgrade-db-to-1.3.sql</li> |
603 | 644 |
<li>build/src/upgrade-db-to-1.4.sql</li> |
604 | 645 |
<li>build/src/upgrade-db-to-1.5.sql</li> |
646 |
<li>build/src/upgrade-db-to-1.6.sql</li> |
|
647 |
<li>build/src/upgrade-db-to-1.7.sql</li> |
|
605 | 648 |
</ul> |
606 | 649 |
<p> |
607 |
So, if you had an existing metacat 1.0 installation and you were upgrading |
|
608 |
to 1.5, you would need to run all four scripts in sequence: |
|
609 |
upgrade-db-to-1.2.sql, upgrade-db-to-1.3.sql, |
|
610 |
upgrade-db-to-1.4.sql, and upgrade-db-to-1.5.sql. |
|
611 |
However, if you were starting from a Metacat 1.4.x |
|
612 |
installation, you would only need to run the upgrade-db-to-1.5.sql script. |
|
613 |
Be sure to use the version of the scripts from the 'build' directory: they |
|
614 |
are customized for your installation in that directory. |
|
650 |
For example, if you had an existing metacat 1.4 installation and you were upgrading |
|
651 |
to metacat 1.7, you would need to run three scripts in sequence: |
|
652 |
upgrade-db-to-1.5.sql, upgrade-db-to-1.6.sql, and upgrade-db-to-1.7.sql. |
|
653 |
However, if you were starting from a Metacat 1.6 |
|
654 |
installation, you would only need to run the upgrade-db-to-1.7.sql script. |
|
655 |
<em>Be sure to use the version of the scripts from the 'build/src' directory: they |
|
656 |
are customized for your installation in that directory.</em> |
|
615 | 657 |
</p> |
616 | 658 |
</p> |
617 | 659 |
<h2>Restart Tomcat</h2> |
... | ... | |
643 | 685 |
Can't connect to X11 window server using 'yourservanme:0.0' as the value of the DISPLAY variable. |
644 | 686 |
<p>You should add this line: |
645 | 687 |
<b>JAVA_OPTS="-Djava.awt.headless=true $JAVA_OPTS"</b> at the first line of |
646 |
catalina.sh file in tomcat bin directory. The reason is that GeoServer uses X11 wondows to draw graphics.
|
|
688 |
catalina.sh file in tomcat bin directory. The reason is that GeoServer uses X11 windows to draw graphics.
|
|
647 | 689 |
</p> |
648 | 690 |
|
649 | 691 |
<h2> Operating System Specific Instructions </h2> |
Also available in: Unified diff
Update metacat installation documentation for 1.7 release.