user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
3f98807aa797a3b617136c8da9f00caf213a89f3 blob 3918 bytes (raw)

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
=head1 NAME

public-inbox-init - create or reinitialize a public-inbox

=head1 SYNOPSIS

B<public-inbox-init> [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<publicinbox.NAME.inboxdir> is C<INBOX_DIR>,
C<publicinbox.NAME.url> is C<HTTP_URL>, and
C<publicinbox.NAME.address> is C<ADDRESS>.  Multiple addresses
may be specified for inboxes with multiple addresses.

=head1 OPTIONS

=over

=item -V, --version FORMAT_VERSION

Specify C<2> here to use the scalable L<public-inbox-v2-format(5)>
if you have L<DBD::SQLite> installed.

The default is C<1> for the old L<public-inbox-v1-format(5)>,
but C<2> is strongly recommended for scalability if you have
L<DBD::SQLite>.

Default: C<1>

=item -L, --indexlevel <basic|medium|full>

Controls the indexing level for L<public-inbox-index(1)>

See L<public-inbox-config(5)> for more information.

Default: C<full>

=item --ng, --newsgroup NEWSGROUP

The NNTP group name for use with L<public-inbox-nntpd(8)>.  This
may be any newsgroup name with hierarchies delimited by C<.>.
For example, the newsgroup for L<mailto:meta@public-inbox.org>
is: C<inbox.comp.mail.public-inbox.meta>

This may be set after-the-fact via C<publicinbox.$NAME.newsgroup>
in the configuration file.  See L<public-inbox-config(5)> for more
info.

Available since public-inbox 1.6.0 (PENDING).

Default: none.

=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<public-inbox-v1-format(5)> users.

There is no automatic way to use reserved NNTP article numbers
when old mail is found, yet.

Available since public-inbox 1.6.0 (PENDING).

Default: unset, no NNTP article numbers are skipped

=item -S, --skip-epoch

For C<-V2> (L<public-inbox-v2-format(5)>) 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=JOBS

Control the number of Xapian index shards in a
C<-V2> (L<public-inbox-v2-format(5)>) inbox.

It is 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.

It is generally not useful to specify higher values than the
default due to contention in the top-level producer process.

Default: the number of online CPUs, up to 4

=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 since public-inbox 1.6.0 (PENDING).

=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<public-inbox-config(5)>
require editing the config file.  Old versions lack the
C<-n>/C<--newsgroup> parameter

See L<public-inbox-config(5)> for all the options which may be applied
to a given inbox.

=head1 CONTACT

Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>

The mail archives are hosted at L<https://public-inbox.org/meta/>
and L<http://hjrcffqmbrq6wope.onion/meta/>

=head1 COPYRIGHT

Copyright 2019-2020 all contributors L<mailto:meta@public-inbox.org>

License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>

=head1 SEE ALSO

L<git-init(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>,
L<public-inbox-v2-format(5)>
debug log:

solving 3f98807a ...
found 3f98807a in https://public-inbox.org/meta/20200820202457.21042-23-e@yhbt.net/
found 4cc7e29f in https://public-inbox.org/meta/20200820202457.21042-7-e@yhbt.net/
found 240959eb in https://public-inbox.org/meta/20200820202457.21042-6-e@yhbt.net/
found d0c87563 in https://80x24.org/public-inbox.git
preparing index
index prepared:
100644 d0c87563be509c96bf15c84093d8a8fd69ec4493	Documentation/public-inbox-init.pod

applying [1/3] https://public-inbox.org/meta/20200820202457.21042-6-e@yhbt.net/
diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index d0c87563..240959eb 100644


applying [2/3] https://public-inbox.org/meta/20200820202457.21042-7-e@yhbt.net/
diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index 240959eb..4cc7e29f 100644


applying [3/3] https://public-inbox.org/meta/20200820202457.21042-23-e@yhbt.net/
diff --git a/Documentation/public-inbox-init.pod b/Documentation/public-inbox-init.pod
index 4cc7e29f..3f98807a 100644

Checking patch Documentation/public-inbox-init.pod...
Applied patch Documentation/public-inbox-init.pod cleanly.
Checking patch Documentation/public-inbox-init.pod...
Applied patch Documentation/public-inbox-init.pod cleanly.
Checking patch Documentation/public-inbox-init.pod...
Applied patch Documentation/public-inbox-init.pod cleanly.

index at:
100644 3f98807aa797a3b617136c8da9f00caf213a89f3	Documentation/public-inbox-init.pod

user/dev discussion of public-inbox itself

This inbox may be cloned and mirrored by anyone:

	git clone --mirror https://public-inbox.org/meta
	git clone --mirror http://czquwvybam4bgbro.onion/meta
	git clone --mirror http://hjrcffqmbrq6wope.onion/meta
	git clone --mirror http://ou63pmih66umazou.onion/meta

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V1 meta meta/ https://public-inbox.org/meta \
		meta@public-inbox.org
	public-inbox-index meta

Example config snippet for mirrors.
Newsgroups are available over NNTP:
	nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta
	nntp://ou63pmih66umazou.onion/inbox.comp.mail.public-inbox.meta
	nntp://czquwvybam4bgbro.onion/inbox.comp.mail.public-inbox.meta
	nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta
	nntp://news.gmane.io/gmane.mail.public-inbox.general
 note: .onion URLs require Tor: https://www.torproject.org/

code repositories for the project(s) associated with this inbox:

	https://80x24.org/public-inbox.git

AGPL code for this site: git clone https://public-inbox.org/public-inbox.git