Highwinds Directives - Tornado Front End

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

#includeAny path to a file. Relative Paths from the bin/ directory.
<Spool> </Spool>N/A
ActiveFileAny path to a file
AllowFilterTrue (on), False (off)
AllowReadingTrue (on), False (off)
AuthenticationProgramA valid path and filename
AutoAddGroupsTrue (on), False (off)
BandwidthLimitTrigger0, 1024 to (2^31)-1
BandwidthTrackingWindow0, 10 to (2^31)-1
BandwidthUnlimitTrigger0, 1024 to (2^31)-1
CommandLogA valid path and filename
DenyMessageA text message
DescriptionsFileA valid path and filename
DistributionsFileA valid path and filename
FeedMaxBytesPerSecond0, 1024 to (2^31)-1
FilterSubscriptionA glob-style expression
ForceOrganizationTrue (on), False (off)
GroupAllowFileA valid path and filename
GroupDenyFileA valid path and filename
HostConnectionLimit0, or 1 to (2^32) -1
IncomingFeedNameThe name of an incoming feed object
IncomingGroupFilterA glob-style expression
IncomingHostnamesA list of glob or CIDR style expressions separated by commas
IncomingInterfaceA valid IP address or hostname
Kilobytes10000 to 32000000 (post Feb '03, the Max is 2,000,000,000).
LocaleA valid locale
LocaleDirectoryA valid path
MailerOptionAny value that the MailerPath program requires to process a message that includes full headers and body.
MailerPathA valid filename for a file that the server is running and that is executable by the user (default news). Used when an article is posted to a moderated group.
MaxDepth1 to 5000
MaxIncomingNumberOfStreams0 to 1024
MaxLength1 to 4194304
MinLength0 to 4194304
ModeratorsFileA valid path
NumberOfStreams1 to 300
OrganizationA text string
OutgoingFeedNameA text string
OutgoingHostNameA valid hostname or IP address or a valid hostname or IP address appended with a ':' and a valid port number.
OutgoingInterfaceA valid hostname or IP address
PathA valid path and filename
ProcessCancelsTrue (on), False (off)
ProcessSupercedesTrue (on), False (off)
RefuseSpamCancelsTrue (on), False (off)
RewriteDateTrue (on), False (off)
RewritePathTrue (on), False (off)
SecureReverseDNSTrue (on), False (off)
SendXrefInOverviewsTrue (on), False (off)
ShowPostFilterRejectionTrue (on), False (off)
SpoolNumber1 to 255
StampXReceivedDateTrue (on), False (off)
StoreControlMessagesTrue (on), False (off)
SubjectPatternA valid glob-style pattern
SubscriptionA glob-style expression
TCPReceiveBufferValues depend on the operating system, but most have a limit of 65536 bytes.
TCPSendBufferValues depend on the operating system, but most have a limit of 65536 bytes.
TimeOut0, 1 to (2^31)-1
TriggeredBandwidthTrackingWindow0, 60 to (2^31)-1
TriggeredMaxBytesPerSecond0 or 1024 to (2^31)-1
UpstreamDistributionA valid glob-style expression
UpstreamFilterSubscriptionA valid glob-style expression
UpstreamHostNamesA valid hostname or IP address or a valid hostname or IP address appended with a ':' and a valid port number.
UpstreamInterfaceA valid IP address or hostname
UpstreamSubscriptionA valid glob-style expression
ValidateCancelsTrue (on), False (off)
ValidateSupercedesTrue (on), False (off)
WelcomeMessageAny text message
XComplaintsToA valid e-mail address
XrefAction'Generate' or 'Parse'

Symbols

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

#include

Specifies another configuration file to be loaded at this point in the file. The specified path can be absolute, or relative to the "bin" directory. (Full recursion is permitted). Use #include to simplify multiple definitions and save administration busy work.

<Spool> </Spool>

Delimiters for the beginning and end of a Spool object. Minimum spool size is 15,000 Kilobytes (as of .348 releases and above). Maximum spool size is 2000 Gigabytes (as of .348 releases and above)

A

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

ActiveFile

The ActiveFile directive specifies the location of the active file. It can be specified by absolute path or a path relative to the bin directory. The active file contains a list of the newsgroups currently being served by this system, including high and low article numbers and moderation status of the group.

AllowFilter

If set to true, this directive allows hosts matching the IncomingHostnames field to use the NNTP FILTER extension to rapidly cancel articles to this news server. See the NNTP Filter Proposal for details.

AllowReading

Permits clients matching the IncomingHostnames directive on this feed to read articles that are saved on the news server. Reading is done with NNTP Reader commands (ARTICLE, BODY, GROUP, HEAD, etc.).

AuthenticationProgram

Specifies a program to authenticate users and connections before any transactions are allowed with the server. The path for the filename can be either an absolute path or a path relative to the bin/ directory. Multiple feeds that have the same value assigned for this directive share access to a single instance of the AuthenticationProgram directive. An extremely powerful directive and can be used to implement tight control over capacity, simultaneous access, and security. Refer to the Advanced Configuration section for more details.

AutoAddGroups

Specifies that while running in XrefAction Parse mode, groups that are not in the active file and to which numbered articles are posted should be automatically added to the active file.

B

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

BandwidthLimitTrigger

Specifies the maximum bandwidth allowed, in bytes per second, for a connection in an untriggered state. If this limit is exceeded during the time span specified by BandwidthTrackingWindow, the connection transitions to a triggered state. A value of 0 indicates unlimited bandwidth.

BandwidthTrackingWindow

Defines the span of time, in seconds, used to calculate average bandwidth for a connection in an untriggered state. This time span should include the initially defined time span, unless an authentication program overrides the initial state of the connection. A value of 0 indicates unlimited bandwidth.

See Also: BandwidthLimitTrigger.

BandwidthUnlimitTrigger

Specifies the bandwidth, in bytes per second, that sets the maximum limit for the bandwidth available for a connection in a triggered state. If the bandwidth used is less than this limit during the time span specified by TriggeredBandwidthTrackingWindow, the connection transitions to an untriggered state. A value of 0 indicates unlimited bandwidth.

See Also: BandwidthLimitTrigger, BandwidthTrackingWindow.

C

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

CommandLog

Logs all the commands that are sent to this feed object in the specified file. The path for this log file can be either an absolute path or a path relative to the bin/ directory. This directive is useful for debugging problems pertaining to news readers. The log file is buffered, but executing the bin/ statsnow command flushes the buffer.

D

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

DenyMessage

Specifies the message returned by the server when it denies a connection because no feed objects match any IncomingHostnames directive.

DescriptionsFile

Specifies the location of a file that describes each newsgroup. This can be either an absolute path or a path relative to the bin/ directory. A default description file is provided with the installation which provides descriptions of the newsgroups in the 'Big Eight' hierarchy.

DistributionsFile

Specifies the location of the distributions file. This can be either an absolute path or a path relative to the bin/ directory. The distributions file contains newsgroup patterns and the list of distributions that are to be used for articles posted without a Distribution header line. This file is especially useful for administrators wishing to participate in Usenet II.

F

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

FeedMaxBytesPerSecond

Specifies the number of bytes per second that are sent to all the connections (not each individual connection) of the feed object. It sets the feed aggregate bandwidth limit. A value of 0 indicates that an unlimited number of bytes can be sent. Note: The simultaneous use of both FeedMaxBytesPerSecond and MaxBytesPerSecond is not supported.

FilterSubscription

Specifies a glob-style expression that the Newsgroups: header must not match. Any match of the glob will disallow a particular article.

ForceOrganization

Specifies that the organization header in an article is to be replaced with the value specified in the Organization directive.

G

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

GroupAllowFile

Specifies the location of a file which contains a list of newsgroups which are allowed in the contained object. The file can be specified by absolute path or a path relative to the bin directory. This file specifies a list of newsgroups, not a list of glob-style patterns. Since this directiveis applied at the same time the Subscription directive is applied, we suggest that you use the Subscription directive unless the directive gets very large.

GroupDenyFile

Specifies the location of a file which contains a list of newsgroups which are NOT allowed in the contained object. The file can be specified by absolute path or a path relative to the bin directory. This file specifies a list of newsgroups, not a list of glob-style patterns. Since this directiveis applied at the same time the FilterSubscription directive is applied, we suggest that you use the FilterSubscription directive unless the directive gets very large.

See Also: FilterSubscription.

H

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

HostConnectionLimit

Sets the upper limit for individual hosts that are permitted to connect within a feed object. A value of 0 indicates unlimited connections. For instance, 'HostConnectionLimit 1' in a feed object which serves multiple clients ensures that only one connection may be running on each client machine. 'HostConnectionLimit 10' in a feed object which matches one multi-user machine ensures that only ten connections from that machine can read news at once. To be clear, this directive sets a limit for individual hosts within a feed object, not for the entire feed object. See MaxIncomingNumberOfStreams

I

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

IncomingFeedName

Specifies the name of the incoming feed object. All incoming feed objects must have a name that can be referred to in error messages and statistical logs. Note: This directive is required for all incoming feed objects.

IncomingGroupFilter

Specifies a glob-style expression that cannot match the newsgroups line of an article received by the Discussion Server. If an incoming article is posted to a group that matches this expression, the article is dropped.

IncomingHostnames

Specifies a list of hostnames allowed for this feed object and is required for all incoming feed objects. For IP addresses without reverse-DNS ecords, IP addresses and glob-style IP patterns like '10.2.3.*' can be used. Multiple patterns can be used, separated by commas. Incoming connections to the server are assigned to a feed object by matching top-bottom in the feeds.conf file. So it is important that the feed objects go from most-specific to most-general. That is, a feed object with 'IncomingHostNames newsfeed.company.com' should be placed earlier in the file than a feed object with 'IncomingHostNames *.company.com'.

See Also: HostConnectionLimit.

IncomingInterface

Defines the IP address of the network interface that is used for the incoming newsfeed. On machines with a single network interface, this directive does not need to be set. For multiple network interfaces, this directive enables you to control which interface is used for each feed object. By default, Highwinds products bind all network interfaces.

K

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

Kilobytes

Specifies the size in kilobytes of this spool object. Individual sp ool objects can be as small as 10,000 Kilobytes and as large as 32,000,000 Kilobytes. As of releases post February 2003, the Kilobytes directive can be replaced with Megabytes, Gigabytes, or Terabytes and the appropriate calculations will take place to set the size for the Spool object. Note: This directive is required for all Spool objects.

L

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

LocaleDirectory

Specifies the location of the directory that contains localization message text files.

Locale

Specifies the locale for this feed object. The value will be used to load the message catalog located in the LocaleDirectory

See Also: LocaleDirectory.

M

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

MailerOption

Specifies options passed during startup to the program specified in MailerPath.

MailerPath

Specifies the location of a program that accepts messages on stdin for mailing. This directive is used for articles posted to a moderated group. The location can be either an absolute path or a path relative to the bin/ directory.

See Also: MailerOption.

MaxDepth

Maximum number of articles to keep in the queue for this outgoing feed. If the queue reaches MaxDepth, the oldest articles are removed to make room for newer articles. This value can be set as high as 5,000 articles.

MaxIncomingNumberOfStreams

If specified, this directive limits the total number of connections the feed object can have open for talking to all of the connected hosts. For instance, if you wanted to restrict a site to ten simultaneous connections but not restrict them to specific machines, you could specify MaxIncomingNumberOfStreams 10

MaxLength

Specifies the maximum permitted length of articles in this spool object.

MinLength

Specifies the minimum permitted length of articles in this spool object.

ModeratorsFile

Specifies the location of the moderators file, which lists the email address of the moderator for each moderated group. This can be either an absolute path or a path relative to the bin/ directory.

N

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

NumberOfStreams

Sets the number of simultaneous connections that are open for this outgoing newsfeed.

O

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

Organization

Adds an organization header to all articles posted through this feed object. The existing organization headers are not replaced, unless the ForceOrganization directive is specified.

See Also: ForceOrganization.

OutgoingFeedName

Specifies a unique name for this outgoing feed. This allows you to have more than one outgoing feed for a host. No two feeds can have the same 'OutgoingFeedName'. No slashes or whitespace are allowed in this value. The Default value is simply the value of the 'OutgoingHostname' directive. The value given is used for error-messages and statistics reporting.

OutgoingHostName

and is required for all outgoing feed objects. The provided value should be a hostname, or an IP-address, or a hostname:port or IP-address:port pair. You can have multiple feeds to the same host by creating multiple feed objects with different OutgoingFeedName directives.

OutgoingInterface

Specifies the hostname or IP address of a network interface for the outgoing feed. Do not configure this key if you have only a single network interface. For machines that have multiple network interfaces, this directive enables you to control which interface is used for each newsfeed.

See Also: IncomingInterface.

P

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

Path

Specifies the location of the overview cache or spool object. This path can be either an absolute path or a path relative to the bin/ directory. Note: This directive is required for all overview cache and spool objects.

ProcessCancels

Permits canceled messages to be processed when set to True; otherwise, they are ignored.

ProcessSupercedes

Specifies that articles with a Supercedes header are to be processed and removed when set to True; otherwise, the headers are ignored.

R

Symbols | A | B | C | D | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

RefuseSpamCancels

Specifies that articles with message IDs that begin with 'cancel.' are to be refused. Note: This is a standard convention for third-party or spam cancellations.