Highwinds Directives - Tornado Back End

Symbols | A | B | C | D | E | 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.
<Chain> </Chain>N/A
<OverviewCache> </OverviewCache>N/A
<Spool> </Spool>N/A
ActiveFileAny path to a file
AliasesHostname list delimited with commas.
AllowActiveControlNone (off), Full, nowildcards
AllowFeedingTrue (on), False (off)
AllowFilterTrue (on), False (off)
AllowNewNewsTrue (on), False (off)
AllowPostingTrue (on), False (off)
AllowProtocolsNone, HTTP, NNTP, *
AllowReadingTrue (on), False (off)
AllowThreadingTrue (on), False (off)
ArchiveThreshold1 to 100
AuthenticationFileA valid path and filename
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
CacheNumber1 to 255
CommandLogA valid path and filename
CompressedTrue (on), False (off)
CompressionLevel0 to 9
ControlDepth0 to (2^31)-1
CountRefresh0 to 3600
DenyMessageA text message
DescriptionsFileA valid path and filename
DistributionA valid glob-style expression
DistributionsFileA valid path and filename
ErrorTemplateA valid path and filename
FeedMaxBytesPerSecond0, 1024 to (2^31)-1
FilterSubscriptionA glob-style expression
ForceOrganizationTrue (on), False (off)
FrontPageA valid filename
GroupAllowFileA valid path and filename
GroupDenyFileA valid path and filename
HostConnectionLimit0, or 1 to (2^32) -1
HostNamesA valid hostname or IP address or a valid hostname or IP addressappended with a ':' and a valid port number.
HttpCategorizationA valid path and filename
HttpDirectoryValid path and filename
HttpHostnameA valid list of hostnames separated by commas or spaces
HttpPathA valid glob-style pattern
IdleTime0, 1 to (2^31)-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
InterfaceA valid IP address or hostname
Kilobytes10000 to 2000000
ListRefresh0, 1 to 1024
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.
MaxConnections0, 1 to 1024
MaxDepth1 to 5000
MaxIncomingNumberOfStreams0 to 1024
MaxLength1 to 4194304
MessageMarking`No` - No message marking support is provided. `Cookie` - Use only HTTP cookies, no server-side storage is provided for the marked messages. -- `Auth` - AuthenticationProgram is used for persistent storage, and it does not send browser cookies. -- `Both` - HTTP cookies are sent, and the AuthenticationProgram is used for persistent storage.
MessageMarkingCacheSize0 to the number of newsgroups on the server
MessageMarkingDomainA valid HTTP cookie format
MimeExtensionsMapA valid path and filename
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.
TemplateDirectoryA valid path
ThreadCacheExpireNumArts0, 1 to (2^31)-1
ThreadCacheExpireTime0, 1 to (2^31)-1
ThreadCacheSize0 up to the number of newsgroups on the server (The recommended value is the number of newsgroups divided by 4.)
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'
XrefMasterList of globs

Symbols

Symbols | A | B | C | D | E | 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.

<Chain> </Chain>

Delimiters for the beginning and end of a Chain object.

<OverviewCache> </OverviewCache>

Delimiters for the beginning and end of a Overview Cache object.

<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 | E | 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.

Aliases

The Aliases directive names all of the machines that are 'equivalent' for this outgoing feed. If the 'Path:' field of an article indicates that it has already been to one of these sites, it won't be sent to this feed. If you decide to use this directive, don't forget to include the value of OutgoingHostname in your list of machines. Please remember that the value for this directive is a list of glob-style patterns.

AllowActiveControl

Enables users to add, change, or remove newsgroups through the Web interface. The nowildcards option enables full control but disallows wildcards.

AllowFeeding

Permits clients matching the IncomingHostnames field on this feed to use IHAVE, CHECK and other NNTP Feeding commands.

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.

AllowNewNews

Indicates whether the feed object supports the NEWNEWS protocol request. If you set this directive, you must also specify the -log and -loggroups directives in the start.conf file. Caution! The NEWNEWS request is performance intensive. If you set this directive to True, make sure that the server has sufficient resources to handle the extra load.

AllowPosting

Permits clients matching the IncomingHostnames directive on this feed to post articles on the news server. Posts are done with NNTP POST command.

AllowProtocols

Enables the feed/virtual server object to support the specified protocol.

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.).

AllowThreading

Enables message threading on a per-feed basis. A value of True allows users to view a group with or without threading, whereas a value of False requires users to view the group without threading. Threading is not to be confused with multiple threads of execution at the server level, but message threading, where each message can have a string of replies that creats a "thread".

ArchiveThreshold

Specifies a warning threshold for a spool object. If you set Archive Threshold 'n' in a spool object, where 'n' is a warning threshold, the spool will stop accepting articles once it is filled. When the threshold is reached, the spool object issues a LOG_CRIT log message and continues to issue a message at each 1% increase thereafter. For example, specifying the ActiveThreshold at 90 results in a log message when the spool reaches 90% of its capacity, and an additional message at each additional 1% up to 100%. Warning: Once a spool is an archive spool, it must be destroyed to turn it back to a normal spool.

AuthenticationFile

Specifies the path of the file to be used to authenticate users before any transactions are allowed with the server. Refer to the authentication-EXAMPLE file in the etc/ directory for documentation on the file format. The path can be either an absolute path or a path relative to the bin/ directory.

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 | E | 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 | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X

CacheNumber

Specifies a unique number for each overview cache object. Note: This directive is required for all overview cache objects.

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.

Compressed

Specifies whether the system should compress new articles as the are stored in this spool. Although multiple scalable compression algorithms are provided, all compression takes CPU time and is suitable only for machines with low CPU utilization. A spool can contain a mixture of compressed and uncompressed articles, so you can change the value of this directive at any time without losing articles that have already been stored in this spool. If you set the start.conf log variable, successfully compressed articles have the compressed size listed after a slash in the size field. If you run with the -log option, articles in the spool which were compressed successfully ( i.e. where the article compressed favorably) have the compressed size listed after a slash in the size field.

CompressionLevel

Specifies the compression type that is used in a compressed spool. A value of 0 specifies a real-time high-compression algorithm that specializes in low memory usage. Values from 1 through 9 indicate a "deflate" compression scheme. The higher the compression level, the more aggressive is the compression, and the more memory and CPU power are consumed. High compression levels are recommended only for servers that use little CPU and memory. Since spool objects can contain mixtures of articles compressed with different CompressionLevels, the value of this directive can be changed at any time.

See Also: Compressed.

ControlDepth

Specifies the number of control messages that require external processing to be queued in the control directory. When this limit is reached, no new messages are queued. A value of 0 indicates that no control messages will be queued for external processing.

CountRefresh

Specifies the how often (in minutes) to refresh article counts for individual groups on the master server.

D

Symbols | A | B | C | D | E | 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.

Distribution

Specifies the glob-style expressions for the outgoing newsfeed that must match the distribution line of an article. Articles that arrive wit h no specification of their distribution will be treated as if they had a distri bution of 'world'.

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.

E

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

ErrorTemplate

Specifies the location of a file, relative to the TemplateDirectory/ directory, that contains an XML template for the display of error messages. This page can be used to display a more informative error message than the Web browser message Error 404 Page not Found.

F

Symbols | A | B | C | D | E | 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.

FrontPage

Specifies a file that is the initial page (home page) for HTTP connections made through this virtual server object. This file is relative to the directory specified in the HttpDirectory directive.

G

Symbols | A | B | C | D | E | 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 | E | 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

HostNames

Specifies the name and optionally the port of the master server to connect to. Multiple server names can be specified and separated by commas. Required for all chain objects.

HttpCategorization

Specifies the path and filename of the compiled categorization file used with category URLs.

HttpDirectory

Specifies the path to the root directory for static HTML files, images, and other static documents for the given feed or virtual server object.

See Also: FrontPage.

HttpHostname

Provides a list of hostnames that the given feed or virtual server responds to.

HttpPath

The directive specifies a glob-style pattern that the enclosing Feed/VirtualServer object will match based on url. This supports, for example, the use of different template directories based on pattern matching the newsgroup field.

I

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

IdleTime

Specifies how long (in seconds) a master server connection can remain idle before it should be closed. '0' means connections are never closed.