Revision 3591
Added by Duane Costa about 17 years ago
metacatinstall.html | ||
---|---|---|
212 | 212 |
<a href="@server@/software/download.html">download</a> a gzipped tar file |
213 | 213 |
from this site. |
214 | 214 |
</p> |
215 |
|
|
216 |
<p> |
|
217 |
<a name="buildProperties" /> |
|
218 |
<h2>Edit <code>build.properties</code> File</h2> |
|
219 |
</p> |
|
215 | 220 |
<p> |
216 |
|
|
217 |
<h2>Edit <code>build.properties</code> File</h2></p> |
|
218 |
<p> |
|
219 | 221 |
Once you have either checked out or unzipped and untarred the source |
220 | 222 |
distribution, you can begin the installation process. Change into the |
221 | 223 |
metacat directory and edit the file called "<code>build.properties</code>". You will need |
222 | 224 |
to change a number of configuration properties to match the setup on |
223 |
your system. |
|
225 |
your system. The property values that you will likely need to change are described in |
|
226 |
detail in the following table: |
|
224 | 227 |
</p> |
225 |
<p> |
|
226 |
The properties that you will likely need to change will include: |
|
227 |
<ul> |
|
228 |
<li><code>tomcat</code></li> |
|
229 |
<li><code>deploy.dir</code></li> |
|
230 |
<li><code>tomcatversion</code></li> |
|
231 |
<li><code>metacat.context</code></li> |
|
232 |
<li><code>config.hostname</code></li> |
|
233 |
<li><code>config.port</code></li> |
|
234 |
<li><code>config.port.https</code></li> |
|
235 |
<li><code>ldapUrl</code></li> |
|
236 |
<li><code>database</code></li> |
|
237 |
<li><code>jdbc-connect</code></li> |
|
238 |
<li><code>jdbc-base</code></li> |
|
239 |
<li><code>user</code></li> |
|
240 |
<li><code>password</code></li> |
|
241 |
<li><code>datafilepath</code></li> |
|
242 |
<li><code>inlinedatafilepath</code></li> |
|
243 |
<li><code>default-style</code></li> |
|
244 |
<li><code>administrators</code></li> |
|
245 |
<li><code>authority.context</code></li> |
|
246 |
<li><code>config.lsidauthority</code></li> |
|
247 |
</ul> |
|
248 |
|
|
249 |
Each is described in detail in the following table: |
|
250 |
</p> |
|
251 |
<br><br> |
|
228 |
<br/> |
|
252 | 229 |
<table border="1"> |
253 | 230 |
<tr> |
254 | 231 |
<td><b>Property</b></td> |
... | ... | |
278 | 255 |
</tr> |
279 | 256 |
<tr> |
280 | 257 |
<td>tomcatversion</td> |
281 |
<td>The tomcatversion property is the version of tomcat in which you
|
|
258 |
<td>The tomcatversion property is the version of Tomcat in which you
|
|
282 | 259 |
want Metacat to run. This will determine the location of some |
283 |
jar files coming with tomcat.</td> |
|
260 |
jar files coming with Tomcat. |
|
261 |
<p> |
|
262 |
<em>Note: Tomcat 3 and 4 are no longer tested or supported by Metacat. |
|
263 |
Users are highly encouraged to upgrade to Tomcat 5.5. |
|
264 |
</em> |
|
265 |
</p> |
|
266 |
<p> |
|
267 |
<em>Also note: a property value of 'tomcat5' can be set when using |
|
268 |
either Tomcat 5.0 or Tomcat 5.5. |
|
269 |
</em> |
|
270 |
</p> |
|
271 |
</td> |
|
284 | 272 |
<td>Default: |
285 | 273 |
<code>tomcat5</code> |
286 |
<br><br>Example:
|
|
287 |
<code>tomcat4</code> |
|
274 |
<br><br>Other possible values (deprecated):
|
|
275 |
<code>tomcat3 tomcat4</code>
|
|
288 | 276 |
</td> |
277 |
</td> |
|
289 | 278 |
</tr> |
290 | 279 |
<tr> |
291 | 280 |
<td>metacat.context</td> |
... | ... | |
347 | 336 |
<tr> |
348 | 337 |
<td>database</td> |
349 | 338 |
<td>Select the database to use for metadata storage. |
339 |
<p> |
|
340 |
The build file is preconfigured to install Metacat either using |
|
341 |
Oracle, PostgreSQL, or Microsoft SQL Server as a backend database. |
|
342 |
To change the database system, simply change the value of the 'database' |
|
343 |
property to be the name of the database target that you wish to use. |
|
344 |
</p> |
|
345 |
<p> |
|
350 | 346 |
Valid values are <code>oracle</code>, <code>postgresql</code>, or |
351 | 347 |
<code>sqlserver</code>. <em>Note that sqlserver support is minimal and |
352 | 348 |
probably will not work without substantial changes on your part, |
353 | 349 |
possibly including code changes. We have not recently tested on |
354 | 350 |
sqlserver.</em> |
351 |
</p> |
|
355 | 352 |
</td> |
356 | 353 |
<td>Default: |
357 | 354 |
<code>postgresql</code> |
... | ... | |
364 | 361 |
<td>jdbc-connect</td> |
365 | 362 |
<td>The JDBC connection string used to connect to the database.</td> |
366 | 363 |
<td>Default: |
367 |
<code>jdbc-connect=jdbc:postgresql://localhost/metacat</code>
|
|
364 |
<code>jdbc:postgresql://localhost/metacat</code> |
|
368 | 365 |
<br><br>Example: |
369 | 366 |
<code>jdbc:oracle:thin:@somehost.university.edu:1521:metacat</code> |
370 | 367 |
</td> |
... | ... | |
448 | 445 |
LSID support is an optional feature which can be configured to provide |
449 | 446 |
metacat access to LSID clients. For more information on LSID's see <a href="http://wiki.gbif.org/guidwiki/wikka.php?wakka=LSID">TDWG |
450 | 447 |
site</a>.</td> |
451 |
<td>Default: authority</td>
|
|
448 |
<td>Default: <code>authority</code></td>
|
|
452 | 449 |
</tr> |
453 | 450 |
<tr> |
454 | 451 |
<td>config.lsidauthority</td> |
455 | 452 |
<td>This is the name of the LSID authority that this metacat should use. |
456 | 453 |
This authority needs to be defined as SRV record in a DNS.</td> |
457 |
<td><p>Default: ecoinformatics.org</p>
|
|
458 |
<p>Examples: esa.org or sulphur.ecoinformatics.org</p></td>
|
|
454 |
<td><p>Default: <code>ecoinformatics.org</code></p>
|
|
455 |
<p>Examples: <code>esa.org</code> or <code>sulphur.ecoinformatics.org</code></p></td>
|
|
459 | 456 |
</tr> |
457 |
<tr> |
|
458 |
<td>install.ecogrid</td> |
|
459 |
<td>Enables EarthGrid web services. EarthGrid web services are disabled by default. |
|
460 |
To enable EarthGrid web services (including query, put, authentication and |
|
461 |
identifier interface), set this value to <code>true</code>, and also set the value |
|
462 |
of the <em>metacat.dir</em> property as detailed below.</td> |
|
463 |
<td> |
|
464 |
Default: <code>false</code> |
|
465 |
</td> |
|
466 |
</tr> |
|
467 |
<tr> |
|
468 |
<td>metacat.dir</td> |
|
469 |
<td>If the <em>install.ecogrid</em> property (see above) is set to <code>true</code>, this |
|
470 |
property should be set to the absolute path of the top-level metacat directory. |
|
471 |
If <em>install.ecogrid</em> is set to <code>false</code> (the default setting), |
|
472 |
the value of <em>metacat.dir</em> is ignored. |
|
473 |
</td> |
|
474 |
<td>Default: <code>/home/tao/project/metacat</code></td> |
|
475 |
</tr> |
|
460 | 476 |
</table> |
477 |
|
|
461 | 478 |
<br> |
479 |
|
|
462 | 480 |
<p> |
463 |
Note that the build file is preconfigured to install Metacat either using |
|
464 |
Oracle, PostgreSQL, or Microsoft SQL Server as a backend database. |
|
465 |
To change the database system, simply change the value of the 'database' |
|
466 |
property to be the name of the database target that you wish to use |
|
467 |
(either 'oracle', 'postgresql', or 'sqlserver'). |
|
481 |
Other properties in <code>build.properties</code> that you can (but generally need not) change: |
|
468 | 482 |
</p> |
469 |
<p> |
|
470 |
If you want to enable EarthGrid web services (including query, put, authentication and identifier interface), you should |
|
471 |
modify the following two properties: |
|
472 |
<pre> |
|
473 |
install.ecogrid=true |
|
474 |
metacat.dir=your-current-metacat-direcotry |
|
475 |
</pre> |
|
476 |
</p> |
|
477 |
Other properties in <code>build.properties</code> that you can (but generally need not) change:<br /> |
|
478 |
<br> |
|
483 |
|
|
479 | 484 |
<table border="1"> |
480 | 485 |
<tr> |
481 | 486 |
<td><b>Property</b></td> |
... | ... | |
488 | 493 |
for replicating documents to and from other Metacat servers, which should be with the secure (HTTPS) port. |
489 | 494 |
Since this property is usually composed of the <code>config.hostname</code> and <code>config.port.https</code> properties (described above), |
490 | 495 |
the default setting can be used in most cases. |
491 |
<td>Default: <code>${config.hostname}:${config.port.https}</code> |
|
492 | 496 |
</td> |
497 |
<td>Default: <code>${config.hostname}:${config.port.https}</code></td> |
|
493 | 498 |
</tr> |
494 | 499 |
<tr> |
495 | 500 |
<td>httpserver</td> |
... | ... | |
500 | 505 |
</td> |
501 | 506 |
</tr> |
502 | 507 |
<tr> |
508 |
<td>http.protocol</td> |
|
509 |
<td>http.protocol is the string used in the leading part of a URL to indicate use of the HTTP protocol.</td> |
|
510 |
<td>Default: <code>http</code> |
|
511 |
</td> |
|
512 |
</tr> |
|
513 |
<tr> |
|
514 |
<td>config.metacatserver</td> |
|
515 |
<td>The URL to the metacat server, composed in part from three other properties (http.protocol, httpserver, and metacat.context).</td> |
|
516 |
<td>Default: <code>${http.protocol}://${httpserver}/${metacat.context}/metacat</code> |
|
517 |
</td> |
|
518 |
</tr> |
|
519 |
<tr> |
|
503 | 520 |
<td>inst.cgi.dir</td> |
504 | 521 |
<td>Installation directory for registry CGI scripts</td> |
505 | 522 |
<td>Default: |
... | ... | |
508 | 525 |
</tr> |
509 | 526 |
<tr> |
510 | 527 |
<td>cgi-prefix</td> |
511 |
<td> </td>
|
|
528 |
<td>The URL used for executing CGI scripts</td>
|
|
512 | 529 |
<td>Default: |
513 | 530 |
<code>http://${httpserver}/cgi-bin</code> |
514 | 531 |
</td> |
... | ... | |
567 | 584 |
<code> </code> |
568 | 585 |
</td> |
569 | 586 |
</tr> |
587 |
<tr> |
|
588 |
<td>log.dir</td> |
|
589 |
<td>The directory where replication log files are to be written by Metacat.</td> |
|
590 |
<td>Default: <code>${tomcat}/logs</code></td> |
|
591 |
</tr> |
|
592 |
<tr> |
|
593 |
<td>moderators</td> |
|
594 |
<td>Moderator accounts, in a colon-separated list. Specifies a list of special users who can review a general user's submission. |
|
595 |
Moderators can approve, revise and reject the submission after reviewing. This property is only used in the ESA skin.</td> |
|
596 |
<td>Default: <code>cn=knb-prod,o=NCEAS,dc=ecoinformatics,dc=org</code></td> |
|
597 |
</tr> |
|
598 |
<tr> |
|
599 |
<td>allowedSubmitters</td> |
|
600 |
<td>Specifies the list of users who should be allowed to submit documents. |
|
601 |
If no value is specified (the default setting), all users will be allowed to submit documents. |
|
602 |
</td> |
|
603 |
<td>Default: (no value)</td> |
|
604 |
</tr> |
|
605 |
<tr> |
|
606 |
<td>deniedSubmitters</td> |
|
607 |
<td>Specify the list of users who should not be allowed to submit documents. |
|
608 |
If no value is specified (the default setting), all users will be allowed to submit documents.</td> |
|
609 |
<td>Default: (no value)</td> |
|
610 |
</tr> |
|
611 |
<tr> |
|
612 |
<td>config.metadataLabelLsid</td> |
|
613 |
<td> </td> |
|
614 |
<td>Default: <code>${config.lsidauthority}</code></td> |
|
615 |
</tr> |
|
616 |
<tr> |
|
617 |
<td>build.dir</td> |
|
618 |
<td>The name of the subdirectory that is created when metacat is built by the 'ant' tool.</td> |
|
619 |
<td>Default: <code>build</code></td> |
|
620 |
</tr> |
|
621 |
<tr> |
|
622 |
<td>lsid.build.dir</td> |
|
623 |
<td>The name of the subdirectory for building the LSID component of metacat.</td> |
|
624 |
<td>Default: <code>${build.dir}/lsid</code></td> |
|
625 |
</tr> |
|
626 |
<tr> |
|
627 |
<td>lib.dir</td> |
|
628 |
<td>The name of the subdirectory where library (.jar) files and a number of other important files are located.</td> |
|
629 |
<td>Default: <code>lib</code></td> |
|
630 |
</tr> |
|
631 |
<tr> |
|
632 |
<td>lsid.lib.dir</td> |
|
633 |
<td>The name of the subdirectory where LSID library (.jar) files are located.</td> |
|
634 |
<td>Default: <code>${lib.dir}/lsid_lib</code></td> |
|
635 |
</tr> |
|
636 |
<tr> |
|
637 |
<td>lsid.classes.dir</td> |
|
638 |
<td>The relative path to the location of Java classes that support LSID.</td> |
|
639 |
<td>Default: <code>edu/ucsb/nceas/metacat/lsid</code></td> |
|
640 |
</tr> |
|
641 |
<tr> |
|
642 |
<td>conf.dir</td> |
|
643 |
<td>The name of the directory where LSID configuration files are located.</td> |
|
644 |
<td>Default: <code>lib/lsid_conf</code></td> |
|
645 |
</tr> |
|
646 |
<tr> |
|
647 |
<td>services.dir</td> |
|
648 |
<td>The name of the directory where LSID services configuration files are located.</td> |
|
649 |
<td>Default: <code>${conf.dir}/services</code></td> |
|
650 |
</tr> |
|
651 |
<tr> |
|
652 |
<td>webinf.dir</td> |
|
653 |
<td>The name of the directory where additional LSID web services files are located.</td> |
|
654 |
<td>Default: <code>${conf.dir}/WEB-INF</code></td> |
|
655 |
</tr> |
|
656 |
<tr> |
|
657 |
<td>compile.debug</td> |
|
658 |
<td>Indicates whether Java source should be compiled with debug information.</td> |
|
659 |
<td>Default: <code>true</code></td> |
|
660 |
</tr> |
|
661 |
<tr> |
|
662 |
<td>compile.deprecation</td> |
|
663 |
<td>Indicates whether Java source should be compiled with deprecation information.</td> |
|
664 |
<td>Default: <code>false</code></td> |
|
665 |
</tr> |
|
666 |
<tr> |
|
667 |
<td>compile.optimize</td> |
|
668 |
<td>Indicates whether Java source should be compiled with optimization.</td> |
|
669 |
<td>Default: <code>true</code></td> |
|
670 |
</tr> |
|
671 |
<tr> |
|
672 |
<td>indexPaths</td> |
|
673 |
<td>The <em>indexPaths</em> property specifies a comma-separated (potentially long) list |
|
674 |
of indexed paths that can be utilized to improve the |
|
675 |
performance of metacat queries. Each component of the <em>indexPaths</em> property |
|
676 |
should specify an absolute or relative path (using an XPath-like syntax) to an XML element or |
|
677 |
attribute present in the XML documents being queried. Metacat stores XML |
|
678 |
element and attribute values for indexed paths in a special database table |
|
679 |
that optimizes search performance. |
|
680 |
<p>Metacat queries allow you to specify (using the <pathexpr> tag in search query) |
|
681 |
an exact path to which you want |
|
682 |
to restrict the search. When the <pathexpr> path that is specified in the query |
|
683 |
is a member of the <em>indexPaths</em> list, search results are returned faster |
|
684 |
because metacat can conduct its search using the optimized database table. |
|
685 |
<p> |
|
686 |
The default value for the <em>indexPaths</em> property contains numerous paths to EML |
|
687 |
elements and attributes that are commonly queried by metacat search tools. |
|
688 |
For example, <em>keyword</em> is a |
|
689 |
member of this list because it is common for search tools to query |
|
690 |
the <em>keyword</em> field in EML documents. For most purposes, the default value will |
|
691 |
optimize various types of searches on EML documents and need not be changed. |
|
692 |
<p> |
|
693 |
For more information about metacat queries, |
|
694 |
see <a href="./metacatquery.html">Queries and Results</a>. |
|
695 |
</td> |
|
696 |
<td>Default: <code>organizationName,originator/individualName/surName,...</code></td> |
|
697 |
</tr> |
|
570 | 698 |
</table> |
571 | 699 |
<p> |
572 | 700 |
Metacat has a number of additional settable properties in file |
Also available in: Unified diff
Update documentation of build.properties and metacat.properties prior to the metacat 1.7.1 release.
The main goal here was to ensure that all previously undocumented properties are now present in these documents. Some minor edits were also made to a few of the already documented properties.
A fairly lengthy description was written for the 'indexPaths' build property. Perhaps in future documentation there should be a sub-section of the "Query and Results" document that describes indexPaths at greater length.
These revisions were made by costa and tao.