=head1 NAME public-inbox-init - create or reinitialize a public-inbox =head1 SYNOPSIS B [OPTIONS] NAME INBOX_DIR HTTP_URL ADDRESS [ADDRESS..] =head1 DESCRIPTION Creates an empty public-inbox or reinitializes an existing one. It updates C<~/.public-inbox/config> by creating a C<[publicinbox "NAME"]> section where C is C, C is C, and C is C
. Multiple addresses may be specified for inboxes with multiple addresses. =head1 OPTIONS =over =item -V FORMAT_VERSION =item --version FORMAT_VERSION Specify C<2> here to use the scalable L if you have L installed. The default is C<1> for the old L, but C<2> is strongly recommended for scalability if you have L. Default: C<1> =item -L =item --indexlevel Controls the indexing level for L See L for more information. Default: C =item --ng NEWSGROUP =item --newsgroup NEWSGROUP The NNTP group name for use with L. This may be any newsgroup name with hierarchies delimited by C<.>. For example, the newsgroup for L is: C This may be set after-the-fact via C in the configuration file. See L for more info. Available in public-inbox 1.6.0+. Default: none. =item -c KEY=VALUE Allow setting arbitrary configs as C. This is idempotent for the same C, but allows setting multiple values for keys such as C and C. =item --skip-artnum This option allows archivists to publish incomplete archives with only new mail while allowing NNTP article numbers to be reserved for yet-to-be-archived old mail. This is mainly intended for users of C<--skip-epoch> (documented below) but may be of use to L users. There is no automatic way to use reserved NNTP article numbers when old mail is found, yet. Available in public-inbox 1.6.0+. Default: unset, no NNTP article numbers are skipped =item -S =item --skip-epoch For C<-V2> (L) inboxes only, this option allows archivists to publish incomplete archives with newer mail while allowing "0.git" (or "1.git" and so on) epochs to be added-after-the-fact (without affecting "git clone" followers). Available since public-inbox 1.2.0. Default: unset, no epochs are skipped =item -j JOBS =item --jobs=JOBS Control the number of Xapian index shards in a C<-V2> (L) inbox. It can be useful to use a single shard (C<-j1>) for inboxes on high-latency storage (e.g. rotational HDD) unless the system has enough RAM to cache 5-10x the size of the git repository. Another approach for HDDs is to use the L option and many shards, so each shard may fit into the kernel page cache. Unfortunately, excessive shards slows down read-only query performance. For fast storage, it is generally not useful to specify higher values than the default due to the top-level producer process being a bottleneck. Default: the number of online CPUs, up to 4 (3 shard workers, 1 producer) =item --skip-docdata Do not store document data in Xapian, reducing Xapian storage overhead by around 1.5%. Warning: this option prevents rollbacks to public-inbox 1.5.0 and earlier. Available in public-inbox 1.6.0+. =back =head1 ENVIRONMENT =over 8 =item PI_CONFIG Used to override the default C<~/.public-inbox/config> value. =back =head1 LIMITATIONS Some of the options documented in L require editing the config file. Old versions lack the C<--ng>/C<--newsgroup> parameter See L for all the options which may be applied to a given inbox. =head1 CONTACT Feedback welcome via plain-text mail to L The mail archives are hosted at L and L =head1 COPYRIGHT Copyright 2019-2021 all contributors L License: AGPL-3.0+ L =head1 SEE ALSO L, L, L, L