New GILS doc.
[idzebra-moved-to-github.git] / doc / gils.sgml
index cff66e4..eb293ff 100644 (file)
@@ -1,13 +1,13 @@
 <!doctype linuxdoc system>
 
 <!--
-  $Id: gils.sgml,v 1.2 1996-05-07 12:29:36 quinn Exp $
+  $Id: gils.sgml,v 1.3 1996-05-09 09:59:42 quinn Exp $
 -->
 
 <article>
 <title>Serving GILS Records with Zebra
 <author><htmlurl url="http://www.indexdata.dk/" name="Index Data">, <tt><htmlurl url="mailto:info@index.ping.dk" name="info@index.ping.dk"></>
-<date>$Revision: 1.2 $
+<date>$Revision: 1.3 $
 <abstract>
 This document explains how to set up a simple database of Government
 Information Locator Records using the Zebra retrieval engine and
@@ -307,5 +307,31 @@ consistent.
 <sect>Creating Your Own Database
 
 <p>
+Whenever we create a new database with Zebra, we find it useful to
+first set up a new, empty directory. This directory will contain the
+configuration file, the lock files maintained by Zebra (unless you
+specify a different location for these), and any logs of updates and
+server runs that you may wish to keep around. The first thing to do is
+set up the <tt/zebra.cfg/ file for your database. You can copy the one
+from the <tt/test/ directory, or you can create a new one using the
+example settings described in the previous section. Once you get your
+server up and running, you may want to read the description of the
+<tt/zebra.cfg/ file in the general documentation, to set up additional
+defaults for database names, etc.
+
+If you copy one of thse files, you should be careful to update the
+pathnames to reflect the setup of your own database. In particular, if
+you want to specify one or more directories for the register files
+and/or the shadow files, you should make sure that these directories
+exist and are accessible to the user ID which will run the Zebra
+processes.
+
+You need to make sure that your GILS records are available, too. For
+small to medium-sized (say, less than 100,000 records) databases, it
+is frequently useful to maintain the records as individual files
+someplace in the file system. Zebra will, by default, access these
+files directly whenever the user requests to see a specific record.
+However, you can set up Zebra to maintain the database records in
+other ways, too. Consult the general documentation for details.
 
 </article>