]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-index.pod
searchidx: die on cat-file failures
[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 =head1 DESCRIPTION
10
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.
16
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.
20
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.
25
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.
30
31 =head1 OPTIONS
32
33 =over
34
35 =item --compact / -c
36
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.
40
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.
44
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.
48
49 =item --reindex
50
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
57 release free space.
58
59 This does not touch the NNTP article number database or
60 affect threading.
61
62 =item --prune
63
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.
68
69 =back
70
71 =head1 FILES
72
73 For v1 (ssoma) repositories described in L<public-inbox-v1-format>.
74 All public-inbox-specific files are contained within the
75 C<$GIT_DIR/public-inbox/> directory.
76
77 v2 inboxes are described in L<public-inbox-v2-format>.
78
79 =head1 ENVIRONMENT
80
81 =over 8
82
83 =item PI_CONFIG
84
85 Used to override the default "~/.public-inbox/config" value.
86
87 =item XAPIAN_FLUSH_THRESHOLD
88
89 The number of documents to update before committing changes to
90 disk.  This environment is handled directly by Xapian, refer to
91 Xapian API documentation for more details.
92
93 Default: our indexing code flushes every megabyte of mail seen
94 to keep memory usage low.  Setting this environment variable to
95 any positive value will switch to a document count-based
96 threshold in Xapian.
97
98 =back
99
100 =head1 UPGRADING
101
102 Occasionally, public-inbox will update it's schema version and
103 require a full index by running this command.
104
105 =head1 CONTACT
106
107 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
108
109 The mail archives are hosted at L<https://public-inbox.org/meta/>
110 and L<http://hjrcffqmbrq6wope.onion/meta/>
111
112 =head1 COPYRIGHT
113
114 Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
115
116 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
117
118 =head1 SEE ALSO
119
120 L<Search::Xapian>, L<DBD::SQLite>