1PUBLIC-INBOX-INIT(1) public-inbox user manual PUBLIC-INBOX-INIT(1)
2
3
4
6 public-inbox-init - create or reinitialize a public-inbox
7
9 public-inbox-init [OPTIONS] NAME INBOX_DIR HTTP_URL ADDRESS [ADDRESS..]
10
12 Creates an empty public-inbox or reinitializes an existing one. It
13 updates "~/.public-inbox/config" by creating a "[publicinbox "NAME"]"
14 section where "publicinbox.NAME.inboxdir" is "INBOX_DIR",
15 "publicinbox.NAME.url" is "HTTP_URL", and "publicinbox.NAME.address" is
16 "ADDRESS". Multiple addresses may be specified for inboxes with
17 multiple addresses.
18
20 -V FORMAT_VERSION
21 --version FORMAT_VERSION
22 Specify 2 here to use the scalable public-inbox-v2-format(5) if you
23 have DBD::SQLite installed.
24
25 The default is 1 for the old public-inbox-v1-format(5), but 2 is
26 strongly recommended for scalability if you have DBD::SQLite.
27
28 Default: 1
29
30 -L <basic|medium|full>
31 --indexlevel <basic|medium|full>
32 Controls the indexing level for public-inbox-index(1)
33
34 See public-inbox-config(5) for more information.
35
36 Default: "full"
37
38 --ng NEWSGROUP
39 --newsgroup NEWSGROUP
40 The NNTP group name for use with public-inbox-nntpd(8). This may
41 be any newsgroup name with hierarchies delimited by ".". For
42 example, the newsgroup for <mailto:meta@public-inbox.org> is:
43 "inbox.comp.mail.public-inbox.meta"
44
45 This may be set after-the-fact via "publicinbox.$NAME.newsgroup" in
46 the configuration file. See public-inbox-config(5) for more info.
47
48 Available in public-inbox 1.6.0+.
49
50 Default: none.
51
52 -c KEY=VALUE
53 Allow setting arbitrary configs as "publicinbox.$NAME.$KEY". This
54 is idempotent for the same "VALUE", but allows setting multiple
55 values for keys such as "publicinbox.$NAME.url" and
56 "publicinbox.$NAME.watch".
57
58 --skip-artnum
59 This option allows archivists to publish incomplete archives with
60 only new mail while allowing NNTP article numbers to be reserved
61 for yet-to-be-archived old mail.
62
63 This is mainly intended for users of "--skip-epoch" (documented
64 below) but may be of use to public-inbox-v1-format(5) users.
65
66 There is no automatic way to use reserved NNTP article numbers when
67 old mail is found, yet.
68
69 Available in public-inbox 1.6.0+.
70
71 Default: unset, no NNTP article numbers are skipped
72
73 -S
74 --skip-epoch
75 For "-V2" (public-inbox-v2-format(5)) inboxes only, this option
76 allows archivists to publish incomplete archives with newer mail
77 while allowing "0.git" (or "1.git" and so on) epochs to be added-
78 after-the-fact (without affecting "git clone" followers).
79
80 Available since public-inbox 1.2.0.
81
82 Default: unset, no epochs are skipped
83
84 -j JOBS
85 --jobs=JOBS
86 Control the number of Xapian index shards in a "-V2"
87 (public-inbox-v2-format(5)) inbox.
88
89 It can be useful to use a single shard ("-j1") for inboxes on high-
90 latency storage (e.g. rotational HDD) unless the system has enough
91 RAM to cache 5-10x the size of the git repository.
92
93 Another approach for HDDs is to use the
94 "publicInbox.indexSequentialShard" in public-inbox-index(1) option
95 and many shards, so each shard may fit into the kernel page cache.
96 Unfortunately, excessive shards slows down read-only query
97 performance.
98
99 For fast storage, it is generally not useful to specify higher
100 values than the default due to the top-level producer process being
101 a bottleneck.
102
103 Default: the number of online CPUs, up to 4 (3 shard workers, 1
104 producer)
105
106 --skip-docdata
107 Do not store document data in Xapian, reducing Xapian storage
108 overhead by around 1.5%.
109
110 Warning: this option prevents rollbacks to public-inbox 1.5.0 and
111 earlier.
112
113 Available in public-inbox 1.6.0+.
114
116 PI_CONFIG
117 Used to override the default "~/.public-inbox/config" value.
118
120 Some of the options documented in public-inbox-config(5) require
121 editing the config file. Old versions lack the "--ng"/"--newsgroup"
122 parameter
123
124 See public-inbox-config(5) for all the options which may be applied to
125 a given inbox.
126
128 Feedback welcome via plain-text mail to <mailto:meta@public-inbox.org>
129
130 The mail archives are hosted at <https://public-inbox.org/meta/> and
131 <http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/>
132
134 Copyright 2019-2021 all contributors <mailto:meta@public-inbox.org>
135
136 License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
137
139 git-init(1), git-config(1), public-inbox-v1-format(5),
140 public-inbox-v2-format(5)
141
142
143
144public-inbox.git 1993-10-02 PUBLIC-INBOX-INIT(1)