| Highwinds Software Product Documentation: Typhoon, Twister, Tornado, Hurricane, and Cyclone | ||
|---|---|---|
| <<< Previous | Next >>> | |
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
| #include | Any path to a file. Relative Paths from the bin/ directory. |
| <Chain> </Chain> | N/A |
| <OverviewCache> </OverviewCache> | N/A |
| <Spool> </Spool> | N/A |
| ActiveFile | Any path to a file |
| AdditionalSubscription | Glob Pattern |
| Aliases | Hostname list delimited with commas. |
| AllowActiveControl | None (off), Full, nowildcards |
| AllowFeeding | True (on), False (off) |
| AllowFilter | True (on), False (off) |
| AllowJunk | True (on), False (off) |
| AllowNewNews | True (on), False (off) |
| AllowPosting | True (on), False (off) |
| AllowProtocols | None, HTTP, NNTP, * |
| AllowReading | True (on), False (off) |
| AllowStreaming | True (on), False (off) |
| AllowThreading | True (on), False (off) |
| AllowTryAgain | True (on), False (off) |
| ArchiveThreshold | 1 to 100 |
| AuthInfoPass | A text string |
| AuthInfoUser | A text string |
| AuthenticationFile | A valid path and filename |
| AuthenticationProgram | A valid path and filename |
| AutoAddGroups | True (on), False (off) |
| BackupHostName | A valid IP address or hostname |
| BackupPortNumber | A valid port number |
| BackupTimeInterval | 0 to (2^31)-1 |
| BandwidthLimitTrigger | 0, 1024 to (2^31)-1 |
| BandwidthTrackingWindow | 0, 10 to (2^31)-1 |
| BandwidthUnlimitTrigger | 0, 1024 to (2^31)-1 |
| CacheNumber | 1 to 255 |
| CommandLog | A valid path and filename |
| Compressed | True (on), False (off) |
| CompressionLevel | 0 to 9 |
| ControlDepth | 0 to (2^31)-1 |
| CountRefresh | 0 to 3600 |
| DelayTime | 1 to (2^32)-1 |
| DenyMessage | A text message |
| DescriptionsFile | A valid path and filename |
| Distribution | A valid glob-style expression |
| DistributionsFile | A valid path and filename |
| DropFilteredArticles | True (on), False (off) |
| DropUnapprovedArticles | True (on), False (off) |
| Encoded | True (on), False (off) |
| ErrorTemplate | A valid path and filename |
| FeedMaxBytesPerSecond | 0, 1024 to (2^31)-1 |
| FilterProgram | A path to an executable program. |
| FilterProgramBody | True (on), False (off) |
| FilterProgramFastFilterKey | An alphanumeric string. |
| FilterProgramMultiFilter | Integer 1-16 |
| FilterSubscription | A glob-style expression |
| ForceOrganization | True (on), False (off) |
| FrontPage | A valid filename |
| GroupAllowFile | A valid path and filename |
| GroupDenyFile | A valid path and filename |
| HostConnectionLimit | 0, or 1 to (2^32) -1 |
| HostNames | A valid hostname or IP address or a valid hostname or IP addressappended with a ':' and a valid port number. |
| HttpCategorization | A valid path and filename |
| HttpDirectory | Valid path and filename |
| HttpHostname | A valid list of hostnames separated by commas or spaces |
| HttpPath | A valid glob-style pattern |
| IdleTime | 0, 1 to (2^31)-1 |
| IncomingExpectedPathStamp | A text string |
| IncomingFeedName | The name of an incoming feed object |
| IncomingGroupFilter | A glob-style expression |
| IncomingHostname | A valid IP address or hostname |
| IncomingHostnames | A list of glob or CIDR style expressions separated by commas |
| IncomingInterface | A valid IP address or hostname |
| IncomingPathFilter | A valid glob-style pattern |
| IncomingSubjectFilter | A valid glob-style pattern |
| Interface | A valid IP address or hostname |
| Kilobytes | 10000 to 2000000 |
| ListRefresh | 0, 1 to 1024 |
| Locale | A valid locale |
| LocaleDirectory | A valid path |
| MailerOption | Any value that the MailerPath program requires to process a message that includes full headers and body. |
| MailerPath | A 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. |
| MaxAge | 1 to 365 |
| MaxBytesPerSecond | 0 to 4194304 |
| MaxChecks | 1 to 125 |
| MaxConnectionDuration | 0, 1 to (2^32)-1 |
| MaxConnections | 0, 1 to 1024 |
| MaxCrossPost | 1 to 1024 |
| MaxDepth | 1 to 5000 |
| MaxHops | 1 to 1000000 |
| MaxIncomingNumberOfStreams | 0 to 1024 |
| MaxLength | 1 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. |
| MessageMarkingCacheSize | 0 to the number of newsgroups on the server |
| MessageMarkingDomain | A valid HTTP cookie format |
| MimeExtensionsMap | A valid path and filename |
| MinAge | 0 to 365 |
| MinHops | 0 to 1000000 |
| MinLength | 0 to 4194304 |
| ModeratorsFile | A valid path |
| NumberOfStreams | 1 to 300 |
| OfferedCacheName | A text string. |
| Organization | A text string |
| OutgoingFeedName | A text string |
| OutgoingHostName | A valid hostname or IP address or a valid hostname or IP address appended with a ':' and a valid port number. |
| OutgoingInterface | A valid hostname or IP address |
| Path | A valid path and filename |
| PortNumber | A valid port number (1 to 65536) |
| ProcessCancels | True (on), False (off) |
| ProcessSupercedes | True (on), False (off) |
| RefuseSpamCancels | True (on), False (off) |
| RewriteDate | True (on), False (off) |
| RewritePath | True (on), False (off) |
| SecureReverseDNS | True (on), False (off) |
| SendXrefInOverviews | True (on), False (off) |
| ShowPostFilterRejection | True (on), False (off) |
| SpoolName | A text string |
| SpoolNumber | 1 to 255 |
| StampIncomingIPAddress | True (on), False (off) |
| StampXReceivedDate | True (on), False (off) |
| StoreControlMessages | True (on), False (off) |
| SubjectFilter | glob |
| SubjectPattern | A valid glob-style pattern |
| Subscription | A glob-style expression |
| TCPReceiveBuffer | Values depend on the operating system, but most have a limit of 65536 bytes. |
| TCPSendBuffer | Values depend on the operating system, but most have a limit of 65536 bytes. |
| TemplateDirectory | A valid path |
| ThreadCacheExpireNumArts | 0, 1 to (2^31)-1 |
| ThreadCacheExpireTime | 0, 1 to (2^31)-1 |
| ThreadCacheSize | 0 up to the number of newsgroups on the server (The recommended value is the number of newsgroups divided by 4.) |
| TimeOut | 0, 1 to (2^31)-1 |
| TimeOutInSeconds | 0, 1 to (2^31)-1 |
| TriggeredBandwidthTrackingWindow | 0, 60 to (2^31)-1 |
| TriggeredMaxBytesPerSecond | 0 or 1024 to (2^31)-1 |
| UpstreamDistribution | A valid glob-style expression |
| UpstreamFilterSubscription | A valid glob-style expression |
| UpstreamHostNames | A valid hostname or IP address or a valid hostname or IP address appended with a ':' and a valid port number. |
| UpstreamInterface | A valid IP address or hostname |
| UpstreamSubscription | A valid glob-style expression |
| ValidateCancels | True (on), False (off) |
| ValidateSupercedes | True (on), False (off) |
| WelcomeMessage | Any text message |
| XComplaintsTo | A valid e-mail address |
| XrefAction | 'Generate' or 'Parse' |
| XrefMaster | List of globs |
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
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.
| Products | Cyclone, Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <product>.conf and feeds.conf |
| Legal Values | Any path to a file. Relative Paths from the bin/ directory. |
| Default Value | None |
Example 17-1. #include Usage
#include ../spools.conf |
Delimiters for the beginning and end of a Chain object.
Example 17-2. <Chain> </Chain> Usage
<Chain> HostNames chaining-master.mycompany.com CountRefresh 5 Subscription * FilterSubscription !* IdleTime 0 Interface 192.168.1.2 ListRefresh 5 MaxConnections 300 </Chain> |
Delimiters for the beginning and end of a Overview Cache object.
Example 17-3. <OverviewCache> </OverviewCache> Usage
# Since the "alt.binaries.pictures" hierarchy is popular, use an overview # cache to speed the retrieval of overview lines. # <OverviewCache> CacheNumber 2 Path /news/cache/overview2 Kilobytes 2000000 Subscription alt.binaries.pictures.* FilterSubscription alt.binaries.pictures.erotica.* </OverviewCache> |
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)
| Products | Cyclone, Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <product>.conf |
| Legal Values | N/A |
| Default Value | None |
Example 17-4. <Spool> </Spool> Usage
# Spool Example 1 (Not Cyclone) <Spool> SpoolNumber 2 Kilobytes 25000000 Path /usr/local/news/spool2 Subscription *bina*, *mp3*, *vcd*, *sex*, *multimedia* FilterSubscription !*,*jobs*, *.ads.*, *.forsale.*, *.for-sale.*,*.test* </Spool> # Spool Example 2 (Not Cyclone) <Spool> SpoolNumber 200 Kilobytes 15000 Path /usr/local/news/spool5/control-spool StoreControlMessages True SubjectPattern cmsg* </Spool> # Spool Example 3 (Cyclone) <Spool> SpoolName mainSpool Kilobytes 15000 Path /usr/local/news/spool/mainSpool # Subcription/FilterSubcription supported in Cyclone builds after # Sept '04 Subscription * </Spool> |
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
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.
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <product>.conf |
| Legal Values | Any path to a file |
| Default Value | ../etc/active |
Example 17-5. ActiveFile Usage
ActiveFile ../etc/active |
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.
Example 17-6. AdditionalSubscription Usage
AdditionalSubscription !clari.* |
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.
| Products | Cyclone, Typhoon, Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | Hostname list delimited with commas. |
| Default Value | None |
Example 17-7. Aliases Usage
Aliases hostname, *.company.com |
Enables users to add, change, or remove newsgroups through the Web interface. The nowildcards option enables full control but disallows wildcards.
| Products | Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | None (off), Full, nowildcards |
| Default Value | None |
Example 17-8. AllowActiveControl Usage
AllowActiveControl Full |
Permits clients matching the IncomingHostnames field on this feed to use IHAVE, CHECK and other NNTP Feeding commands.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | True (on), False (off) |
| Default Value | None |
Example 17-9. AllowFeeding Usage
AllowFeeding True |
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.
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | True (on), False (off) |
| Default Value | None |
Example 17-10. AllowFilter Usage
AllowFilter True |
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.
Example 17-11. AllowJunk Usage
AllowJunk No |
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.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | True (on), False (off) |
| Default Value | None |
Example 17-12. AllowNewNews Usage
AllowNewNews False |
Permits clients matching the IncomingHostnames directive on this feed to post articles on the news server. Posts are done with NNTP POST command.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | True (on), False (off) |
| Default Value | None |
Example 17-13. AllowPosting Usage
AllowPosting True |
Enables the feed/virtual server object to support the specified protocol.
Example 17-14. AllowProtocols Usage
AllowProtocols NNTP, HTTP |
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.).
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | True (on), False (off) |
| Default Value | None |
Example 17-15. AllowReading Usage
AllowReading True |
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.
Example 17-16. AllowStreaming Usage
AllowStreaming True |
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".
Example 17-17. AllowThreading Usage
AllowThreading True |
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.
Example 17-18. AllowTryAgain Usage
AllowTryAgain True |
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.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <product>.conf |
| Legal Values | 1 to 100 |
| Default Value | None |
Example 17-19. ArchiveThreshold Usage
ArchiveThreshold 90 |
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.
Example 17-20. AuthInfoPass Usage
AuthInfoPass password |
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.
Example 17-21. AuthInfoUser Usage
AuthInfoUser username |
See Also: AuthInfoPass.
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.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | A valid path and filename |
| Default Value | None |
Example 17-22. AuthenticationFile Usage
AuthenticationFile ../etc/authentication |
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.
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | A valid path and filename |
| Default Value | None |
Example 17-23. AuthenticationProgram Usage
AuthenticationProgram ../etc/sample_auth.pl |
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.
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <product>.conf |
| Legal Values | True (on), False (off) |
| Default Value | True |
Example 17-24. AutoAddGroups Usage
AutoAddGroups False |
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
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.
Example 17-25. BackupHostName Usage
BackupHostName main-feeder.company.com |
Port to connect to on 'BackupHostName'
Example 17-26. BackupPortNumber Usage
BackupPortNumber 119 |
See Also: BackupHostName.
Number of seconds to wait between attempts to connect to BackupHostName.
Example 17-27. BackupTimeInterval Usage
BackupTimeInterval 600 |
See Also: BackupPortNumber, BackupHostName.
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.
| Products | Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | 0, 1024 to (2^31)-1 |
| Default Value | None |
Example 17-28. BandwidthLimitTrigger Usage
BandwidthLimitTrigger 16384 |
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.
| Products | Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | 0, 10 to (2^31)-1 |
| Default Value | None |
Example 17-29. BandwidthTrackingWindow Usage
BandwidthTrackingWindow 300 |
See Also: BandwidthLimitTrigger.
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.
| Products | Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | 0, 1024 to (2^31)-1 |
| Default Value | None |
Example 17-30. BandwidthUnlimitTrigger Usage
BandwidthUnlimitTrigger 7168 |
See Also: BandwidthLimitTrigger, BandwidthTrackingWindow.
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
Specifies a unique number for each overview cache object. Note: This directive is required for all overview cache objects.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <OverviewCache> |
| Legal Values | 1 to 255 |
| Default Value | None |
Example 17-31. CacheNumber Usage
CacheNumber 5 |
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.
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | A valid path and filename |
| Default Value | None |
Example 17-32. CommandLog Usage
CommandLog ../log/command.log |
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.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <Spool> |
| Legal Values | True (on), False (off) |
| Default Value | False |
Example 17-33. Compressed Usage
Compressed False |
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.
Example 17-34. CompressionLevel Usage
CompressionLevel 1 |
See Also: Compressed.
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.
| Products | Cyclone, Typhoon, Twister, Tornado Back End |
| Container | <product>.conf |
| Legal Values | 0 to (2^31)-1 |
| Default Value | 0 |
Example 17-35. ControlDepth Usage
ControlDepth 400 |
Specifies the how often (in minutes) to refresh article counts for individual groups on the master server.
| Products | Typhoon, Twister, Tornado Back End |
| Container | <Chain> </Chain> |
| Legal Values | 0 to 3600 |
| Default Value | None |
Example 17-36. CountRefresh Usage
CountRefresh 15 |
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
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.
Example 17-37. DelayTime Usage
DelayTime 0 |
Specifies the message returned by the server when it denies a connection because no feed objects match any IncomingHostnames directive.
| Products | Cyclone, Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <product>.conf |
| Legal Values | A text message |
| Default Value | Permission Denied - Powered by Highwinds -- http://www.highwinds-software.com/ |
Example 17-38. DenyMessage Usage
DenyMessage Permission Denied -- Contact support@company.com for more information. |
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.
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <product>.conf |
| Legal Values | A valid path and filename |
| Default Value | ../etc/descriptions |
Example 17-39. DescriptionsFile Usage
DescriptionsFile ../etc/description |
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'.
| Products | Cyclone, Typhoon, Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | A valid glob-style expression |
| Default Value | None |
Example 17-40. Distribution Usage
Distribution !internal*, world,usa |
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.
| Products | Typhoon, Twister, Tornado Back End, Tornado Front End |
| Container | <product>.conf |
| Legal Values | A valid path and filename |
| Default Value | ../etc/distributions |
Example 17-41. DistributionsFile Usage
DistributionsFile ../etc/distributions |
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'.
Example 17-42. DropFilteredArticles Usage
DropFilteredArticles True |
See Also: AllowJunk.
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.
Example 17-43. DropUnapprovedArticles Usage
DropUnapprovedArticles True |
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
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.
Example 17-44. Encoded Usage
Encoded True |
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.
| Products | Twister, Tornado Back End |
| Container | <Feed> |
| Legal Values | A valid path and filename |
| Default Value | None |
Example 17-45. ErrorTemplate Usage
ErrorTemplate ErrorMessages.tpt |
Symbols | A | B | C | D | E | F | G | H | I | K | L | M | N | O | P | R | S | T | U | V | W | X
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.
| Products | Twister, Tornado Back End, Tornado Front End |
| Container | <Feed> |
| Legal Values | 0, 1024 to (2^31)-1 |
| Default Value | None |
Example 17-46. FeedMaxBytesPerSecond Usage
FeedMaxBytesPerSecond 48000 |
Send the body of the article (rather than just the headers) to the filter.