/docs/user/metacatinstall.html - Diff - Metacat - Ecoinformatics Redmine

« Previous | Next »

Revision 2309

Added by Matt Jones about 20 years ago

Updated metacat documentation with additional properties and fixed the
description of several properties. We really need to clean out unused
properties and generally clean up the configuration morass.

       <code>database</code>, <code>jdbc-connect</code>, <code>jdbc-base</code>,
       <code>user</code>, <code>password</code>, <code>datafilepath</code>,
       <code>inlinedatafilepath</code>, <code>cvsroot</code>,
       <code>cvsroot-alternate</code>, and <code>default-style</code>.
       <code>cvsroot-alternate</code>, <code>default-style</code>, and
       <code>administrators</code>.
       Each is described in detail in the table below.
       </p>
       Properties you will likely need to change:
-...
         <tr>
           <td>tomcatversion</td>
           <td>The tomcatversion property is the version of your Tomcat. You should
               put tomcat3 or tomcat4 here.</td>
               put tomcat3, tomcat4, or tomcat5 here. We have most extensively
               tested Tomcat 4.x, but Tomcat 5.x seems to work fine as well.
           </td>
           <td>Default:&nbsp;&nbsp;
               <code>tomcat4</code>
           <br><br>Example:&nbsp;&nbsp;
-...
         </tr>
         <tr>
           <td>server</td>
           <td>The server property is the secure HTTPS address on which Metacat is
           <td>The server property is hostname of for the server on which Metacat is
               running (note that you should not include the 'http://' in the server
               property). The server setting should include the SSL port number
               appended to the end if Tomcat is running stand-alone (see example).</td>
               property). The server setting should include the port number
               appended to the end if Tomcat is running stand-alone (see example).
           </td>
           <td>Default:&nbsp;&nbsp;
              <code>knb.ecoinformatics.org</code>
           <br><br>Example:&nbsp;&nbsp;
              <code>somehost.university.edu:8443</code>
              <code>somehost.university.edu:8080</code>
           </td>
         </tr>
         <tr>
           <td>httpserver</td>
           <td>httpserver is the plain HTTP address on which Metacat is running
               (note that you should not include the 'http://' in the httpserver property).
               (note that you should not include the 'http://' in the httpserver
               property).
               The httpserver setting should include the HTTP plain port number
               appended to the end if Tomcat is running stand-alone (see example).</td>
           <td>Default:&nbsp;&nbsp;
-...
         </tr>
         <tr>
           <td>ldapUrl</td>
           <td>URL to the LDAP server</td>
           <td>URL to the LDAP server. The LDAP server is used in the default
               authentication module to authenticate and identify users of the
               system.  To participate in the KNB network, you should leave this at
               the default.  But it can be changed if you want to use a
               different directory of users.
           </td>
           <td>Default:&nbsp;&nbsp;
               <code>ldap://ldap.ecoinformatics.org/dc=ecoinformatics,dc=org</code>
           </td>
-...
           <td>database</td>
           <td>Select the database to use for metadata storage.
               Valid values are <code>oracle</code>, <code>postgresql</code>, or
               <code>sqlserver</code>.
               <code>sqlserver</code>. Note that sqlserver support is minimal and
               probably will not work without substantial changes on your part,
               possibly including code changes.  We have not revcently tested on
               sqlserver.
           </td>
           <td>Default:&nbsp;&nbsp;
               <code>oracle</code>
-...
         </tr>
         <tr>
           <td>datafilepath</td>
           <td>The datafilepath is the directory to store the data file.</td>
           <td>The datafilepath is the directory to store data files.</td>
           <td>Default:&nbsp;&nbsp;
               <code>/var/metacat/data</code>
           <br><br>Example:&nbsp;&nbsp;
-...
         </tr>
         <tr>
           <td>inlinedatafilepath</td>
           <td>The inlinedatafilepath is the directory to store inline data.</td>
           <td>The inlinedatafilepath is the directory to store inline data that
               has been extracted from EML documents.</td>
           <td>Default:&nbsp;&nbsp;
               <code>/var/metacat/inline-data</code>
           <br><br>Example:&nbsp;&nbsp;
-...
         </tr>
         <tr>
           <td>cvsroot</td>
           <td>CVS access to retrieve latest EML.</td>
           <td>CVS access to retrieve latest EML. Only used by
               developers in building the release.</td>
           <td>Default:&nbsp;&nbsp;
               <code><pre>:ext:${env.USER}@cvs.ecoinformatics.org:/cvs</pre></code>
               Example:&nbsp;&nbsp;
-...
         </tr>
         <tr>
           <td>cvsroot-alternate</td>
           <td>CVS access to retrieve latest conversion styles.</td>
           <td>CVS access to retrieve latest conversion styles. Only used by
               developers in building the release.</td>
           <td>Default:&nbsp;&nbsp;
               <code><pre>:ext:${env.USER}@cvs.nceas.ucsb.edu:/cvs/pbi</pre></code>
               Example:&nbsp;&nbsp;
-...
               <pre><code>default   esa   knb2   nceas   nrs   obfs   specnet</code></pre>
           </td>
         </tr>
         <tr>
           <td>administrators</td>
           <td>The administrators parameter lists the accounts that are allowed to
               perform administrative actions such as rebuilding indices for
               documents. The list can can contain more than one account separated
               by colons.</td>
           <td>Default:&nbsp;&nbsp;
               <code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code>
           <br><br>Examples:&nbsp;&nbsp;
               <code>uid=localadmin,o=ucnrs.org</code>
           </td>
         </tr>
       </table>
       <br>
       <p>
-...
       </p>
       <p>
        If the script has run correctly you should be able to type
        <pre>describe xml_documents</pre> and it should tell you
        <pre>describe xml_documents</pre> and it should show:
        <pre>
         Name            Null?         Type
         --------------  ------------  ----------------

Also available in: Unified diff

Project

General

Profile

Metacat

Revision 2309

Added by Matt Jones about 20 years ago