]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-imapd.pod
searchidx: use singular `$opt' for consistency with v2
[public-inbox.git] / Documentation / public-inbox-imapd.pod
1 =head1 NAME
2
3 public-inbox-imapd - IMAP server for sharing public-inboxes
4
5 =head1 SYNOPSIS
6
7 B<public-inbox-imapd> [OPTIONS]
8
9 =head1 DESCRIPTION
10
11 public-inbox-imapd provides a read-only IMAP daemon for
12 public-inbox.  It uses options and environment variables common
13 to all L<public-inbox-daemon(8)> implementations.
14
15 Like L<public-inbox-nntpd(1)> and L<public-inbox-httpd(1)>,
16 C<public-inbox-imapd> will never require write access
17 to the directory where the public-inboxes are stored, so it
18 may be run as a different user than the user running
19 L<public-inbox-watch(1)>, L<public-inbox-mda(1)>, or
20 L<git-fetch(1)>.
21
22 =head1 OPTIONS
23
24 See common options in L<public-inbox-daemon(8)/OPTIONS>.
25 Additionally, IMAP-specific behavior for certain options
26 are supported and documented below.
27
28 =over
29
30 =item -l, --listen PROTO://ADDRESS/?cert=/path/to/cert,key=/path/to/key
31
32 In addition to the normal C<-l>/C<--listen> switch described in
33 L<public-inbox-daemon(8)>, the C<PROTO> prefix (e.g. C<imap://> or
34 C<imaps://>) may be specified to force a given protocol.
35
36 For STARTTLS and IMAPS support, the C<cert> and C<key> may be specified
37 on a per-listener basis after a C<?> character and separated by C<,>.
38 These directives are per-directive, and it's possible to use a different
39 cert for every listener.
40
41 =item --cert /path/to/cert
42
43 The default TLS certificate for optional STARTTLS and IMAPS support
44 if the C<cert> option is not given with C<--listen>.
45
46 If using systemd-compatible socket activation and a TCP listener on port
47 993 is inherited, it is automatically IMAPS when this option is given.
48 When a listener on port 143 is inherited and this option is given, it
49 automatically gets STARTTLS support.
50
51 =item --key /path/to/key
52
53 The default private TLS certificate key for optional STARTTLS and IMAPS
54 support if the C<key> option is not given with C<--listen>.  The private
55 key may concatenated into the path used by C<--cert>, in which case this
56 option is not needed.
57
58 =back
59
60 =head1 CONFIGURATION
61
62 C<public-inbox-imapd> uses the same configuration knobs
63 as L<public-inbox-nntpd(1)>, see L<public-inbox-nntpd(1)>
64 and L<public-inbox-config(5)>.
65
66 =over 8
67
68 =item publicinbox.<name>.newsgroup
69
70 The newsgroup name maps to an IMAP folder name.
71
72 =back
73
74 =head1 CONTACT
75
76 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
77
78 The mail archives are hosted at L<https://public-inbox.org/meta/>,
79 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
80 L<nntp://hjrcffqmbrq6wope.onion/inbox.comp.mail.public-inbox.meta>
81
82 =head1 COPYRIGHT
83
84 Copyright 2020 all contributors L<mailto:meta@public-inbox.org>
85
86 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
87
88 =head1 SEE ALSO
89
90 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
91 L<public-inbox-config(5)>, L<public-inbox-nntpd(1)>