Skip to end of metadata
Go to start of metadata

In order for Netmail Store Content Router to function correctly, each installed service has a separate configuration file. Best practice is to copy the sample config files located in the /etc/caringo/contentrouter directory with the name of each service:

 $ sudo su -
 cd /etc/caringo/contentrouter
 cp publisher.cfg.sample publisher.cfg
 cp rules.xml.sample rules.xml
 cp replicator.cfg.sample replicator.cfg

The above command will create the necessary files if they do not already exist. The copied files must be edited to properly configure the services within your network.

Publisher Configuration

A full explanation of all configuration options can be found below:

 Option Name

 Default

 Mandatory

 Description

group

255.0.10.100

yes

The multicast group address for the Netmail Store cluster from which UUIDs are gathered. Must be a Class D IP address in the range 224.0.0.0 to 239.255.255.255.

ipaddress

none

yes

The Publisher’s IP address.

log

/var/log/contentrouter-publisher.log

no

Local file name when not using a syslog.

logbackups

8

no

The number of older, rotated log files to keep when file-based logging is used.

loghost

localhost

no

Syslog host name or IP address.

loglevel

40

no

The level of logging verbosity with the following supported values: 50=critical, 40=error, 30=warning, 20=info, 10=debug, 0=no log.

logsize

10 * 1024 * 1024 bytes

no

The number of bytes allowed for all filebased log files. Each log file is allocated 1/n of the configured logsize, where 'n' is the configured number of logbackups. A value of 0 will prevent Content Router from rotating logs if an alternate mechanism like logrotate is preferred.

scsphosts

none

yes, if cluster is not specified

A comma-separated list of Netmail Store node IP addresses used to validate version compatibility at boot time. Either scsphosts or cluster must be specified.

scspport

80

no

The SCSP connection port for the Netmail Store cluster listed in the group parameter.

cluster

none

yes, it scsphosts is not specified

The name of the source Netmail Store cluster; used to dynamically locate a node and verify version compatibility. Either scsphosts or cluster must be specified.

castorProxyIP

none

no

IP address for the proxy that provides external Conent Router subscribers access to the Netmail Store cluster for replication.

castorProxyPort

none

no

Port for the proxy that provides external Content Router subscribers access to the Netmail Store cluster for replication.

rulesFile

/etc/contentrouter/rules.xml

no

The name and location of the XML rules file the Publisher uses to filter UUIDs

consolePort

8090

no

The port for the Publisher web console.

publicationServerPort

80

no

The port Publisher uses to publish UUID data.

storageDir

/var/lib/db/contentrouter/publisher

no

A unique, writable directory path for use in storing in process stream information. The specified location must contain enough space for the anticipated size of the data store. Approximate GB

required per 100 million streams = 16 + 0.07 (average metadata size per Netmail Store object, in bytes). For example, if Netmail Store objects have 200 bytes of metadata on average, the requirement will be: 16 + 14 = 30 GB.

subscriberOfflineAfter

180

no

Time in seconds before the Publisher displays a Subscriber as offline in the Publisher console. Applies only to Subscribers that do not send an errOfflineAfter parameter at runtime.

subscribeErrrOffline
After

3600

no

Time in seconds before the Publisher logs a critical error message if a Subscriber has not been heard from. Applies only to Subscribers that do not send an errOfflineAfter parameter at runtime.

subscriberTimeout
Interval

90000

no

Time in seconds before the Publister terminates a Subscriber if it has not been heard from. Applies only to Subscribers that do not send a Timeout parameter at runtime. Minimum of 9000.

maxActiveEvents

20

no

The number of events Publisher should process at one time.

snmpCommunity

ourpwdofchoicehere

no

The password used to control access to restricted capabilities in the Publisher admin console.

consoleReportStyleURL

none

no

Provides the location of an override stylesheet for overriding style types in the admin console style sheet.

consoleStyleURL

none

no

Provides the location of an override stylesheet for overriding style types in the admin console style sheet.

errorRetentionDays

4

no

The number of days the Publisher should retry failed attempts to read stream metadata before the event is dropped.

enumeratorDefaultMax
Items

5000

no

Determines the number of events that are retrieved by an enumerator from the Publisher per request. The configured parameter can be overridden by an individual enumerator using the maxItems query argument on a Start or Next request. Replicator throughput can be increased by increasing the value of this parameter.

publicationServerStrict
ArgsChecking

False

no

Determines whether Enumerator API query argument syntax is strictly enforced on requests to the Publisher. By default, invalid arguments and values are tolerated by dropping the value and sending a warning message to the log. This enables legacy applications to continue to function. If set to "True", publication server query argument checking is strictly enforced, with a 400 (error) returned on the request if an invalid argument or value is given on a request. This checking is helpful when developing new subscribers as it provides immediate feedback on error conditions.

Replicator Configuration

Option Name

Default

Mandatory

Description

ipaddress

none

yes

The Replicator’s IP address.

log

/var/log/contentrouter-replicator.log

no

Local file name when not using a syslog.

loghost

localhost

no

Syslog host name or IP address. Content Router services log to the local 5 syslog facility. The parameter should not be set if local file-based logging will be used instead of syslog.

loglevel

20

no

The level of logging verbosity with the following supported values: 50=critical, 40=error, 30=warning, 20=info, 10=debug, 0=no log.

logbackups

8

no

The number of older rotated log files to keep when file-based logging is used.

logsize

10 * 1024 * 1024 bytes

no

The number of bytes allowed for all filebased log files. Each log file is allocated 1/n of the configured logsize, where 'n' is the configured number of logbackups. A value of 0 will prevent Content Router from rotating logs if an alternate mechanism like logrotate is preferred.

group

255.0.10.100

yes

The multicast group address for the Netmail Store cluster from which UUIDs are gathered. Must be a Class D IP address in the range 224.0.0.0 to 239.255.255.255.

scsphosts

none

yes, if cluster is not specified

A comma-separated list of Netmail Store node IP addresses used to validate version compatibility at boot time. Either scsphosts or cluster must be specified.

cluster

none

yes, if scsphosts is not specified

The name of the target Netmail Store cluster; used to dynamically locate a node and verify version compatibility at boot. Either scsphosts or cluster must be specified.

castorProxyIP

none

no

IP address of a proxy configured in front of the target cluster.

castorProxyPort

none

no

Port of a proxy configured in front of the target cluster.

subscribeTo

non

yes

Specifies one or more Publishers to query for UUIDs. Syntax of <channelName>@
<host>:<port>, <channelName>
@<host>:<port>, etc. (one Name, host, port group for each Publisher the Replicator subscribes to).

subscriptionCheck
Interval

10

yes

Time in seconds between checks for new UUIDs; values can be between 5 - 3600 seconds.

offlineAfter

120

no

Time in seconds before the Publisher displays Replicator as offline in the Publisher console. Minimum of 60 seconds.

errOfflineAfter

1800

no

Time in seconds before the Publisher logs a critical error message if a Subscriber has not been heard from. Minimum of 60 seconds.

timeoutInterval

86400

no

Time in seconds before the Publisher will terminate a Subscriber if it has not been heard from. Minimum of 9000 seconds.

consolePort

8088

no

Replicator responds to requests for its state on this port. There is not currently a separate console for Replicator.

storageDir

/var/lib/db/contentrouter/replicator

yes

A unique, writable directory path for use in storing in process stream information.

maxActiveEvents

20

no

The number of events Replicator should process at one time.

ignoreDeleteEvents

0

no

Determines whether or not a Replicator should process delete events. By default, delete events are processed (ignoreDeleteEvents=0)

  • No labels