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