user/dev discussion of public-inbox itself
 help / color / Atom feed
e7dcd8a154c2d1cb5205e0d729feb28c6f193dba blob 8881 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
=head1 NAME

public-inbox-config - public-inbox config file description

=head1 SYNOPSIS

~/.public-inbox/config

=head1 DESCRIPTION

The public-inbox config file is parseable by L<git-config(1)>.
This is a global configuration file for mapping/discovering
all public-inboxes used by a particular user.

=head1 CONFIGURATION FILE

=head2 EXAMPLE

	[publicinbox "test"]
		mainrepo = /home/user/path/to/test.git
		; multiple addresses are supported
		address = test@example.com
		; address = alternate@example.com
		url = http://example.com/test
		newsgroup = inbox.test

=head2 VARIABLES

=over 8

=item publicinbox.<name>.address

The email address of the public-inbox.  May be specified
more than once for merging multiple mailing lists (or migrating
to new addresses).  This must be specified at least once,
the first value will be considered the primary address for
informational purposes.

Default: none, required

=item publicinbox.<name>.mainrepo

The absolute path to the directory which hosts the
public-inbox.  This must be specified once.

Default: none, required

=item publicinbox.<name>.url

The primary URL for hosting the HTTP/HTTPS archives.
Additional HTTP/HTTPS URLs may be specified via
C<$GIT_DIR/cloneurl> as documented in L<gitweb(1)>

Default: none, optional

=item publicinbox.<name>.newsgroup

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

Omitting this for the given inbox will prevent the group from
being read by L<public-inbox-nntpd(1)>

Default: none, optional

=item publicinbox.<name>.watch

A location for L<public-inbox-watch(1)> to watch.  Currently,
only C<maildir:> paths are supported:

	[publicinbox "test"]
		watch = maildir:/path/to/maildirs/.INBOX.test/

Default: none; only for L<public-inbox-watch(1)> users

=item publicinbox.<name>.watchheader

	[publicinbox "test"]
		watchheader = List-Id:<test.example.com>

Default: none; only for L<public-inbox-watch(1)> users

=item publicinbox.<name>.nntpmirror

This may be the full NNTP URL of an independently-run mirror.
For example, the https://public-inbox.org/meta/ inbox is
mirrored by Gmane at
C<nntp://news.gmane.org/gmane.mail.public-inbox.general>

Default: none

=item publicinbox.<name>.httpbackendmax

If a digit, the maximum number of parallel
L<git-http-backend(1)> processes to allow for cloning this
particular inbox.

If an alphanumeric value starting with a lowercase alphabetic
character is specified, the inbox will use a L</NAMED LIMITER>
which can be shared by multiple inboxes.

Default: 32 (using a default limiter shared by all inboxes)

=item publicinbox.<name>.coderepo

The nickname of a "coderepo" section associated with the inbox.
May be specified more than once for M:N mapping of code repos to
inboxes.  If enabled, diff hunk headers in patch emails will
link to the line numbers of blobs.

Default: none

=item publicinbox.<name>.replyto

May be used to control how reply instructions in the PSGI
interface are displayed.

":none=dead inbox" may be specified to denote an inactive list
("dead inbox" may be replaced with another phrase).

A list of comma-delimited email addresses may be specified.
This can be useful for dedicated inboxes for bot emails, but
discussion happens on a seperate mailing list/inbox.

Mirrors of existing centralized mailing lists may use ":list"
here to redirect mail only to the configured inbox address.
The use of ":list" is discouraged for new mailing lists, as it
leads to centralization.

Default: :all

=item publicinbox.css

The local path name of a CSS file for the PSGI web interface.
May contain the attributes "media", "title" and "href" which match
the associated attributes of the HTML <style> tag.
"href" may be specified to point to the URL of an remote CSS file
and the path may be "/dev/null" or any empty file.
Multiple files may be specified and will be included in the
order specified.

=item publicinboxmda.spamcheck

This may be set to C<none> to disable the use of SpamAssassin
L<spamc(1)> for filtering spam before it is imported into git
history.  Other spam filtering backends may be supported in
the future.

Default: spamc

=item publicinboxwatch.spamcheck

This may be set to C<spamc> to enable the use of SpamAssassin
L<spamc(1)> for filtering spam before it is imported into git
history.  Other spam filtering backends may be supported in
the future.

Default: none

=item publicinboxwatch.watchspam

This may be set to C<spamc> to enable the use of SpamAssassin
L<spamc(1)> for filtering spam before it is imported into git
history.  Other spam filtering backends may be supported in
the future.  This requires L<public-inbox-watch(1)>, but affects
all configured public-inboxes in PI_CONFIG.

Default: none

=item publicinbox.nntpserver

Set this to point to the address of the L<public-inbox-nntpd(1)>
instance.  This is used to advertise the existence of the NNTP
presnce in the L<PublicInbox::WWW> HTML interface.

Multiple values are allowed for servers with multiple
addresses or mirrors.

Default: none

=item publicinbox.<name>.feedmax

The size of an Atom feed for the inbox.  If specified more than
once, only the last value is used.  Invalid values (<= 0) will
be treated as the default value.

Default: 25

=item coderepo.<nick>.dir

The path to a git repository for "publicinbox.<name>.coderepo"

=item coderepo.<nick>.cgitUrl

The URL of the cgit instance associated with the coderepo.

Default: none

=item publicinbox.cgitrc

A path to a L<cgitrc(5)> file.  "repo.url" directives in the cgitrc
will be mapped to the nickname of a coderepo (without trailing slash),
and "repo.path" directives map to "coderepo.<nick>.dir".
Use of this directive allows admins of existing cgit installations
to skip declaring coderepo sections and map inboxes directly to
code repositories known to cgit.

Macro expansion (e.g. C<$HTTP_HOST>) is not yet supported.

=item publicinbox.cgitbin

A path to the C<cgit.cgi> executable.  The L<PublicInbox::WWW>
interface can spawn cgit as a fallback if the publicinbox.cgitrc
directive is configured.

Default: /var/www/htdocs/cgit/cgit.gti or /usr/lib/cgit/cgit.cgi

=back

=head2 NAMED LIMITER (PSGI)

Named limiters are useful for preventing large inboxes from
monopolizing (or overloading) the server.  Since serving git
clones (via L<git-http-backend(1)> can be memory-intensive for
large inboxes, it makes sense to put large inboxes on a named
limiter with a low max value; while smaller inboxes can use
the default limiter.

C<RLIMIT_*> keys may be set to enforce resource limits for
a particular limiter.

Default named-limiters are prefixed with "-".  Currently,
the "-cgit" named limiter is reserved for instances spawning
cgit via C<publicinbox.cgitrc>

=over 8

=item publicinboxlimiter.<name>.max

The maximum number of parallel processes for the given limiter.

=item publicinboxlimiter.<name>.rlimitCore

=item publicinboxlimiter.<name>.rlimitCPU

=item publicinboxlimiter.<name>.rlimitData

The maximum core size, CPU time, or data size processes run with the
given limiter will use.  This may be comma-separated to distinguish
soft and hard limits.  The word "INFINITY" is accepted as the
RLIM_INFINITY constant (if supported by your OS).

See L<setrlimit(2)> for more info on the behavior of RLIMIT_CORE,
RLIMIT_CPU, and RLIMIT_DATA for you operating system.

=back

=head3 EXAMPLE WITH NAMED LIMITERS

	; big inboxes which require lots of memory to clone:
	[publicinbox "big1"]
		mainrepo = /path/to/big1
		address = big1@example.com
		httpbackendmax = big
	[publicinbox "big2"]
		mainrepo = /path/to/big2
		address = big2@example.com
		httpbackendmax = big

	; tiny inboxes which are easily cloned:
	[publicinbox "tiny1"]
		mainrepo = /path/to/tiny1
		address = tiny1@example.com
	[publicinbox "tiny2"]
		mainrepo = /path/to/tiny2
		address = tiny2@example.com

	[publicinboxlimiter "big"]
		max = 4

In the above example, the "big1" and "big2" are limited to four
parallel L<git-http-backend(1)> processes between them.

However, "tiny1" and "tiny2" will share the default limiter
which means there can be 32 L<git-http-backend(1)> processes
between them.

=head1 ENVIRONMENT

=over 8

=item PI_CONFIG

Used to override the default "~/.public-inbox/config" value.

=back

=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 2016-2018 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(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
L<public-inbox-mda(1)>, L<public-inbox-watch(1)>
debug log:

solving e7dcd8a ...
found e7dcd8a in https://80x24.org/public-inbox.git

user/dev discussion of public-inbox itself

Archives are clonable:
	git clone --mirror http://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

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.org/gmane.mail.public-inbox.general

 note: .onion URLs require Tor: https://www.torproject.org/

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