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 --jobs=JOBS, -j
  36
  37 Control the number of Xapian indexing jobs in a
  38 (L<public-inbox-v2-format(5)>) inbox.
  39
  40 C<--jobs=0> is accepted as of public-inbox 1.6.0 (PENDING)
  41 to disable parallel indexing.
  42
  43 Default: the number of existing Xapian shards
  44
  45 =item --compact / -c
  46
  47 Compacts the Xapian DBs after indexing.  This is recommended
  48 when using C<--reindex> to avoid running out of disk space
  49 while indexing multiple inboxes.
  50
  51 While option takes a negligible amount of time compared to
  52 C<--reindex>, it requires temporarily duplicating the entire
  53 contents of the Xapian DB.
  54
  55 This switch may be specified twice, in which case compaction
  56 happens both before and after indexing to minimize the temporal
  57 footprint of the (re)indexing operation.
  58
  59 Available since public-inbox 1.4.0.
  60
  61 =item --reindex
  62
  63 Forces a re-index of all messages in the inbox.
  64 This can be used for in-place upgrades and bugfixes while
  65 NNTP/HTTP server processes are utilizing the index.  Keep in
  66 mind this roughly doubles the size of the already-large
  67 Xapian database.  Using this with C<--compact> or running
  68 L<public-inbox-compact(1)> afterwards is recommended to
  69 release free space.
  70
  71 public-inbox protects writes to various indices with
  72 L<flock(2)>, so it is safe to reindex (and rethread) while
  73 L<public-inbox-watch(1)>, L<public-inbox-mda(1)> or
  74 L<public-inbox-learn(1)> run.
  75
  76 This does not touch the NNTP article number database.
  77 It does not affect threading unless C<--rethread> is
  78 used.
  79
  80 =item --rethread
  81
  82 Regenerate internal THREADID and message thread associations
  83 when reindexing.
  84
  85 This fixes some bugs in older versions of public-inbox.  While
  86 it is possible to use this without C<--reindex>, it makes little
  87 sense to do so.
  88
  89 Available in public-inbox 1.6.0 (PENDING).
  90
  91 =item --prune
  92
  93 Run L<git-gc(1)> to prune and expire reflogs if discontiguous history
  94 is detected.  This is intended to be used in mirrors after running
  95 L<public-inbox-edit(1)> or L<public-inbox-purge(1)> to ensure data
  96 is expunged from mirrors.
  97
  98 Available since public-inbox 1.2.0.
  99
 100 =item --max-size SIZE
 101
 102 Sets or overrides L</publicinbox.indexMaxSize> on a
 103 per-invocation basis.  See L</publicinbox.indexMaxSize>
 104 below.
 105
 106 Available since public-inbox 1.5.0.
 107
 108 =item --batch-size SIZE
 109
 110 Sets or overrides L</publicinbox.indexBatchSize> on a
 111 per-invocation basis.  See L</publicinbox.indexBatchSize>
 112 below.
 113
 114 Available in public-inbox 1.6.0 (PENDING).
 115
 116 =back
 117
 118 =head1 FILES
 119
 120 For v1 (ssoma) repositories described in L<public-inbox-v1-format>.
 121 All public-inbox-specific files are contained within the
 122 C<$GIT_DIR/public-inbox/> directory.
 123
 124 v2 inboxes are described in L<public-inbox-v2-format>.
 125
 126 =head1 CONFIGURATION
 127
 128 =over 8
 129
 130 =item publicinbox.indexMaxSize
 131
 132 Prevents indexing of messages larger than the specified size
 133 value.  A single suffix modifier of C<k>, C<m> or C<g> is
 134 supported, thus the value of C<1m> to prevents indexing of
 135 messages larger than one megabyte.
 136
 137 This is useful for avoiding memory exhaustion in mirrors.
 138 This option is only available in public-inbox 1.5 or later.
 139
 140 Default: none
 141
 142 =item publicinbox.indexBatchSize
 143
 144 Flushes changes to the filesystem and releases locks after
 145 indexing the given number of bytes.  The default value of C<1m>
 146 (one megabyte) is low to minimize memory use and reduce
 147 contention with parallel invocations of L<public-inbox-mda(1)>,
 148 L<public-inbox-learn(1)>, and L<public-inbox-watch(1)>.
 149
 150 Increase this value on powerful systems to improve throughput at
 151 the expense of memory use.  The reduction of lock granularity
 152 may not be noticeable on fast systems.
 153
 154 This option is available in public-inbox 1.6 or later.
 155 public-inbox 1.5 and earlier used the current default, C<1m>.
 156
 157 For L<public-inbox-v2-format(5)> inboxes, this value is
 158 multiplied by the number of Xapian shards.  Thus a typical v2
 159 inbox with 3 shards will flush every 3 megabytes by default.
 160
 161 Default: 1m (one megabyte)
 162
 163 =back
 164
 165 =head1 ENVIRONMENT
 166
 167 =over 8
 168
 169 =item PI_CONFIG
 170
 171 Used to override the default "~/.public-inbox/config" value.
 172
 173 =item XAPIAN_FLUSH_THRESHOLD
 174
 175 The number of documents to update before committing changes to
 176 disk.  This environment is handled directly by Xapian, refer to
 177 Xapian API documentation for more details.
 178
 179 For public-inbox 1.6 and later, use C<publicinbox.indexBatchSize>
 180 instead.  Setting C<XAPIAN_FLUSH_THRESHOLD> for a large C<--reindex>
 181 may cause L<public-inbox-mda(1)>, L<public-inbox-learn(1)> and
 182 L<public-inbox-watch(1)> tasks to wait long periods of time
 183 during C<--reindex>.
 184
 185 Default: none, uses C<publicinbox.indexBatchSize>
 186
 187 =back
 188
 189 =head1 UPGRADING
 190
 191 Occasionally, public-inbox will update it's schema version and
 192 require a full index by running this command.
 193
 194 =head1 CONTACT
 195
 196 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 197
 198 The mail archives are hosted at L<https://public-inbox.org/meta/>
 199 and L<http://hjrcffqmbrq6wope.onion/meta/>
 200
 201 =head1 COPYRIGHT
 202
 203 Copyright 2016-2020 all contributors L<mailto:meta@public-inbox.org>
 204
 205 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 206
 207 =head1 SEE ALSO
 208
 209 L<Search::Xapian>, L<DBD::SQLite>