samples/incoming.conf

   1 ##  $Revision: 2372 $
   2 ##  incoming.conf - names and addresses that feed us news
   3 ##
   4 ##  This file consists of three types of entries: key/value, peer and group.
   5 ##  Comments are taken from the hash character ``#'' to the end of the line.
   6 ##  Blank lines are ignored.
   7 ##
   8 ##  Key/value entries are a keyword immediatly followed by a colon, at least
   9 ##  one blank and a value. For example:
  10 ##
  11 ##         max-connections: 10
  12 ##
  13 ##  A legal key contains nor blanks, nor colon, nor ``#''.
  14 ##  There are 5 different type of  values:  integers,  booleans, and strings.
  15 ##  Integers are as to be expected. A boolean value is either ``true'' or
  16 ##  ``false'' (case is significant). A string value is any other sequence of
  17 ##  characters. If the string needs to contain whitespace, then it must be
  18 ##  quoted with double quotes.
  19 ##
  20 ##  Peer entries look like:
  21 ##
  22 ##          peer <name> {
  23 ##               # body
  24 ##          }
  25 ##
  26 ##  The word ``peer'' is required. <name> is a label for this peer. It is
  27 ##  any string valid as a key. The body of a peer entry contains some number
  28 ##  of key/value entries.
  29 ##
  30 ##  Group entries look like:
  31 ##
  32 ##          group <name> {
  33 ##               # body
  34 ##          }
  35 ##
  36 ##  The word ``group'' is required. The ``<name>'' is any string valid as a
  37 ##  key. The body of a group entry contains any number of the three types of
  38 ##  entries. So key/value pairs can be defined inside a group, and peers can
  39 ##  be nested inside a group, and other groups can be nested inside a group.
  40 ##
  41 ##  Key/value entries that are defined outside of all peer and group entries
  42 ##  are said to be at ``global scope''. Global key/value entries act as
  43 ##  defaults for peers. When innd looks for a specific value in a peer entry
  44 ##  (for example, the maximum number of connections to allow), if the value
  45 ##  is not defined in the peer entry, then the enclosing groups are examined
  46 ##  for the entry (starting at the closest enclosing group). If there are no
  47 ##  enclosing groups, or the enclosing groups don't define the key/value,
  48 ##  then the value at global scope is used.
  49 ##
  50 ##  A small example could be:
  51 ##
  52 ##      # Global value applied to all peers that have no value of their own.
  53 ##      max-connections: 5
  54 ##
  55 ##      # A peer definition.
  56 ##      peer uunet {
  57 ##           hostname: usenet1.uu.net
  58 ##      }
  59 ##
  60 ##      peer vixie {
  61 ##              hostname: gw.home.vix.com
  62 ##              max-connections: 10      # override global value.
  63 ##      }
  64 ##
  65 ##      # A group of two peers who can open more connections than normal
  66 ##      group fast-sites {
  67 ##           max-connections: 15
  68 ##
  69 ##           # Another peer. The ``max-connections'' value from the
  70 ##           # ``fast-sites'' group scope is used.
  71 ##           peer data.ramona.vix.com {
  72 ##                hostname: data.ramona.vix.com
  73 ##           }
  74 ##
  75 ##           peer bb.home.vix.com {
  76 ##                hostname: bb.home.vix.com
  77 ##                max-connections: 20 # he can really cook.
  78 ##           }
  79 ##      }
  80 ##
  81 ##  Given the above configuration file, the defined peers would have the
  82 ##  following values for the ``max-connections'' key.
  83 ##
  84 ##          uunet                  5
  85 ##          vixie                 10
  86 ##          data.ramona.vix.com   15
  87 ##          bb.home.vix.com       20
  88 ##
  89 ##  Height keys are allowed:
  90 ##
  91 ##  hostname:
  92 ##   This key is mandatory in a peer block. The value is a string representing
  93 ##   a list of hostnames separated by a comma. A hostname is the host's FQDN,
  94 ##   or the dotted quad ip-address of the peer.
  95 ##
  96 ##  streaming:
  97 ##   This key requires a boolean value. It defines whether streaming commands
  98 ##   are allowed from this peer. (default=true)
  99 ##
 100 ##  max-connections:
 101 ##   This key requires positive integer value. It defines the maximum number
 102 ##   of connections allowed. A value of zero specifies an unlimited number
 103 ##   of maximum connections (``unlimited'' or ``none'' can be used as synonym).
 104 ##   (default=0)
 105 ##
 106 ##  hold-time:
 107 ##   This key requires positive integer value. It defines the hold time before
 108 ##   close, if the connection is over max-connections. A value of zero
 109 ##   specifies immediate close. (default=0)
 110 ##
 111 ##  password:
 112 ##   This key requires a string value. It is used if you wish to require a peer
 113 ##   to supply a password. (default=no password)
 114 ##
 115 ##  patterns:
 116 ##   This key requires a string value. It is a list of newsfeeds(5)-style list
 117 ##   of newsgroups which are to be accepted from this host. (default="*")
 118 ##
 119 ##  email:
 120 ##   This key requires a string value. Reserved for future use. (default=empty)
 121 ##
 122 ##  comment:
 123 ##   This key requires a string value. Reserved for future use. (default=empty)
 124 ##
 125 ##  skip:
 126 ##   This key requires a boolean value. Setting this entry causes this peer
 127 ##   to be skipped. Reserved for future use. (default=false)
 128 ##
 129 ##  noresendid:
 130 ##   This key requires a boolean value. It defines whether innd should send
 131 ##   "431 RESENDID" (stream mode) or "436 Retry later" (non-stream mode)
 132 ##   responses if a message is offered that is already received from another
 133 ##   peer. This can be useful for peers that resend messages right away,
 134 ##   as innfeed does. (default=false)
 135 ##
 136
 137 streaming:              true   # streaming allowed by default
 138 max-connections:        8      # per feed
 139
 140 peer ME {
 141   hostname:         "localhost, 127.0.0.1"
 142 }