diff options
Diffstat (limited to 'Documentation/public-inbox-config.pod')
| -rw-r--r-- | Documentation/public-inbox-config.pod | 108 |
1 files changed, 98 insertions, 10 deletions
diff --git a/Documentation/public-inbox-config.pod b/Documentation/public-inbox-config.pod index 43e54ed4..b4a1d94d 100644 --- a/Documentation/public-inbox-config.pod +++ b/Documentation/public-inbox-config.pod @@ -67,10 +67,17 @@ 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> -It also configures the folder hierarchy used by L<public-inbox-imapd(1)>. +It also configures the folder hierarchy used by L<public-inbox-imapd(1)> +as well as L<public-inbox-pop3d(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)>. +being served by L<public-inbox-nntpd(1)>, +L<public-inbox-imapd(1)>, and/or L<public-inbox-pop3d(1)> + +Newsgroup names should be all lowercase. Uppercase characters are +converted to lowercase for compatibility with IMAP, POP3, and our +L<public-inbox-extindex(1)> and L<public-inbox-cindex(1)> tools +starting with public-inbox 2.0+ (they were unusable before). Default: none, optional @@ -123,8 +130,8 @@ C<basic> only requires L<DBD::SQLite(3pm)> and provides all NNTP functionality along with thread-awareness in the WWW interface. -C<medium> requires L<Search::Xapian(3pm)> to provide full-text -term search functionality in the WWW UI. +C<medium> requires L<Xapian(3pm)> or L<Search::Xapian(3pm)> to provide +full-text term search functionality in the WWW UI. C<full> also includes positional information used by Xapian to allow for searching for phrases using quoted text. @@ -189,11 +196,28 @@ Default: :all 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 +"href" may be specified to point to the URL of a 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 publicinboxImport.dropUniqueUnsubscribe + +Drop C<List-Unsubscribe> headers if the message also includes +the C<List-Unsubscribe-Post: List-Unsubscribe=One-Click> header +to signal MUAs to support an instantaneous unsubscribe. This +is strongly recommended for users creating their own public +archives of mailing lists they subscribe to, otherwise any +archive reader can unsubscribe the archivist. + +This may break DKIM signatures if the C<List-Unsubscribe*> +headers are signed, but breaking DKIM signatures is the +lesser evil compared to allowing any reader to unsubscribe +the archivist. + +This affects L<public-inbox-mda(1)>, L<public-inbox-watch(1)>, +and L<public-inbox-learn(1)> + =item publicinboxmda.spamcheck This may be set to C<none> to disable the use of SpamAssassin @@ -226,6 +250,17 @@ L<public-inbox-nntpd(1)> instance. Default: none +=item publicinbox.pop3server + +Same as C<publicinbox.imapserver>, but for the hostname(s) of the +L<public-inbox-pop3d(1)> instance. + +Default: none + +=item publicinbox.pop3state + +See L<public-inbox-pop3d(1)/publicinbox.pop3state> + =item publicinbox.<name>.feedmax The size of an Atom feed for the inbox. If specified more than @@ -238,7 +273,9 @@ Default: 25 A comma-delimited list of listings to hide the inbox from. -Valid values are currently C<www> and C<manifest>. +Valid values are currently C<www> and C<manifest> for non-C<404> +values of L</publicinbox.wwwListing> and L</publicinbox.grokManifest>, +respectively Default: none @@ -252,6 +289,10 @@ The URL of the cgit instance associated with the coderepo. Default: none +=item coderepo.snapshots + +See C<snapshots> in L<cgitrc(5)> + =item publicinbox.cgitrc A path to a L<cgitrc(5)> file. "repo.url" directives in the cgitrc @@ -274,18 +315,50 @@ Default: /var/www/htdocs/cgit/cgit.cgi or /usr/lib/cgit/cgit.cgi =item publicinbox.cgitdata A path to the data directory used by cgit for storing static files. -Typically guessed based the location of C<cgit.cgi> (from -C<publicinbox.cgitbin>, but may be overridden. +Typically guessed based on the location of C<cgit.cgi> (from +C<publicinbox.cgitbin>), but may be overridden. -Default: basename of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/ +Default: dirname of C<publicinbox.cgitbin>, /var/www/htdocs/cgit/ or /usr/share/cgit/ +=item publicinbox.cgit + +Controls whether or not and how C<cgit> is used for serving coderepos. +New in public-inbox 2.0.0 (PENDING). + +=over 8 + +=item * first + +Try using C<cgit> as the first choice, this is the default. + +=item * fallback + +Fall back to using C<cgit> only if our native, inbox-aware +git code repository viewer doesn't recognize the URL. + +=begin comment +=for comment rewrite is not yet implemented +=item * rewrite + +Rewrite C<cgit> URLs for our native, inbox-aware code repository viewer. +This implies C<fallback> for URLs the native viewer does not recognize. + +=end comment + +=back + +Default: C<first> (C<cgit> will be used iff C<publicinbox.cgitrc> +is set and the C<cgit> binary exists). + =item publicinbox.mailEditor See L<public-inbox-edit(1)> =item publicinbox.indexMaxSize + =item publicinbox.indexBatchSize + =item publicinbox.indexSequentialShard See L<public-inbox-index(1)> @@ -314,6 +387,21 @@ TODO support showing cgit listing Default: C<404> +=item publicinbox.nameIsUrl + +Treat the name of the public inbox as its unqualified URL when +using C<publicInbox.wwwListing=all>. That is, every +C<[publicinbox "foo"]> section implicitly sets C<publicinbox.foo.url=foo>. + +This is a convenient alternative to specifying +C<publicinbox.E<lt>nameE<gt>.url> for every single inbox if +your inbox URLs are domain-agnostic when using +C<publicInbox.wwwListing=all> + +Default: false + +New in public-inbox 2.0.0 (PENDING). + =item publicinbox.grokmanifest Controls the generation of a grokmirror-compatible gzipped JSON file @@ -463,7 +551,7 @@ L<http://4uok3hntl7oi7b4uf4rtfwefqeexfzil2w6kgk2jn5z2f764irre7byd.onion/meta/> =head1 COPYRIGHT -Copyright 2016-2021 all contributors L<mailto:meta@public-inbox.org> +Copyright all contributors L<mailto:meta@public-inbox.org> License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt> |