Project

General

Profile

« Previous | Next » 

Revision 2309

Added by Matt Jones over 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.

View differences:

docs/user/properties.html
104 104
      <td>accNumSeparator</td>
105 105
      <td>The separator that is used to separate the three parts 
106 106
          of the accession number: codename, sequence and revision number.
107
          It should be synchronized with the Client application.</td>
107
           changing this parameter will likely break the application, so make
108
           sure you know what you are doing.  It should be synchronized with 
109
           the Client application.</td>
108 110
      <td>. (period)</td>
109 111
    </tr>
110 112
    <tr>
......
208 210
      <td>path to the SSL keys for secure transmissions.</td>
209 211
      <td>/opt/tomcat/webapps/metacat/lib</td>
210 212
    </tr>
213
    <tr>
214
      <td>administrators</td>
215
      <td>The administrators parameter lists the accounts that are allowed to
216
          perform administrative actions such as rebuilding indices for 
217
          documents. The list can can contain more than one account separated
218
          by colons.</td>
219
      <td>Default:&nbsp;&nbsp;
220
          <code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code>
221
      <br><br>Examples:&nbsp;&nbsp;
222
          <code>uid=localadmin,o=ucnrs.org</code>
223
      </td>
224
    </tr>
225
    <tr><td> </td></tr>
226
    <tr><td colspan="3"><b>Additional parameters probably not needing to be changed</b></td></tr>
227
    <tr><td>configured</td><td>Configuration flag, currently not used.</td><td>false</td></tr>
228
    <tr><td>version</td><td>Release version.</td><td>1.4.0-</td></tr>
229
    <tr><td>maximumConnectionAge</td><td> </td><td>120000</td></tr>
230
    <tr><td>maximumConnectionTime</td><td> </td><td>60000</td></tr>
231
    <tr><td>maximumUsageNumber</td><td> </td><td>100</td></tr>
232
    <tr><td>runDBConnectionRecycleThread</td><td> </td><td>off</td></tr>
233
    <tr><td>cycleTimeOfDBConnection</td><td> </td><td>30000</td></tr>
234
    <tr><td>forcereplicationwaitingtime</td><td> </td><td></td></tr>
235
    <tr><td>eml2_0_0namespace</td><td>Namespace of EML 2.0.0 documents.</td><td>eml://ecoinformatics.org/eml-2.0.0</td></tr>
236
    <tr><td>eml2_0_1namespace</td><td>Namespace of EML 2.0.1 documents.</td><td>eml://ecoinformatics.org/eml-2.0.0</td></tr>
237
    <tr><td>eml2_1_0namespace</td><td>Namespace of EML 2.1.0 documents. Currently unused, reserved.</td><td>eml://ecoinformatics.org/eml-2.1.0</td></tr>
238
    <tr><td>physicaldoctype</td><td> </td><td>-//ecoinformatics.org//eml-physical-2.0.0beta6//EN, -//ecoinformatics.org//eml-physical-2.0.0beta4//EN</td></tr>
239
    <tr><td>entitydoctype</td><td> </td><td>-//ecoinformatics.org//eml-entity-2.0.0beta6//EN, -//ecoinformatics.org//eml-entity-2.0.0beta4//EN</td></tr>
240
    <tr><td>packagedoctypeset</td><td> </td><td> </td></tr>
241
    <tr><td>httpserver</td><td> </td><td></td></tr>
242
    <tr><td>junittesturl</td><td>The url of the test server.</td><td></td></tr>
243
    <tr><td>replicationerrorlog</td><td> </td><td></td></tr>
244
    <tr><td>schemaPath</td><td>Path to installed XSD schemas.</td><td></td></tr>
245
    <tr><td>schemaURL</td><td>URL to installed XSD schemas.</td><td></td></tr>
246
    <tr><td>inlinedatafilepath</td><td>Path for storing data that was extracted from <code>inline</code> element of EML documents.</td><td></td></tr>
247
    <tr><td>context</td><td>The name of the servlet context</td><td></td></tr>
248
    <tr><td>debuglevel</td><td>Verbosity of debugging messages.  Higher numbers means more debugging detail.</td><td></td></tr>
249
    <tr><td>datafileflag</td><td> </td><td>datafile</td></tr>
250
    <tr><td>datafilesizelimit</td><td>Limit on file size for uploaded data files.</td><td>1000</td></tr>
251
    <tr><td>defaultcontenttype</td><td> </td><td></td></tr>
252
    <tr><td>query.ignored.params</td><td>Parameters that are passed through to XSLT style sheets without modification.</td><td>enableediting,foo</td></tr>
253
    <tr><td>usexmlindex</td><td>Flag indicating whether to use the traditional xml_index table or not.  This needs to be set on startup, and once set to false can not be changed back to true without significant database modifications.  Setting this option to 'false' also slows down queries significantly, but it does allow arbitrarily deep dcoument paths.  Not recommended to change this setting -- data loss may result.</td><td>true</td></tr>
254
    <tr><td>resultsetsize</td><td> </td><td>40</td></tr>
211 255
  </table>
212 256
  
213 257
  <br>
docs/user/metacatinstall.html
201 201
  <code>database</code>, <code>jdbc-connect</code>, <code>jdbc-base</code>, 
202 202
  <code>user</code>, <code>password</code>, <code>datafilepath</code>, 
203 203
  <code>inlinedatafilepath</code>, <code>cvsroot</code>, 
204
  <code>cvsroot-alternate</code>, and <code>default-style</code>. 
204
  <code>cvsroot-alternate</code>, <code>default-style</code>, and
205
  <code>administrators</code>. 
205 206
  Each is described in detail in the table below.
206 207
  </p>
207 208
  Properties you will likely need to change:
......
223 224
    <tr>
224 225
      <td>tomcatversion</td>
225 226
      <td>The tomcatversion property is the version of your Tomcat. You should 
226
          put tomcat3 or tomcat4 here.</td>
227
          put tomcat3, tomcat4, or tomcat5 here. We have most extensively 
228
          tested Tomcat 4.x, but Tomcat 5.x seems to work fine as well.
229
      </td>
227 230
      <td>Default:&nbsp;&nbsp;
228 231
          <code>tomcat4</code>
229 232
      <br><br>Example:&nbsp;&nbsp;
......
257 260
    </tr>
258 261
    <tr>
259 262
      <td>server</td>
260
      <td>The server property is the secure HTTPS address on which Metacat is 
263
      <td>The server property is hostname of for the server on which Metacat is 
261 264
          running (note that you should not include the 'http://' in the server 
262
          property). The server setting should include the SSL port number 
263
          appended to the end if Tomcat is running stand-alone (see example).</td>
265
          property). The server setting should include the port number 
266
          appended to the end if Tomcat is running stand-alone (see example).
267
      </td>
264 268
      <td>Default:&nbsp;&nbsp;
265 269
         <code>knb.ecoinformatics.org</code>
266 270
      <br><br>Example:&nbsp;&nbsp;
267
         <code>somehost.university.edu:8443</code>
271
         <code>somehost.university.edu:8080</code>
268 272
      </td>
269 273
    </tr>
270 274
    <tr>
271 275
      <td>httpserver</td>
272 276
      <td>httpserver is the plain HTTP address on which Metacat is running 
273
          (note that you should not include the 'http://' in the httpserver property).
277
          (note that you should not include the 'http://' in the httpserver 
278
          property).
274 279
          The httpserver setting should include the HTTP plain port number 
275 280
          appended to the end if Tomcat is running stand-alone (see example).</td>
276 281
      <td>Default:&nbsp;&nbsp;
......
281 286
    </tr>
282 287
    <tr>
283 288
      <td>ldapUrl</td>
284
      <td>URL to the LDAP server</td>
289
      <td>URL to the LDAP server. The LDAP server is used in the default
290
          authentication module to authenticate and identify users of the
291
          system.  To participate in the KNB network, you should leave this at
292
          the default.  But it can be changed if you want to use a 
293
          different directory of users.
294
      </td>
285 295
      <td>Default:&nbsp;&nbsp;
286 296
          <code>ldap://ldap.ecoinformatics.org/dc=ecoinformatics,dc=org</code>
287 297
      </td>
......
290 300
      <td>database</td>
291 301
      <td>Select the database to use for metadata storage.
292 302
          Valid values are <code>oracle</code>, <code>postgresql</code>, or
293
          <code>sqlserver</code>.
303
          <code>sqlserver</code>. Note that sqlserver support is minimal and
304
          probably will not work without substantial changes on your part,
305
          possibly including code changes.  We have not revcently tested on 
306
          sqlserver.
294 307
      </td>
295 308
      <td>Default:&nbsp;&nbsp;
296 309
          <code>oracle</code>
......
335 348
    </tr>
336 349
    <tr>
337 350
      <td>datafilepath</td>
338
      <td>The datafilepath is the directory to store the data file.</td>
351
      <td>The datafilepath is the directory to store data files.</td>
339 352
      <td>Default:&nbsp;&nbsp;
340 353
          <code>/var/metacat/data</code>
341 354
      <br><br>Example:&nbsp;&nbsp;
......
344 357
    </tr>
345 358
    <tr>
346 359
      <td>inlinedatafilepath</td>
347
      <td>The inlinedatafilepath is the directory to store inline data.</td>
360
      <td>The inlinedatafilepath is the directory to store inline data that
361
          has been extracted from EML documents.</td>
348 362
      <td>Default:&nbsp;&nbsp;
349 363
          <code>/var/metacat/inline-data</code>
350 364
      <br><br>Example:&nbsp;&nbsp;
......
353 367
    </tr>
354 368
    <tr>
355 369
      <td>cvsroot</td>
356
      <td>CVS access to retrieve latest EML.</td>
370
      <td>CVS access to retrieve latest EML. Only used by
371
          developers in building the release.</td>
357 372
      <td>Default:&nbsp;&nbsp;
358 373
          <code><pre>:ext:${env.USER}@cvs.ecoinformatics.org:/cvs</pre></code>
359 374
          Example:&nbsp;&nbsp;
......
362 377
    </tr>
363 378
    <tr>
364 379
      <td>cvsroot-alternate</td>
365
      <td>CVS access to retrieve latest conversion styles.</td>
380
      <td>CVS access to retrieve latest conversion styles. Only used by
381
          developers in building the release.</td>
366 382
      <td>Default:&nbsp;&nbsp;
367 383
          <code><pre>:ext:${env.USER}@cvs.nceas.ucsb.edu:/cvs/pbi</pre></code>
368 384
          Example:&nbsp;&nbsp;
......
382 398
          <pre><code>default   esa   knb2   nceas   nrs   obfs   specnet</code></pre>
383 399
      </td>
384 400
    </tr>
401
    <tr>
402
      <td>administrators</td>
403
      <td>The administrators parameter lists the accounts that are allowed to
404
          perform administrative actions such as rebuilding indices for 
405
          documents. The list can can contain more than one account separated
406
          by colons.</td>
407
      <td>Default:&nbsp;&nbsp;
408
          <code>uid=jones,o=NCEAS,dc=ecoinformatics,dc=org</code>
409
      <br><br>Examples:&nbsp;&nbsp;
410
          <code>uid=localadmin,o=ucnrs.org</code>
411
      </td>
412
    </tr>
385 413
  </table>
386 414
  <br>
387 415
  <p>
......
476 504
  </p>
477 505
  <p>
478 506
   If the script has run correctly you should be able to type 
479
   <pre>describe xml_documents</pre> and it should tell you
507
   <pre>describe xml_documents</pre> and it should show:
480 508
   <pre>
481 509
    Name            Null?         Type
482 510
    --------------  ------------  ---------------- 

Also available in: Unified diff