3 public-inbox-init - create or reinitialize a public-inbox
7 B<public-inbox-init> [OPTIONS] NAME INBOX_DIR HTTP_URL ADDRESS [ADDRESS..]
11 Creates an empty public-inbox or reinitializes an existing one.
12 It updates C<~/.public-inbox/config> by creating a
13 C<[publicinbox "NAME"]> section where
14 C<publicinbox.NAME.inboxdir> is C<INBOX_DIR>,
15 C<publicinbox.NAME.url> is C<HTTP_URL>, and
16 C<publicinbox.NAME.address> is C<ADDRESS>. Multiple addresses
17 may be specified for inboxes with multiple addresses.
23 =item -V, --version FORMAT_VERSION
25 Specify C<2> here to use the scalable L<public-inbox-v2-format(5)>
26 if you have L<DBD::SQLite> installed.
28 The default is C<1> for the old L<public-inbox-v1-format(5)>,
29 but C<2> is strongly recommended for scalability if you have
34 =item --indexlevel <basic|medium|full>
36 Controls the indexing level for L<public-inbox-index(1)>
38 See L<public-inbox-config(5)> for more information.
42 =item -N, --skip-artnum
44 This option allows archivists to publish incomplete archives
45 with only new mail while allowing NNTP article numbers
46 to be reserved for yet-to-be-archived old mail.
48 This is mainly intended for users of C<--skip-epoch> (documented below)
49 but may be of use to L<public-inbox-v1-format(5)> users.
51 There is no automatic way to use reserved NNTP article numbers
52 when old mail is found, yet.
54 Default: unset, no NNTP article numbers are skipped
56 =item -S, --skip-epoch
58 For C<-V2> (L<public-inbox-v2-format(5)>) inboxes only, this option
59 allows archivists to publish incomplete archives with newer
60 mail while allowing "0.git" (or "1.git" and so on) epochs to be
61 added-after-the-fact (without affecting "git clone" followers).
63 Default: unset, no epochs are skipped
67 Control the number of Xapian index shards in a
68 C<-V2> (L<public-inbox-v2-format(5)>) inbox.
70 It is useful to use a single shard (C<-j1>) for inboxes on
71 high-latency storage (e.g. rotational HDD) unless the system has
72 enough RAM to cache 5-10x the size of the git repository.
74 It is generally not useful to specify higher values than the
75 default due to contention in the top-level producer process.
77 Default: the number of online CPUs, up to 4
87 Used to override the default C<~/.public-inbox/config> value.
93 This tool predates NNTP support in public-inbox and is missing
94 C<newsgroup> and many of the options documented in
95 L<public-inbox-config(5)>. See L<public-inbox-config(5)> for all the
96 options which may be applied to a given inbox.
100 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
102 The mail archives are hosted at L<https://public-inbox.org/meta/>
103 and L<http://hjrcffqmbrq6wope.onion/meta/>
107 Copyright 2019-2020 all contributors L<mailto:meta@public-inbox.org>
109 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
113 L<git-init(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>,
114 L<public-inbox-v2-format(5)>