Documentation/public-inbox-config.pod

   1 =head1 NAME
   2
   3 public-inbox-config - public-inbox config file description
   4
   5 =head1 SYNOPSIS
   6
   7 ~/.public-inbox/config
   8
   9 =head1 DESCRIPTION
  10
  11 The public-inbox config file is parseable by L<git-config(1)>.
  12 This is a global configuration file for mapping/discovering
  13 all public-inboxes used by a particular user.
  14
  15 =head1 CONFIGURATION FILE
  16
  17 =head2 EXAMPLE
  18
  19         [publicinbox "test"]
  20                 mainrepo = /home/user/path/to/test.git
  21                 ; multiple addresses are supported
  22                 address = test@example.com
  23                 ; address = alternate@example.com
  24                 url = http://example.com/test
  25                 newsgroup = inbox.test
  26
  27 =head2 VARIABLES
  28
  29 =over 8
  30
  31 =item publicinbox.<name>.address
  32
  33 The email address of the public-inbox.  May be specified
  34 more than once for merging multiple mailing lists (or migrating
  35 to new addresses).  This must be specified at least once,
  36 the first value will be considered the primary address for
  37 informational purposes.
  38
  39 Default: none, required
  40
  41 =item publicinbox.<name>.mainrepo
  42
  43 The absolute path to the git repository which hosts the
  44 public-inbox.  This must be specified once.
  45
  46 Default: none, required
  47
  48 =item publicinbox.<name>.url
  49
  50 The primary URL for hosting the HTTP/HTTPS archives.
  51 Additional HTTP/HTTPS URLs may be specified via
  52 C<$GIT_DIR/cloneurl> as documented in L<gitweb(1)>
  53
  54 Default: none, optional
  55
  56 =item publicinbox.<name>.newsgroup
  57
  58 The NNTP group name for use with L<public-inbox-nntpd(8)>.  This
  59 may be any newsgroup name with hierarchies delimited by '.'.
  60 For example, the newsgroup for L<mailto:meta@public-inbox.org>
  61 is: C<inbox.comp.mail.public-inbox.meta>
  62
  63 Omitting this for the given inbox will prevent the group from
  64 being read by L<public-inbox-nntpd(1)>
  65
  66 Default: none, optional
  67
  68 =item publicinbox.<name>.watch
  69
  70 A location for L<public-inbox-watch(1)> to watch.  Currently,
  71 only C<maildir:> paths are supported:
  72
  73         [publicinbox "test"]
  74                 watch = maildir:/path/to/maildirs/.INBOX.test/
  75
  76 Default: none; only for L<public-inbox-watch(1)> users
  77
  78 =item publicinbox.<name>.watchheader
  79
  80         [publicinbox "test"]
  81                 watchheader = List-Id:<test.example.com>
  82
  83 Default: none; only for L<public-inbox-watch(1)> users
  84
  85 =item publicinbox.<name>.nntpmirror
  86
  87 This may be the full NNTP URL of an independently-run mirror.
  88 For example, the https://public-inbox.org/meta/ inbox is
  89 mirrored by Gmane at
  90 C<nntp://news.gmane.org/gmane.mail.public-inbox.general>
  91
  92 Default: none
  93
  94 =item publicinboxwatch.spamcheck
  95
  96 This may be set to C<spamc> to enable the use of SpamAssassin
  97 L<spamc(1)> for filtering spam before it is imported into git
  98 history.  Other spam filtering backends may be supported in
  99 the future.
 100
 101 Default: none
 102
 103 =item publicinboxwatch.watchspam
 104
 105 This may be set to C<spamc> to enable the use of SpamAssassin
 106 L<spamc(1)> for filtering spam before it is imported into git
 107 history.  Other spam filtering backends may be supported in
 108 the future.  This only affects L<public-inbox-watch(1)>.
 109
 110 Default: none
 111
 112 =item publicinbox.nntpserver
 113
 114 Set this to point to the address of the L<public-inbox-nntpd(1)>
 115 instance.  This is used to advertise the existence of the NNTP
 116 presnce in the L<PublicInbox::WWW> HTML interface.
 117
 118 Multiple values are allowed for servers with multiple
 119 addresses or mirrors.
 120
 121 Default: none
 122
 123 =item publicinbox.<name>.feedmax
 124
 125 The size of an Atom feed for the inbox.  If specified more than
 126 once, only the last value is used.  Invalid values (<= 0) will
 127 be treated as the default value.
 128
 129 Default: 25
 130
 131 =back
 132
 133 =head1 ENVIRONMENT
 134
 135 =over 8
 136
 137 =item PI_CONFIG
 138
 139 Used to override the default "~/.public-inbox/config" value.
 140
 141 =back
 142
 143 =head1 CONTACT
 144
 145 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
 146
 147 The mail archives are hosted at L<https://public-inbox.org/meta/>
 148 and L<http://hjrcffqmbrq6wope.onion/meta/>
 149
 150 =head1 COPYRIGHT
 151
 152 Copyright 2016 all contributors L<mailto:meta@public-inbox.org>
 153
 154 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 155
 156 =head1 SEE ALSO
 157
 158 L<git(1)>, L<git-config(1)>, L<public-inbox-daemon(8)>,
 159 L<public-inbox-mda(1)>, L<public-inbox-watch(1)>