diff options
| author | Eric Wong <e@80x24.org> | 2021-09-16 00:26:52 +0000 |
|---|---|---|
| committer | Eric Wong <e@80x24.org> | 2021-09-16 04:29:12 +0000 |
| commit | 3690f0625fbfb75dcc73986d78abba738e9113a4 (patch) | |
| tree | a14a9b4aca80b9b168bf8bfbeb49dd624b45ce64 /Documentation | |
| parent | b4bc9aeed78078feae58d150970fe224f10098e3 (diff) | |
| download | public-inbox-3690f0625fbfb75dcc73986d78abba738e9113a4.tar.gz | |
This allows PublicInbox::WWW hosts to advertise the existence of IMAP servers in addition to NNTP servers.
Diffstat (limited to 'Documentation')
| -rw-r--r-- | Documentation/public-inbox-config.pod | 28 |
1 files changed, 20 insertions, 8 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 5b86ef6c..a5bc67fd 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -62,13 +62,15 @@ Default: none, optional =item publicinbox.<name>.newsgroup -The NNTP group name for use with L<public-inbox-nntpd(8)>. This +The NNTP group name for use with L<public-inbox-nntpd(1)>. 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> -Omitting this for the given inbox will prevent the group from -being read by L<public-inbox-nntpd(1)> +It also configures the folder hierarchy used by L<public-inbox-imapd(1)>. + +Omitting this for a given inbox will prevent the inbox from +being served by L<public-inbox-nntpd(1)> and/or L<public-inbox-imapd(1)>. Default: none, optional @@ -98,6 +100,12 @@ needs to match. Default: none +=item publicinbox.<name>.imapmirror + +This may be the full IMAP URL of an independently-run IMAP mirror. + +Default: none + =item publicinbox.<name>.nntpmirror This may be the full NNTP URL of an independently-run mirror. @@ -203,14 +211,18 @@ See L<public-inbox-watch(1)> See L<public-inbox-watch(1)> -=item publicinbox.nntpserver +=item publicinbox.imapserver -Set this to point to the hostname of the L<public-inbox-nntpd(1)> -instance. This is used to advertise the existence of the NNTP +Set this to point to the hostname(s) of the L<public-inbox-imapd(1)> +instance. This is used to advertise the existence of the IMAP endpoint in the L<PublicInbox::WWW> HTML interface. -Multiple values are allowed for instances with multiple hostnames -or mirrors. +Default: none + +=item publicinbox.nntpserver + +Same as C<publicinbox.imapserver>, but for the hostname(s) of the +L<public-inbox-nntpd(1)> instance. Default: none |