user/dev discussion of public-inbox itself
 help / color / mirror / Atom feed
18f83c9cf2c88651f79e78f09822d278b110205b blob 2684 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
 
=head1 NAME

public-inbox-nntpd - NNTP server for sharing public-inbox

=head1 SYNOPSIS

  public-inbox-nntpd [OPTIONS]

=head1 DESCRIPTION

public-inbox-nntpd provides a read-only NNTP daemon for
public-inbox.  It uses options and environment variables common
to all L<public-inbox-daemon(8)> implementations.

The default configuration will never require write access
to the directory where the public-inbox is stored, so it
may be run as a different user than the user running
L<public-inbox-watch(1)>, L<public-inbox-mda(1)>, or
L<git-fetch(1)>.

=head1 OPTIONS

See common options in L<public-inbox-daemon(8)/OPTIONS>.
Additionally, NNTP-specific behavior for certain options
are supported and documented below.

=over

=item -l, --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key

In addition to the normal C<-l>/C<--listen> switch described in
L<public-inbox-daemon(8)>, the protocol prefix (e.g. C<nntp://> or
C<nntps://>) may be specified to force a given protocol.

For STARTTLS and NNTPS support, the C<cert> and C<key> may be specified
on a per-listener basis after a C<?> character and separated by C<,>.
These directives are per-directive, and it's possible to use a different
cert for every listener.

=item --cert /path/to/cert

The default TLS certificate for optional STARTTLS and NNTPS support
if the C<cert> option is not given with C<--listen>.

If using systemd-compatible socket activation and a TCP listener on port
563 is inherited, it is automatically NNTPS when this option is given.
When a listener on port 119 is inherited and this option is given, it
automatically gets STARTTLS support.

=item --key /path/to/key

The default private TLS certificate key for optional STARTTLS and NNTPS
support if the C<key> option is not given with C<--listen>.  The private
key may concatenated into the path used by C<--cert>, in which case this
option is not needed.

=back

=head1 CONFIGURATION

These configuration knobs should be used in the
L<public-inbox-config(5)>

=over 8

=item publicinbox.<name>.newsgroup

=item publicinbox.nntpserver

=back

See L<public-inbox-config(5)> for documentation on them.

=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/>,
L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
L<nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta>

=head1 COPYRIGHT

Copyright 2013-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(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
L<public-inbox-config(5)>
debug log:

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

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