1INCOMING.CONF(5) InterNetNews Documentation INCOMING.CONF(5)
2
6 incoming.conf - Configuration of incoming news feeds
7
9 The file pathetc/incoming.conf consists of three types of entries:
10 key/value, peer and group. Comments are from the hash character "#" to
11 the end of the line. Blank lines are ignored. All key/value entries
12 within each type must not be duplicated. Key/value entries are a
13 keyword immediately followed by a colon, at least one blank and a
14 value. For example:
15 max-connections: 10
17 A legal key does not contains blanks, colons, nor "#". There are three
19 different types of values: integers, booleans, and strings. Integers
20 are as to be expected. A boolean value is either "true" or "false"
21 (case is significant). A string value is any other sequence of
22 characters. If the string needs to contain whitespace, then it must be
23 quoted with double quotes.
24 Peer entries look like:
26 peer <name> {
28 # body
29 }
30 The word "peer" is required. <name> is a label for this peer. It is
32 any string valid as a key. The body of a peer entry contains some
33 number of key/value entries.
34 Group entries look like:
36 group <name> {
38 # body
39 }
40 The word "group" is required. <name> is any string valid as a key.
42 The body of a group entry contains any number of the three types of
43 entries. So key/value pairs can be defined inside a group, and peers
44 can be nested inside a group, and other groups can be nested inside a
45 group. Key/value entries that are defined outside of all peer and
46 group entries are said to be at global scope. Global key/value entries
47 act as defaults for peers. When innd looks for a specific value in a
48 peer entry (for example, the maximum number of connections to allow),
49 if the value is not defined in the peer entry, then the enclosing
50 groups are examined for the entry (starting at the closest enclosing
51 group). If there are no enclosing groups, or the enclosing groups
52 don't define the key/value, then the value at global scope is used. A
53 small example could be:
54 # Global value applied to all peers that have no value of their own.
56 max-connections: 5
57 # A peer definition.
59 peer uunet {
60 hostname: usenet1.uu.net
61 }
62 peer vixie {
64 hostname: gw.home.vix.com
65 max-connections: 10 # Override global value.
66 }
67 # A group of two peers which can open more connections than normal.
69 group fast-sites {
70 max-connections: 15
71 # Another peer. The max-connections: value from the
73 # fast-sites group scope is used.
74 peer data.ramona.vix.com {
75 hostname: data.ramona.vix.com
76 }
77 peer bb.home.vix.com {
79 hostname: bb.home.vix.com
80 max-connections: 20 # He can really cook.
81 }
82 }
83 Given the above configuration file, the defined peers would have the
85 following values for the max-connections key.
86 uunet 5
88 vixie 10
89 data.ramona.vix.com 15
90 bb.home.vix.com 20
91
93 The following keys are allowed:
94 comment
96 This key requires a string value. Reserved for future use. The
97 default is an empty string.
98 email
100 This key requires a string value. Reserved for future use. The
101 default is an empty string.
102 hold-time
104 This key requires a positive integer value. It defines the hold
105 time before closing, if the connection is over max-connections. A
106 value of zero specifies immediate close. The default is 0.
107 hostname
109 This key requires a string value. It is a list of hostnames
110 separated by a comma. A hostname is either a fully qualified
111 domain name that resolves to the IPv4 or IPv6 address of the peer,
112 or the dotted-quad IP address of the peer for IPv4, or the colon-
113 separated IP address of the peer for IPv6. If this key is not
114 present in a peer block, the hostname defaults to the label of the
115 peer.
116 identd
118 This key requires a string value. It is used if you wish to
119 require a peer's user name retrieved through identd match the
120 specified string. Note that currently innd does not implement any
121 timeout in identd callbacks, so enabling this option may cause innd
122 to hang if the remote peer does not respond to ident callbacks in a
123 reasonable timeframe. The default is an empty string, that is to
124 say no identd.
125 ignore
127 This key requires a boolean value. Setting this entry causes innd
128 to refuse every article sent via CHECK or IHAVE by this peer. The
129 default is false.
130 max-connections
132 This key requires a positive integer value. It defines the maximum
133 number of connections allowed. A value of zero specifies an
134 unlimited number of maximum connections ("unlimited" or "none" can
135 be used as synonyms). The default is 0.
136 nolist
138 This key requires a boolean value. It defines whether a peer is
139 allowed to issue list command. The default is false, that is to
140 say it can.
141 noresendid
143 This key requires a boolean value. It defines whether innd should
144 send 438 (response to CHECK, in streaming mode) or 435 (response to
145 IHAVE in non-streaming mode) responses instead of 431 (response to
146 CHECK) or 436 (response to IHAVE) if a message is offered that is
147 already received from another peer. The deferral feature can be
148 useful for peers that resend messages right away, as innfeed does.
149 The default is false: the deferral feature is used so that the
150 peer receives 431 and 436 codes, and therefore resends the article
151 later.
152 password
154 This key requires a string value. It is used if you wish to
155 require a peer to supply a password via AUTHINFO USER/PASS. The
156 default is an empty string, that it to say no password.
157 patterns
159 This key requires a string value. It is a list of
160 newsfeeds(5)-style list of newsgroups which are to be accepted from
161 this host. The default is the string "*", that is to say all
162 groups are accepted.
163 skip
165 This key requires a boolean value. Setting this entry causes this
166 peer to be skipped. The default is false.
167 streaming
169 This key requires a boolean value. It defines whether streaming
170 commands (CHECK and TAKETHIS) are allowed from this peer. The
171 default is true.
172
174 Written by Fabien Tassin <fta@sofaraway.org> for InterNetNews.
175 Converted to POD by Julien Elie.
176 $Id: incoming.conf.pod 10179 2017-09-18 20:13:48Z iulius $
178
180 inn.conf(5), innd(8), newsfeeds(5), uwildmat(3).
181INN 2.6.3 2018-01-28 INCOMING.CONF(5)