blob 2871f0dad7ba61bd80f69912db309e890b9ce190 3456 bytes (raw)
name: Documentation/public-inbox-index.pod # note: path name is non-authoritative(*)
public-inbox-index - create and update search indices
public-inbox-index [OPTIONS] GIT_DIR
public-inbox-index creates and updates the search and NNTP
article number database used by the read-only public-inbox HTTP
and NNTP interfaces. Currently, this requires L<Search::Xapian>
and L<DBD::SQlite> and L<DBI> Perl modules.
Once the initial indices are created by public-inbox-index,
L<public-inbox-mda(1)> and L<public-inbox-watch(1)> will
automatically maintain them.
Running this manually to update indices is only required if
relying on L<git-fetch(1)> to mirror an existing public-inbox;
or if upgrading to a new version of public-inbox using
the C<--reindex> option.
Having a search and article number database is essential to
running the NNTP interface, and strongly recommended for the
HTTP interface as it provides thread grouping in addition
to normal search functionality.
Forces a search engine re-index of all messages in the
repository. This can be used for in-place upgrades while
NNTP/HTTP server processes are utilizing the index. Keep in
mind this roughly doubles the size of the already-large
This does not touch the NNTP article number database.
All public-inbox-specific files are contained within the
C<$GIT_DIR/public-inbox/> directory. All files are expected to
grow in size as more messages are archived, so using compaction
commands (e.g. L<xapian-compact(1)>) is not recommended unless
the list is no longer active.
The stable NNTP article number to Message-ID mapping is
stored in an SQLite3 database.
This is required for users of L<public-inbox-nntpd(1)>, but
users of the L<PublicInbox::WWW> interface will find it
useful for attempting recovery from copy-paste truncations of
URLs containing long Message-IDs.
Avoid removing this file and regenerating it; it may cause
existing NNTP readers to lose sync and miss (or see duplicate)
This file is relatively small, and typically less than 5%
of the space of the mail stored in a packed git repository.
The database used by L<Search::Xapian>. This directory name is
followed by a number indicating the index schema version this
installation of public-inbox uses.
These directories may be safely deleted or removed in full
while the NNTP and HTTP interfaces are no longer accessing
In addition to providing a search interface for the HTTP
interface, the Xapian database is used to group and combine
related messages into threads. For NNTP servers, it also
provides a cache of metadata and header information often
requested by NNTP clients.
This directory is large, often two to three times the size of
the objects stored in a packed git repository. Using the
C<--reindex> option makes it larger, still.
Used to override the default "~/.public-inbox/config" value.
Feedback welcome via plain-text mail to L<mailto:email@example.com>
The mail archives are hosted at L<https://public-inbox.org/meta/>
Copyright 2016 all contributors L<mailto:firstname.lastname@example.org>
License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
=head1 SEE ALSO
solving 2871f0d ...
found 2871f0d in https://80x24.org/public-inbox.git
(*) Git path names are given by the tree(s) the blob belongs to.
Blobs themselves have no identifier aside from the hash of its contents.^
Code repositories for project(s) associated with this public inbox
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).