]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-index.pod
doc: update authentication notes for lei
[public-inbox.git] / Documentation / public-inbox-index.pod
1 =head1 NAME
2
3 public-inbox-index - create and update search indices
4
5 =head1 SYNOPSIS
6
7 public-inbox-index [OPTIONS] INBOX_DIR...
8
9 public-inbox-index [OPTIONS] --all
10
11 =head1 DESCRIPTION
12
13 public-inbox-index creates and updates the search, overview and
14 NNTP article number database used by the read-only public-inbox
15 HTTP and NNTP interfaces.  Currently, this requires
16 L<DBD::SQLite> and L<DBI> Perl modules.  L<Search::Xapian>
17 is optional, only to support the PSGI search interface.
18
19 Once the initial indices are created by public-inbox-index,
20 L<public-inbox-mda(1)> and L<public-inbox-watch(1)> will
21 automatically maintain them.
22
23 Running this manually to update indices is only required if
24 relying on L<git-fetch(1)> to mirror an existing public-inbox;
25 or if upgrading to a new version of public-inbox using
26 the C<--reindex> option.
27
28 Having the overview and article number database is essential to
29 running the NNTP interface, and strongly recommended for the
30 HTTP interface as it provides thread grouping in addition to
31 normal search functionality.
32
33 =head1 OPTIONS
34
35 =over
36
37 =item -j JOBS
38
39 =item --jobs=JOBS
40
41 Influences the number of Xapian indexing shards in a
42 (L<public-inbox-v2-format(5)>) inbox.
43
44 See L<public-inbox-init(1)/--jobs> for a full description
45 of sharding.
46
47 C<--jobs=0> is accepted as of public-inbox 1.6.0
48 to disable parallel indexing regardless of the number of
49 pre-existing shards.
50
51 If the inbox has not been indexed or initialized, C<JOBS - 1>
52 shards will be created (one job is always needed for indexing
53 the overview and article number mapping).
54
55 Default: the number of existing Xapian shards
56
57 =item -c
58
59 =item --compact
60
61 Compacts the Xapian DBs after indexing.  This is recommended
62 when using C<--reindex> to avoid running out of disk space
63 while indexing multiple inboxes.
64
65 While option takes a negligible amount of time compared to
66 C<--reindex>, it requires temporarily duplicating the entire
67 contents of the Xapian DB.
68
69 This switch may be specified twice, in which case compaction
70 happens both before and after indexing to minimize the temporal
71 footprint of the (re)indexing operation.
72
73 Available since public-inbox 1.4.0.
74
75 =item --reindex
76
77 Forces a re-index of all messages in the inbox.
78 This can be used for in-place upgrades and bugfixes while
79 NNTP/HTTP server processes are utilizing the index.  Keep in
80 mind this roughly doubles the size of the already-large
81 Xapian database.  Using this with C<--compact> or running
82 L<public-inbox-compact(1)> afterwards is recommended to
83 release free space.
84
85 public-inbox protects writes to various indices with
86 L<flock(2)>, so it is safe to reindex (and rethread) while
87 L<public-inbox-watch(1)>, L<public-inbox-mda(1)> or
88 L<public-inbox-learn(1)> run.
89
90 This does not touch the NNTP article number database.
91 It does not affect threading unless C<--rethread> is
92 used.
93
94 =item --all
95
96 Index all inboxes configured in ~/.public-inbox/config.
97 This is an alternative to specifying individual inboxes directories
98 on the command-line.
99
100 =item --rethread
101
102 Regenerate internal THREADID and message thread associations
103 when reindexing.
104
105 This fixes some bugs in older versions of public-inbox.  While
106 it is possible to use this without C<--reindex>, it makes little
107 sense to do so.
108
109 Available in public-inbox 1.6.0+.
110
111 =item --prune
112
113 Run L<git-gc(1)> to prune and expire reflogs if discontiguous history
114 is detected.  This is intended to be used in mirrors after running
115 L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
116 is expunged from mirrors.
117
118 Available since public-inbox 1.2.0.
119
120 =item --max-size SIZE
121
122 Sets or overrides L</publicinbox.indexMaxSize> on a
123 per-invocation basis.  See L</publicinbox.indexMaxSize>
124 below.
125
126 Available since public-inbox 1.5.0.
127
128 =item --batch-size SIZE
129
130 Sets or overrides L</publicinbox.indexBatchSize> on a
131 per-invocation basis.  See L</publicinbox.indexBatchSize>
132 below.
133
134 When using rotational storage but abundant RAM, using a large
135 value (e.g. C<500m>) with C<--sequential-shard> can
136 significantly speed up and reduce fragmentation during the
137 initial index and full C<--reindex> invocations (but not
138 incremental updates).
139
140 Available in public-inbox 1.6.0+.
141
142 =item --no-fsync
143
144 Disables L<fsync(2)> and L<fdatasync(2)> operations on SQLite
145 and Xapian.  This is only effective with Xapian 1.4+.  This is
146 primarily intended for systems with low RAM and the small
147 (default) C<--batch-size=1m>.  Users of large C<--batch-size>
148 may even find disabling L<fdatasync(2)> causes too much dirty
149 data to accumulate, resulting on latency spikes from writeback.
150
151 Available in public-inbox 1.6.0+.
152
153 =item --sequential-shard
154
155 Sets or overrides L</publicinbox.indexSequentialShard> on a
156 per-invocation basis.  See L</publicinbox.indexSequentialShard>
157 below.
158
159 Available in public-inbox 1.6.0+.
160
161 =item --skip-docdata
162
163 Stop storing document data in Xapian on an existing inbox.
164
165 See L<public-inbox-init(1)/--skip-docdata> for description and caveats.
166
167 Available in public-inbox 1.6.0+.
168
169 =item -E EXTINDEX
170
171 =item --update-extindex=EXTINDEX
172
173 Update the given external index (L<public-inbox-extindex-format(5)>.
174 Either the configured section name (e.g. C<all>) or a directory name
175 may be specified.
176
177 Defaults to C<all> if C<[extindex "all"]> is configured,
178 otherwise no external indices are updated.
179
180 May be specified multiple times in rare cases where multiple
181 external indices are configured.
182
183 =item --no-update-extindex
184
185 Do not update the C<all> external index by default.  This negates
186 all uses of C<-E> / C<--update-extindex=> on the command-line.
187
188 =back
189
190 =head1 FILES
191
192 For v1 (ssoma) repositories described in L<public-inbox-v1-format(5)>.
193 All public-inbox-specific files are contained within the
194 C<$GIT_DIR/public-inbox/> directory.
195
196 v2 inboxes are described in L<public-inbox-v2-format(5)>.
197
198 =head1 CONFIGURATION
199
200 =over 8
201
202 =item publicinbox.indexMaxSize
203
204 Prevents indexing of messages larger than the specified size
205 value.  A single suffix modifier of C<k>, C<m> or C<g> is
206 supported, thus the value of C<1m> to prevents indexing of
207 messages larger than one megabyte.
208
209 This is useful for avoiding memory exhaustion in mirrors
210 via git.  It does not prevent L<public-inbox-mda(1)> or
211 L<public-inbox-watch(1)> from importing (and indexing)
212 a message.
213
214 This option is only available in public-inbox 1.5 or later.
215
216 Default: none
217
218 =item publicinbox.indexBatchSize
219
220 Flushes changes to the filesystem and releases locks after
221 indexing the given number of bytes.  The default value of C<1m>
222 (one megabyte) is low to minimize memory use and reduce
223 contention with parallel invocations of L<public-inbox-mda(1)>,
224 L<public-inbox-learn(1)>, and L<public-inbox-watch(1)>.
225
226 Increase this value on powerful systems to improve throughput at
227 the expense of memory use.  The reduction of lock granularity
228 may not be noticeable on fast systems.  With SSDs, values above
229 C<4m> have little benefit.
230
231 For L<public-inbox-v2-format(5)> inboxes, this value is
232 multiplied by the number of Xapian shards.  Thus a typical v2
233 inbox with 3 shards will flush every 3 megabytes by default
234 unless parallelism is disabled via C<--sequential-shard>
235 or C<--jobs=0>.
236
237 This influences memory usage of Xapian, but it is not exact.
238 The actual memory used by Xapian and Perl has been observed
239 in excess of 10x this value.
240
241 This option is available in public-inbox 1.6 or later.
242 public-inbox 1.5 and earlier used the current default, C<1m>.
243
244 Default: 1m (one megabyte)
245
246 =item publicinbox.indexSequentialShard
247
248 For L<public-inbox-v2-format(5)> inboxes, setting this to C<true>
249 allows indexing Xapian shards in multiple passes.  This speeds up
250 indexing on rotational storage with high seek latency by allowing
251 individual shards to fit into the kernel page cache.
252
253 Using a higher-than-normal number of C<--jobs> with
254 L<public-inbox-init(1)> may be required to ensure individual
255 shards are small enough to fit into cache.
256
257 Warning: interrupting C<public-inbox-index(1)> while this option
258 is in use may leave the search indices out-of-date with respect
259 to SQLite databases.  WWW and IMAP users may notice incomplete
260 search results, but it is otherwise non-fatal.  Using C<--reindex>
261 will bring everything back up-to-date.
262
263 Available in public-inbox 1.6.0+.
264
265 This is ignored on L<public-inbox-v1-format(5)> inboxes.
266
267 Default: false, shards are indexed in parallel
268
269 =item publicinbox.<name>.indexSequentialShard
270
271 Identical to L</publicinbox.indexSequentialShard>,
272 but only affect the inbox matching E<lt>nameE<gt>.
273
274 =back
275
276 =head1 ENVIRONMENT
277
278 =over 8
279
280 =item PI_CONFIG
281
282 Used to override the default "~/.public-inbox/config" value.
283
284 =item XAPIAN_FLUSH_THRESHOLD
285
286 The number of documents to update before committing changes to
287 disk.  This environment is handled directly by Xapian, refer to
288 Xapian API documentation for more details.
289
290 For public-inbox 1.6 and later, use C<publicinbox.indexBatchSize>
291 instead.
292
293 Setting C<XAPIAN_FLUSH_THRESHOLD> or
294 C<publicinbox.indexBatchSize> for a large C<--reindex> may cause
295 L<public-inbox-mda(1)>, L<public-inbox-learn(1)> and
296 L<public-inbox-watch(1)> tasks to wait long and unpredictable
297 periods of time during C<--reindex>.
298
299 Default: none, uses C<publicinbox.indexBatchSize>
300
301 =back
302
303 =head1 UPGRADING
304
305 Occasionally, public-inbox will update it's schema version and
306 require a full index by running this command.
307
308 =head1 CONTACT
309
310 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
311
312 The mail archives are hosted at L<https://public-inbox.org/meta/> and
313 L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
314
315 =head1 COPYRIGHT
316
317 Copyright 2016-2021 all contributors L<mailto:meta@public-inbox.org>
318
319 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
320
321 =head1 SEE ALSO
322
323 L<Search::Xapian>, L<DBD::SQLite>, L<public-inbox-extindex-format(5)>