1INCOMING.CONF(5) File Formats Manual INCOMING.CONF(5)
2
6 incoming.conf - names and addresses that feed us news
7
9 The file <pathetc in inn.conf>/incoming.conf consists of three types of
10 entries: key/value, peer and group. Comments are from the hash charac‐
11 ter ``#'' to the end of the line. Blank lines are ignored. All
12 key/value entries within each type must not be duplicated.
13 Key/value entries are a keyword immediately followed by a colon, at
15 least one blank and a value. For example:
16 max-connections: 10
18 A legal key does not contains blanks, colons, nor ``#''. There are 3
20 different types of values: integers, booleans, and strings. Integers
21 are as to be expected. A boolean value is either ``true'' or ``false''
22 (case is significant). A string value is any other sequence of charac‐
23 ters. If the string needs to contain whitespace, then it must be quoted
24 with double quotes.
25 Peer entries look like:
27 peer <name> {
29 # body
30 }
31 The word ``peer'' is required. ``<name>''is a label for this peer. The
33 ``<name>'' is any string valid as a key. The body of a peer entry con‐
34 tains some number of key/value entries.
35 Group entries look like:
37 group <name> {
39 # body
40 }
41 The word ``group'' is required. The ``<name>'' is any string valid as a
43 key. The body of a group entry contains any number of the three types
44 of entries. So key/value pairs can be defined inside a group, and peers
45 can be nested inside a group, and other groups can be nested inside a
46 group.
47 Key/value entries that are defined outside of all peer and group
49 entries are said to be at ``global scope''. Global key/value entries
50 act as defaults for peers. When innd(8) looks for a specific value in a
51 peer entry (for example, the maximum number of connections to allow),
52 if the value is not defined in the peer entry, then the enclosing
53 groups are examined for the entry (starting at the closest enclosing
54 group). If there are no enclosing groups, or the enclosing groups don't
55 define the key/value, then the value at global scope is used.
56 A small example could be:
58 # Global value applied to all peers that have
60 # no value of their own.
61 max-connections: 5
62 # A peer definition.
64 peer uunet {
65 hostname: usenet1.uu.net
66 }
67 peer vixie {
69 hostname: gw.home.vix.com
70 max-connections: 10 # override global value.
71 }
72 # A group of two peers who can open more
74 # connections than normal
75 group fast-sites {
76 max-connections: 15
77 # Another peer. The ``max-connections'' value from the
79 # ``fast-sites'' group scope is used. The ``hostname'' value
80 # defaults to the peer's name.
81 peer data.ramona.vix.com {
82 }
83 peer bb.home.vix.com {
85 hostname: bb.home.vix.com
86 max-connections: 20 # he can really cook.
87 }
88 }
89 Given the above configuration file, the defined peers would have the
91 following values for the ``max-connections'' key.
92 uunet 5
94 vixie 10
95 data.ramona.vix.com 15
96 bb.home.vix.com 20
97 Ten keys are allowed:
99 hostname:
101 This key requires a string value. It is a list of hostnames sep‐
102 arated by a comma. A hostname is the host's FQDN, or the dotted
103 quad ip-address of the peer. If this key is not present in a
104 peer block, the hostname defaults to the label of the peer.
105 streaming:
107 This key requires a boolean value. It defines whether streaming
108 commands are allowed from this peer. (default=true)
109 max-connections:
111 This key requires a positive integer value. It defines the maxi‐
112 mum number of connections allowed. A value of zero specifies an
113 unlimited number of maximum connections (``unlimited'' or
114 ``none'' can be used as synonym). (default=0)
115 hold-time:
117 This key requires a positive integer value. It defines the hold
118 time before closing, if the connection is over max-connections.
119 A value of zero specifies immediate close. (default=0)
120 password:
122 This key requires a string value. It is used if you wish to
123 require a peer to supply a password. (default=no password)
124 identd:
126 This key requires a string value. It is used if you wish to
127 require a peer's user name retrieved through identd match the
128 specified string. Note that currently innd(8) does not implement
129 any timeout in identd callbacks, so enabling this option may
130 cause innd to hang if the remote peer does not respond to ident
131 callbacks in a reasonable timeframe (default=no identd)
132 patterns:
134 This key requires a string value. It is a list of news‐
135 feeds(5)-style list of newsgroups which are to be accepted from
136 this host. (default="*")
137 email: This key requires a string value. Reserved for future use.
139 (default=empty)
140 comment:
142 This key requires a string value. Reserved for future use.
143 (default=empty)
144 skip: This key requires a boolean value. Setting this entry causes
146 this peer to be skipped. (default=false)
147 noresendid:
149 This key requires a boolean value. It defines whether innd(8)
150 should send ``431 RESENDID'' responses if a message is offered
151 that is being received from another peer. This can be useful for
152 peers that resend messages right away, as innfeed does.
153 (default=false)
154 nolist:
156 This key requires a boolean value. It defines whether a peer is
157 allowed to issue list command. (default=false)
158
160 Written by Fabien Tassin <fta@sofaraway.org> for InterNetNews. This is
161 revision 6992, dated 2004-10-01.
162
164 inn.conf(5), innd(8), newsfeeds(5), uwildmat(3).
165 INCOMING.CONF(5)