1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>2.The Zebra Configuration File</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"><link rel="home" href="index.html" title="Zebra - User's Guide and Reference"><link rel="up" href="administration.html" title="Chapter6.Administrating Zebra"><link rel="prev" href="administration.html" title="Chapter6.Administrating Zebra"><link rel="next" href="locating-records.html" title="3.Locating Records"></head><body><link rel="stylesheet" type="text/css" href="common/style1.css"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">2.The <span class="application">Zebra</span> Configuration File</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="administration.html">Prev</a></td><th width="60%" align="center">Chapter6.Administrating <span class="application">Zebra</span></th><td width="20%" align="right"><a accesskey="n" href="locating-records.html">Next</a></td></tr></table><hr></div><div class="sect1"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a name="zebra-cfg"></a>2.The <span class="application">Zebra</span> Configuration File</h2></div></div></div><p>
The <span class="application">Zebra</span> configuration file, read by <code class="literal">zebraidx</code> and
<code class="literal">zebrasrv</code> defaults to <code class="literal">zebra.cfg</code>
unless specified by <code class="literal">-c</code> option.
</p><p>
You can edit the configuration file with a normal text editor.
parameter names and values are separated by colons in the file. Lines
starting with a hash sign (<code class="literal">#</code>) are
treated as comments.
</p><p>
If you manage different sets of records that share common
characteristics, you can organize the configuration settings for each
type into "groups".
When <code class="literal">zebraidx</code> is run and you wish to address a
given group you specify the group name with the <code class="literal">-g</code>
option.
In this case settings that have the group name as their prefix
will be used by <code class="literal">zebraidx</code>.
If no <code class="literal">-g</code> option is specified, the settings
without prefix are used.
</p><p>
In the configuration file, the group name is placed before the option
name itself, separated by a dot (.). For instance, to set the record type
for group <code class="literal">public</code> to <code class="literal">grs.sgml</code>
(the <acronym class="acronym">SGML</acronym>-like format for structured records) you would write:
</p><p>
</p><pre class="screen">
public.recordType: grs.sgml
</pre><p>
</p><p>
To set the default value of the record type to <code class="literal">text</code>
write:
</p><p>
</p><pre class="screen">
recordType: text
</pre><p>
</p><p>
The available configuration settings are summarized below. They will be
explained further in the following sections.
</p><p>
</p><div class="variablelist"><dl class="variablelist"><dt><span class="term">
<span class="emphasis"><em>group</em></span>
.recordType[<span class="emphasis"><em>.name</em></span>]:
<em class="replaceable"><code>type</code></em>
</span></dt><dd><p>
Specifies how records with the file extension
<span class="emphasis"><em>name</em></span> should be handled by the indexer.
This option may also be specified as a command line option
(<code class="literal">-t</code>). Note that if you do not specify a
<span class="emphasis"><em>name</em></span>, the setting applies to all files.
In general, the record type specifier consists of the elements (each
element separated by dot), <span class="emphasis"><em>fundamental-type</em></span>,
<span class="emphasis"><em>file-read-type</em></span> and arguments. Currently, two
fundamental types exist, <code class="literal">text</code> and
<code class="literal">grs</code>.
</p></dd><dt><span class="term"><span class="emphasis"><em>group</em></span>.recordId:
<em class="replaceable"><code>record-id-spec</code></em></span></dt><dd><p>
Specifies how the records are to be identified when updated. See
<a class="xref" href="locating-records.html" title="3.Locating Records">Section3, “Locating Records”</a>.
</p></dd><dt><span class="term"><span class="emphasis"><em>group</em></span>.database:
<em class="replaceable"><code>database</code></em></span></dt><dd><p>
Specifies the <acronym class="acronym">Z39.50</acronym> database name.
</p></dd><dt><span class="term"><span class="emphasis"><em>group</em></span>.storeKeys:
<em class="replaceable"><code>boolean</code></em></span></dt><dd><p>
Specifies whether key information should be saved for a given
group of records. If you plan to update/delete this type of
records later this should be specified as 1; otherwise it
should be 0 (default), to save register space.
See <a class="xref" href="file-ids.html" title="5.Indexing with File Record IDs">Section5, “Indexing with File Record IDs”</a>.
</p></dd><dt><span class="term"><span class="emphasis"><em>group</em></span>.storeData:
<em class="replaceable"><code>boolean</code></em></span></dt><dd><p>
Specifies whether the records should be stored internally
in the <span class="application">Zebra</span> system files.
If you want to maintain the raw records yourself,
this option should be false (0).
If you want <span class="application">Zebra</span> to take care of the records for you, it
should be true(1).
</p></dd><dt><span class="term">register: <em class="replaceable"><code>register-location</code></em></span></dt><dd><p>
Specifies the location of the various register files that <span class="application">Zebra</span> uses
to represent your databases.
See <a class="xref" href="register-location.html" title="7.Register Location">Section7, “Register Location”</a>.
</p></dd><dt><span class="term">shadow: <em class="replaceable"><code>register-location</code></em></span></dt><dd><p>
Enables the <span class="emphasis"><em>safe update</em></span> facility of <span class="application">Zebra</span>, and
tells the system where to place the required, temporary files.
See <a class="xref" href="shadow-registers.html" title="8.Safe Updating - Using Shadow Registers">Section8, “Safe Updating - Using Shadow Registers”</a>.
</p></dd><dt><span class="term">lockDir: <em class="replaceable"><code>directory</code></em></span></dt><dd><p>
Directory in which various lock files are stored.
</p></dd><dt><span class="term">keyTmpDir: <em class="replaceable"><code>directory</code></em></span></dt><dd><p>
Directory in which temporary files used during zebraidx's update
phase are stored.
</p></dd><dt><span class="term">setTmpDir: <em class="replaceable"><code>directory</code></em></span></dt><dd><p>
Specifies the directory that the server uses for temporary result sets.
If not specified <code class="literal">/tmp</code> will be used.
</p></dd><dt><span class="term">profilePath: <em class="replaceable"><code>path</code></em></span></dt><dd><p>
Specifies a path of profile specification files.
The path is composed of one or more directories separated by
colon. Similar to <code class="literal">PATH</code> for UNIX systems.
</p></dd><dt><span class="term">modulePath: <em class="replaceable"><code>path</code></em></span></dt><dd><p>
Specifies a path of record filter modules.
The path is composed of one or more directories separated by
colon. Similar to <code class="literal">PATH</code> for UNIX systems.
The 'make install' procedure typically puts modules in
<code class="filename">/usr/local/lib/idzebra-2.0/modules</code>.
</p></dd><dt><span class="term">index: <em class="replaceable"><code>filename</code></em></span></dt><dd><p>
Defines the filename which holds fields structure
definitions. If omitted, the file <code class="filename">default.idx</code>
is read.
Refer to <a class="xref" href="fields-and-charsets.html#default-idx-file" title="1.The default.idx file">Section1, “The default.idx file”</a> for
more information.
</p></dd><dt><span class="term">sortmax: <em class="replaceable"><code>integer</code></em></span></dt><dd><p>
Specifies the maximum number of records that will be sorted
in a result set. If the result set contains more than
<em class="replaceable"><code>integer</code></em> records, records after the
limit will not be sorted. If omitted, the default value is
1,000.
</p></dd><dt><span class="term">staticrank: <em class="replaceable"><code>integer</code></em></span></dt><dd><p>
Enables whether static ranking is to be enabled (1) or
disabled (0). If omitted, it is disabled - corresponding
to a value of 0.
Refer to <a class="xref" href="administration-ranking.html#administration-ranking-static" title="9.2.Static Ranking">Section9.2, “Static Ranking”</a> .
</p></dd><dt><span class="term">estimatehits: <em class="replaceable"><code>integer</code></em></span></dt><dd><p>
Controls whether <span class="application">Zebra</span> should calculate approximate hit counts and
at which hit count it is to be enabled.
A value of 0 disables approximate hit counts.
For a positive value approximate hit count is enabled
if it is known to be larger than <em class="replaceable"><code>integer</code></em>.
</p><p>
Approximate hit counts can also be triggered by a particular
attribute in a query.
Refer to <a class="xref" href="querymodel-zebra.html#querymodel-zebra-global-attr-limit" title="3.2.5.Global Approximative Limit Attribute (type 12)">Section3.2.5, “Global Approximative Limit Attribute (type 12)”</a>.
</p></dd><dt><span class="term">attset: <em class="replaceable"><code>filename</code></em></span></dt><dd><p>
Specifies the filename(s) of attribute set files for use in
searching. In many configurations <code class="filename">bib1.att</code>
is used, but that is not required. If Classic Explain
attributes is to be used for searching,
<code class="filename">explain.att</code> must be given.
The path to att-files in general can be given using
<code class="literal">profilePath</code> setting.
See also <a class="xref" href="grs-conf.html#attset-files" title="3.4.The Attribute Set (.att) Files">Section3.4, “The Attribute Set (.att) Files”</a>.
</p></dd><dt><span class="term">memMax: <em class="replaceable"><code>size</code></em></span></dt><dd><p>
Specifies <em class="replaceable"><code>size</code></em> of internal memory
to use for the zebraidx program.
The amount is given in megabytes - default is 8 (8 MB).
The more memory, the faster large updates happen, up to about
half the free memory available on the computer.
</p></dd><dt><span class="term">tempfiles: <em class="replaceable"><code>Yes/Auto/No</code></em></span></dt><dd><p>
Tells zebra if it should use temporary files when indexing. The
default is Auto, in which case zebra uses temporary files only
if it would need more that <em class="replaceable"><code>memMax</code></em>
megabytes of memory. This should be good for most uses.
</p></dd><dt><span class="term">root: <em class="replaceable"><code>dir</code></em></span></dt><dd><p>
Specifies a directory base for <span class="application">Zebra</span>. All relative paths
given (in profilePath, register, shadow) are based on this
directory. This setting is useful if your <span class="application">Zebra</span> server
is running in a different directory from where
<code class="literal">zebra.cfg</code> is located.
</p></dd><dt><span class="term">passwd: <em class="replaceable"><code>file</code></em></span></dt><dd><p>
Specifies a file with description of user accounts for <span class="application">Zebra</span>.
The format is similar to that known to Apache's htpasswd files
and UNIX' passwd files. Non-empty lines not beginning with
# are considered account lines. There is one account per-line.
A line consists of fields separate by a single colon character.
First field is username, second is password.
</p></dd><dt><span class="term">passwd.c: <em class="replaceable"><code>file</code></em></span></dt><dd><p>
Specifies a file with description of user accounts for <span class="application">Zebra</span>.
File format is similar to that used by the passwd directive except
that the password are encrypted. Use Apache's htpasswd or similar
for maintenance.
</p></dd><dt><span class="term">perm.<em class="replaceable"><code>user</code></em>:
<em class="replaceable"><code>permstring</code></em></span></dt><dd><p>
Specifies permissions (privilege) for a user that are allowed
to access <span class="application">Zebra</span> via the passwd system. There are two kinds
of permissions currently: read (r) and write(w). By default
users not listed in a permission directive are given the read
privilege. To specify permissions for a user with no
username, or <acronym class="acronym">Z39.50</acronym> anonymous style use
<code class="literal">anonymous</code>. The permstring consists of
a sequence of characters. Include character <code class="literal">w</code>
for write/update access, <code class="literal">r</code> for read access and
<code class="literal">a</code> to allow anonymous access through this account.
</p></dd><dt><span class="term">dbaccess: <em class="replaceable"><code>accessfile</code></em></span></dt><dd><p>
Names a file which lists database subscriptions for individual users.
The access file should consists of lines of the form
<code class="literal">username: dbnames</code>, where dbnames is a list of
database names, separated by '+'. No whitespace is allowed in the
database list.
</p></dd><dt><span class="term">encoding: <em class="replaceable"><code>charsetname</code></em></span></dt><dd><p>
Tells <span class="application">Zebra</span> to interpret the terms in Z39.50 queries as
having been encoded using the specified character
encoding. The default is <code class="literal">ISO-8859-1</code>; one
useful alternative is <code class="literal">UTF-8</code>.
</p></dd><dt><span class="term">storeKeys: <em class="replaceable"><code>value</code></em></span></dt><dd><p>
Specifies whether <span class="application">Zebra</span> keeps a copy of indexed keys.
Use a value of 1 to enable; 0 to disable. If storeKeys setting is
omitted, it is enabled. Enabled storeKeys
are required for updating and deleting records. Disable only
storeKeys to save space and only plan to index data once.
</p></dd><dt><span class="term">storeData: <em class="replaceable"><code>value</code></em></span></dt><dd><p>
Specifies whether <span class="application">Zebra</span> keeps a copy of indexed records.
Use a value of 1 to enable; 0 to disable. If storeData setting is
omitted, it is enabled. A storeData setting of 0 (disabled) makes
Zebra fetch records from the original locaction in the file
system using filename, file offset and file length. For the
DOM and ALVIS filter, the storeData setting is ignored.
</p></dd></dl></div><p>
</p></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="administration.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="administration.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="locating-records.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">Chapter6.Administrating <span class="application">Zebra</span></td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">3.Locating Records</td></tr></table></div></body></html>
|
