=item --no-index
-Disables Xapian and overview DB indexing on the new repository.
-By default, public-inbox-convert creates a new index in the v2
-repository and indexes all existing messages, a lengthy
+Disables Xapian and overview DB indexing on the new inbox.
+By default, public-inbox-convert creates a new index in the
+v2 inbox and indexes all existing messages, a lengthy
operation for large inboxes.
=item -j JOBS, --jobs=JOBS
This manual describes common options and behavior for
public-inbox network daemons. Network daemons for public-inbox
provide read-only NNTP and HTTP access to public-inboxes. Write
-access to a public-inbox repository will never be required to
-run these.
+access to a public-inbox will never be required to run these.
These daemons are implemented with a common core using
non-blocking sockets and optimized for fairness; even with
=item --reindex
-Forces a search engine re-index of all messages in the
-repository. This can be used for in-place upgrades while
+Forces a re-index of all messages in the inbox.
+This can be used for in-place upgrades and bugfixes while
NNTP/HTTP server processes are utilizing the index. Keep in
mind this roughly doubles the size of the already-large
Xapian database. Running L<public-inbox-compact(1)>
All public-inbox-specific files are contained within the
C<$GIT_DIR/public-inbox/> directory.
-v2 repositories are described in L<public-inbox-v2-format>.
+v2 inboxes are described in L<public-inbox-v2-format>.
=head1 ENVIRONMENT
Mirroring mailing lists may be done by any reader
of a mailing list using L<public-inbox-watch(1)>.
- # This will create a new git repository:
+ # This will create a new v2 inbox:
public-inbox-init -V2 NAME INBOX_DIR MY_URL LIST_ADDRESS
Then, see the L<public-inbox-watch(1)> manual for configuring
for more information on using these daemons.
Hosting a public-inbox over HTTP or NNTP will never require
-write access to any files in the git repository, including
-the search indices or article number map database.
+write access to any files in the inbox directory.
Users familiar with PSGI and L<Plack> may also use
L<PublicInbox::WWW> with the preferred server instead of
=head1 NAME
-public-inbox v2 repository description
+public-inbox v2 format description
=head1 DESCRIPTION
=head1 THANKS
Thanks to the Linux Foundation for sponsoring the development
-and testing of the v2 repository format.
+and testing of the v2 format.
=head1 COPYRIGHT
public-inbox-watch allows watching a mailbox (currently only
Maildir) for the arrival of new messages and automatically
-importing them into a public-inbox (git) repository.
+importing them into public-inbox git repositories and indices.
public-inbox-watch is useful in situations when a user wishes to
mirror an existing mailing list, but has no access to run
L<public-inbox-mda(1)> on a server. Unlike public-inbox-mda
Only depend on Free Software packages which exist in the "main"
section of Debian "stable" distribution. That is Debian 9.x
("stretch") as of this writing, but "oldstable" (8.x, "jessie")
-remains supported for v1 repositories.
+remains supported for v1 inboxes.
In general, we favor mature and well-tested old things rather than
the shiny new.
https://public-inbox.org/meta/20160411034104.GA7817@dcvr.yhbt.net/
Perhaps make this depend solely the NNTP server and work as a proxy.
Meaning users can run this without needing a full copy of the
- archives in a git repository.
+ archives in git repositories.
* HTTP and NNTP proxy support. Allow us to be a frontend for
firewalled off (or Tor-exclusive) instances. The use case is
#!/usr/bin/perl -w
# Copyright (C) 2015-2020 all contributors <meta@public-inbox.org>
# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
-# Basic tool to create a Xapian search index for a git repository
-# configured for public-inbox.
+# Basic tool to create a Xapian search index for a public-inbox.
# Usage with libeatmydata <https://www.flamingspork.com/projects/libeatmydata/>
# highly recommended: eatmydata public-inbox-index INBOX_DIR