3 public-inbox-index - create and update search indices
7 public-inbox-index [OPTIONS] INBOX_DIR...
11 public-inbox-index creates and updates the search, overview and
12 NNTP article number database used by the read-only public-inbox
13 HTTP and NNTP interfaces. Currently, this requires
14 L<DBD::SQLite> and L<DBI> Perl modules. L<Search::Xapian>
15 is optional, only to support the PSGI search interface.
17 Once the initial indices are created by public-inbox-index,
18 L<public-inbox-mda(1)> and L<public-inbox-watch(1)> will
19 automatically maintain them.
21 Running this manually to update indices is only required if
22 relying on L<git-fetch(1)> to mirror an existing public-inbox;
23 or if upgrading to a new version of public-inbox using
24 the C<--reindex> option.
26 Having the overview and article number database is essential to
27 running the NNTP interface, and strongly recommended for the
28 HTTP interface as it provides thread grouping in addition to
29 normal search functionality.
37 Compacts the Xapian DBs after indexing. This is recommended
38 when using C<--reindex> to avoid running out of disk space
39 while indexing multiple inboxes.
41 While option takes a negligible amount of time compared to
42 C<--reindex>, it requires temporarily duplicating the entire
43 contents of the Xapian DB.
45 This switch may be specified twice, in which case compaction
46 happens both before and after indexing to minimize the temporal
47 footprint of the (re)indexing operation.
51 Forces a re-index of all messages in the inbox.
52 This can be used for in-place upgrades and bugfixes while
53 NNTP/HTTP server processes are utilizing the index. Keep in
54 mind this roughly doubles the size of the already-large
55 Xapian database. Using this with C<--compact> or running
56 L<public-inbox-compact(1)> afterwards is recommended to
59 This does not touch the NNTP article number database or
64 Run L<git-gc(1)> to prune and expire reflogs if discontiguous history
65 is detected. This is intended to be used in mirrors after running
66 L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
67 is expunged from mirrors.
71 Sets or overrides L</publicinbox.indexMaxSize> on a
72 per-invocation basis. See L</publicinbox.indexMaxSize>
79 For v1 (ssoma) repositories described in L<public-inbox-v1-format>.
80 All public-inbox-specific files are contained within the
81 C<$GIT_DIR/public-inbox/> directory.
83 v2 inboxes are described in L<public-inbox-v2-format>.
89 =item publicinbox.indexMaxSize
91 Prevents indexing of messages larger than the specified size
92 value. A single suffix modifier of C<k>, C<m> or C<g> is
93 supported, thus the value of C<1m> to prevents indexing of
94 messages larger than one megabyte.
96 This is useful for avoiding memory exhaustion in mirrors.
97 This option is only available in public-inbox 1.5 or later.
109 Used to override the default "~/.public-inbox/config" value.
111 =item XAPIAN_FLUSH_THRESHOLD
113 The number of documents to update before committing changes to
114 disk. This environment is handled directly by Xapian, refer to
115 Xapian API documentation for more details.
117 Default: our indexing code flushes every megabyte of mail seen
118 to keep memory usage low. Setting this environment variable to
119 any positive value will switch to a document count-based
126 Occasionally, public-inbox will update it's schema version and
127 require a full index by running this command.
131 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
133 The mail archives are hosted at L<https://public-inbox.org/meta/>
134 and L<http://hjrcffqmbrq6wope.onion/meta/>
138 Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
140 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
144 L<Search::Xapian>, L<DBD::SQLite>