Highwinds Directives - Cyclone

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

#includeAny path to a file. Relative Paths from the bin/ directory.
<Spool> </Spool>N/A
AdditionalSubscriptionGlob Pattern
AliasesHostname list delimited with commas.
AllowJunkTrue (on), False (off)
AllowStreamingTrue (on), False (off)
AllowTryAgainTrue (on), False (off)
AuthInfoPassA text string
AuthInfoUserA text string
BackupHostNameA valid IP address or hostname
BackupPortNumberA valid port number
BackupTimeInterval0 to (2^31)-1
ControlDepth0 to (2^31)-1
DelayTime1 to (2^32)-1
DenyMessageA text message
DistributionA valid glob-style expression
DropFilteredArticlesTrue (on), False (off)
DropUnapprovedArticlesTrue (on), False (off)
EncodedTrue (on), False (off)
FilterProgramA path to an executable program.
FilterProgramBodyTrue (on), False (off)
FilterProgramFastFilterKeyAn alphanumeric string.
FilterProgramMultiFilterInteger 1-16
FilterSubscriptionA glob-style expression
GroupAllowFileA valid path and filename
GroupDenyFileA valid path and filename
IncomingExpectedPathStampA text string
IncomingFeedNameThe name of an incoming feed object
IncomingGroupFilterA glob-style expression
IncomingHostnameA valid IP address or hostname
IncomingInterfaceA valid IP address or hostname
IncomingPathFilterA valid glob-style pattern
IncomingSubjectFilterA valid glob-style pattern
Kilobytes10000 to 32000000 (post Feb '03, the Max is 2,000,000,000).
MaxAge1 to 365
MaxBytesPerSecond0 to 4194304
MaxChecks1 to 125
MaxConnectionDuration0, 1 to (2^32)-1
MaxCrossPost1 to 1024
MaxDepth1 to 2000000
MaxHops1 to 1000000
MaxIncomingNumberOfStreams0 to 1024
MaxLength1 to 4194304
MinAge0 to 365
MinHops0 to 1000000
MinLength1 to 4194304
NumberOfStreams1 to 300
OfferedCacheNameA 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
PortNumberA valid port number (1 to 65536)
SpoolNameA text string
StampIncomingIPAddressTrue (on), False (off)
SubjectFilterglob
SubscriptionA glob-style expression
TimeOutInSeconds0, 1 to (2^31)-1
WelcomeMessageAny text message
XrefAction'Generate', 'Pass', or 'Remove'
XrefMasterList of globs

Symbols

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | 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 | E | F | G | I | K | M | N | O | P | S | T | W | X

AdditionalSubscription

Simple Glob-style Expressions that get appended to the Subscription directive. Since this directive is NOT accessible via the GUI, it is particularly useful for filtering out 'premium' newsgroups. For example, setting this directive to '!clari.*' will prevent articles posted to just the 'clari' groups from being sent REGARDLESS of what the Subscription directive specifies. The 'DefaultAdditionalSubscription' directive in the cyclone.conf file is optional and provides a default value for this directive.

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.

AllowJunk

If an Active File is present, this specifies whether or not the system should send articles that do not match the Active File to this outgoing feed. The 'DefaultAllowJunk' directive in the cyclone.conf file provides a default value for this directive.

AllowStreaming

Specifies whether or not the system should attempt to use efficient NNTP streaming transfers for this outgoing feed. The 'DefaultAllowStreaming' directive in the cyclone.conf file provides a default value for this directive.

AllowTryAgain

Specifies whether or not the system should attempt to resend articles that are temporarily refused by this outgoing feed (via NNTP 431 and 436 response codes). In addition, on incoming feeds, this specifies whether or not the system will send the 431 and/or 436 response codes to remote sites. The 'DefaultAllowTryAgain' directive in the cyclone.conf file provides a default value for this directive.

AuthInfoPass

Password to use for 'AuthInfo style' NNTP authentication for this outgoing feed. Do NOT use this directive unless authentication is required. No Default value can be supplied.

AuthInfoUser

Username to use for 'AuthInfo style' NNTP authentication for this outgoing feed. Do NOT use this directive unless authentication is required. No Default value can be supplied.

See Also: AuthInfoPass.

B

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

BackupHostName

Specifies the hostname (or IP address) and Port to monitor for this outgoing feed. If a connection can not be established to this host and port, Cyclone will begin transmitting data to the host specified by the OutgoingHostName directive. Once a connection can be established, Cyclone will stop transmitting data. A connection is attempted every 'BackupTimeInterval' seconds. No Default value can be supplied. This feature is VERY useful when implementing fault-tolerant News systems. You can have secondary machines monitor your primary machines and only activate feeds if the primary machines become unreachable.

BackupPortNumber

Port to connect to on 'BackupHostName'

See Also: BackupHostName.

BackupTimeInterval

Number of seconds to wait between attempts to connect to BackupHostName.

See Also: BackupPortNumber, BackupHostName.

C

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

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.

D

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

DelayTime

Number of seconds to delay each article before transmission to a remote site. Although this value can be set as high as 86,400 (one day), it is usually MORE than adequate to use a value between 30 and 600 (30 seconds and 10 minutes). The 'DefaultDelayTime' directive in the cyclone.conf file provides a default value for this directive.

DenyMessage

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

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

DropFilteredArticles

If the DropFilteredArticles directive is set to 'True' any article that is Filtered by a filtering program (See Custom Article Filtering) will be will be dropped. Otherwise, the article will be considered 'junk' and will only be sent to feeds that have the AllowJunk directive set to 'Yes'.

See Also: AllowJunk.

DropUnapprovedArticles

If the DropUnapprovedArticles directive is set to 'True' any article posted to a moderated group (as specified in the Active File) will be dropped unless it has an Approved: header line.

E

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

Encoded

Specifies whether the articles inside the spool objects should be stored in a 'non-human-readable' form. This directive is optional and defaults to 'False'. Unless required by local authorities, Highwinds recommends you don't enable this feature.

F

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

FilterProgramBody

Send the body of the article (rather than just the headers) to the filter.

FilterProgram

Specifies a program to use as an article filter.

See Also: FilterProgramBody.

FilterProgramFastFilterKey

Turn on the shared memory filter API for this feed and use the key specified.

See Also: FilterProgramBody, FilterProgram.

FilterProgramMultiFilter

Number of filter programs to start.

See Also: FilterProgramBody, FilterProgramFastFilterKey, FilterProgram.

FilterSubscription

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

G

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | 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.

I

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

IncomingExpectedPathStamp

This directive is aimed at cutting down on FAKE 'Path:' header lines. This optional directive specifies a list of strings that could appear as the first entry in the 'Path:' header line in all articles on this feed. If an article arrives and has a 'Path:' header line that doesn't begin with an entry from this list, the system will prepend the first entry in the list suffixed by the additional phrase '.MISMATCH'. There is no default value for this directive.

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.

IncomingHostname

Specifies the hostname, IP address, or Glob-style Expression specifying a machine or (in the case of an expression) a collection of machines that is feeding this system news. No Default value can be supplied. Note that Cyclone only supports IncomingHostname (singular), not IncomingHostnames (plural) as do Highwinds Reader products.

See Also: IncomingFeedName.

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.

IncomingPathFilter

Simple Glob-style Expressions specifying the hostnames on this incoming feed that should be eliminated. If a hostname appears in an article's Path: header line that matches this expression, it will be dropped immediately. The 'DefaultIncomingPathFilter' directive in the cyclone.conf file provides a default value for this directive.

IncomingSubjectFilter

Simple Glob-style Expressions specifying the subjects on this incoming feed that should be eliminated. If an article has a subject that matches this expression, it will be dropped. The 'DefaultIncomingSubjectFilter' directive in the cyclone.conf file provides a default value for this directive. Please remember that these are case-sensitive Glob-style patterns. Spaces will not be interpreted.

K

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | 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.

M

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

MaxAge

Maximum Age (in days) of a valid article for this outgoing feed. Articles that are stamped with a 'Date:' field older than this will not be sent. This value can be set as high as 1 year (365 days). However, a value of 0 means there is no limit. The 'DefaultMaxAge' directive in the cyclone.conf file provides a default value for this directive.

MaxBytesPerSecond

Maximum speed to send news in BYTES per second for this outgoing feed. This limit is enforced by calculating an average of the transmission speed. Setting this value to 0 implies you do NOT want to impose a limit on the transmission speed. The 'DefaultMaxBytesPerSecond' directive in the cyclone.conf file provides a default value for this directive.

MaxChecks

Upper limit on the number of NNTP 'check' messages that can be sent before waiting for a response from this outgoing feed. This value can be set as high as 125. Cyclone will automatically regulate the actual number of 'check' messages sent to maximize article transfer rates. The 'DefaultMaxChecks' directive in the cyclone.conf file provides a default value for this directive.

MaxConnectionDuration

Maximum time (in seconds) to keep a connection open to the OutgoingHostName. The 'DefaultMaxConnectionDuration' directive in the cyclone.conf file provides a default value for this directive. Please remember that the GUI uses MINUTES instead of seconds.

MaxCrossPost

Maximum number of groups to which an article can belong for this outgoing feed. Articles posted to more than this number of groups will not be sent. The 'DefaultMaxCrossPost' directive in the cyclone.conf file provides a default value for this directive.

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 2,000,000 articles. Regardless of the value set by this directive, the backlog capacity of the system is bounded by the spool capacity. The 'DefaultMaxDepth' directive in the cyclone.conf file provides a default value for this directive.

MaxHops

Maximum number of hosts a valid article for this outgoing feed can pass through (as indicated by the 'Path:' header line). This value can be set as high as 1,000,000 hosts. The 'DefaultMaxHops' directive in the cyclone.conf file provides a default value for this directive.

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

Maximum length (in bytes) of a valid article for this outgoing feed. Longer articles will not be sent. This value can be set as high as 4Mb (4194304 bytes). The 'DefaultMaxLength' directive in the cyclone.conf file provides a default value for this directive.

MinAge

Minimum Age (in days) of a valid article for this outgoing feed. Articles that are stamped with a 'Date:' field younger than this will not be sent. This value can be set as high as 1 year (365 days). The 'DefaultMinAge' directive in the cyclone.conf file provides a default value for this directive.

MinHops

Minimum number of hosts a valid article for this outgoing feed can pass through (as indicated by the 'Path:' header line). This value can be set as high as 1,000,000 hosts. The 'DefaultMinHops' directive in the cyclone.conf file provides a default value for this directive.

MinLength

Specifies a minimum article length in bytes for articles in this feed.

N

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

NumberOfStreams

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

O

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

OfferedCacheName

This optional directive can be used by very well connected sites to reduce the number of articles that they offer to other very well connected sites. For each instance of this directive with a unique name, a cache is created. Incoming feeds with this directive store offered article id's into the named cache. Outgoing feeds with this directive consult the named cache before offering an article to a remote site. In this way, the system will avoid offering an article to a site that has already offered it to the local system. PLEASE refer to the example in the Cyclone Configuration Guide for more details.

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 | E | F | G | I | K | M | N | O | P | S | T | 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.

PortNumber

Port to connect to for this outgoing feed. In general, you shouldn't have to change this from the RFC defined NNTP port (119). The 'DefaultPortNumber' directive in the cyclone.conf file provides a default value for this directive.

S

Symbols | A | B | C | D | E | F | G | I | K | M | N | O | P | S | T | W | X

SpoolName

Specifies a unique name for this spool object. No two spools can have the same 'SpoolName'. No slashes or whitespace are allowed in this value.

StampIncomingIPAddress

Specifies whether or not the system should stamp the 'Path:' header line with the IP address of the host sending articles. The 'DefaultStampIncomingIPAddress' directive in the cyclone.conf file provides a default value for this directive.