]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-imapd.pod
ipc: drop unused $args from ->ipc_worker_stop
[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   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 PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
31
32 =item --listen PROTOCOL://ADDRESS/?cert=/path/to/cert,key=/path/to/key
33
34 In addition to the normal C<-l>/C<--listen> switch described in
35 L<public-inbox-daemon(8)>, the C<PROTOCOL> prefix (e.g. C<imap://> or
36 C<imaps://>) may be specified to force a given protocol.
37
38 For STARTTLS and IMAPS support, the C<cert> and C<key> may be specified
39 on a per-listener basis after a C<?> character and separated by C<,>.
40 These directives are per-directive, and it's possible to use a different
41 cert for every listener.
42
43 =item --cert /path/to/cert
44
45 The default TLS certificate for optional STARTTLS and IMAPS support
46 if the C<cert> option is not given with C<--listen>.
47
48 If using systemd-compatible socket activation and a TCP listener on port
49 993 is inherited, it is automatically IMAPS when this option is given.
50 When a listener on port 143 is inherited and this option is given, it
51 automatically gets STARTTLS support.
52
53 =item --key /path/to/key
54
55 The default private TLS certificate key for optional STARTTLS and IMAPS
56 support if the C<key> option is not given with C<--listen>.  The private
57 key may be concatenated into the path used by C<--cert>, in which case this
58 option is not needed.
59
60 =back
61
62 =head1 CONFIGURATION
63
64 C<public-inbox-imapd> uses the same configuration knobs
65 as L<public-inbox-nntpd(1)>, see L<public-inbox-nntpd(1)>
66 and L<public-inbox-config(5)>.
67
68 =over 8
69
70 =item publicinbox.<name>.newsgroup
71
72 The newsgroup name maps to an IMAP folder name.
73
74 =back
75
76 =head1 CONTACT
77
78 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
79
80 The mail archives are hosted at L<https://public-inbox.org/meta/>, and
81 L<nntp://news.public-inbox.org/inbox.comp.mail.public-inbox.meta>,
82 L<nntp://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/inbox.comp.mail.public-inbox.meta>
83
84 =head1 COPYRIGHT
85
86 Copyright 2020-2021 all contributors L<mailto:meta@public-inbox.org>
87
88 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
89
90 =head1 SEE ALSO
91
92 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
93 L<public-inbox-config(5)>, L<public-inbox-nntpd(1)>