### Packer configuration file  -*- sh -*-
##
## The canonical pathname for this file is ${prefix}/etc/rwflowpack.conf
##
## RCSIDENT("$SiLK: rwflowpack.conf.in 13332 2009-01-09 18:35:26Z mthomas $")

# Set to non-empty value to enable rwflowpack
ENABLED=

# These are convenience variables for setting other values in this
# configuration file; their use is not required.
prefix=/usr/local
exec_prefix=${prefix}
statedirectory=${prefix}/var/lib/rwflowpack

# If CREATE_DIRECTORIES is set to "yes", the directories named in this
# file will be created automatically if they do not already exist
CREATE_DIRECTORIES=no

# Full path of the directory containing the "rwflowpack" program
PACKER_BIN=${exec_prefix}/sbin

# The full path to the sensor configuration file.
SENSOR_CONFIG=

# The full path to the root of the tree under which the packed SiLK
# Flow files will be written.
DATA_ROOTDIR=/data

# Location of site configuration file
SITE_CONFIG=

# Specify the path to the packing-logic plug-in that rwflowpack should
# load and use.  The plug-in provides functions that determine into
# which class and type each flow record will be categorized and the
# format of the files that rwflowpack will write.  When SiLK has been
# configured with hard-coded packing logic (i.e., when
# --enable-packing-logic was specified to the configure script), this
# value should be empty.  A default value for this switch may be
# specified in the ${SITE_CONFIG} site configuration file.
PACKING_LOGIC=

# The type of compression to use for packed files.  Left empty, the
# value chosen at compilation time will be used.  Valid values are
# "best" and "none".  Other values are system-specific (the available
# values are listed in the description of the --compression-method
# switch in the output of rwflowpack --help).
COMPRESSION_TYPE=

# Whether rwflowpack should use advisory write locks.  1=yes, 0=no.
# Set to zero if messages like "Cannot get a write lock on file"
# appear in rwflowpack's log file.
FILE_LOCKING=1

# Data input mode.  Valid values are "stream" to read from the
# network, "fcfiles" to process flowcap files, and "flowcap" to
# connect directly to a flowcap server.
INPUT_MODE=stream

# Directory in which to look for incoming flowcap files in "fcfiles"
# mode
INCOMING_DIR=${statedirectory}/incoming

# If collecting directly from a flowcap collector in "flowcap" mode,
# set this to the address of the flowcap box.
FLOWCAP_ADDR=

# port on which to connect to a flowcap collector in "flowcap" mode
FLOWCAP_PORT=

# Temporary directory used when collecting from a flowcap collector in
# "flowcap" mode
FLOWCAP_WORK_DIR=${statedirectory}/work

# Where flowcap files in "flowcap" mode are stored until they can be
# processed
FLOWCAP_VALID_DIR=${statedirectory}/valid


# Directory to move input files to after successful processing.  When
# in "flowcap" or "fcfiles" mode, these are the flowcap files.  When
# in "stream" mode, these are the files passed to any probe with a
# poll-directory directive.  If not set, the input files are not
# archived.
ARCHIVE_DIR=${statedirectory}/archive

# Directory to move an input file into if there is a problem opening
# the file.  If this value is not set, rwflowpack will exit when it
# encounters a problem file.  When in "flowcap" or "fcfiles" mode,
# these are the flowcap files.  When in "stream" mode, these are the
# files passed to any probe with a poll-directory directive.
ERROR_DIR=  #${statedirectory}/error

# Interval between attempts to check the INCOMING_DIR or
# poll-directory probe entries for new files, in seconds.  This may be
# left blank, and will default to 15.
POLLING_INTERVAL=

# Data output mode.  Valid values are "local" and "remote"
OUTPUT_MODE=local

# Directory rwsender is polling for new incremental files.
# Used only when OUTPUT_MODE is "remote".
SENDER_DIR=${statedirectory}/sender-incoming

# Temporary directory in which to build incremental files prior to
# handing them of to rwsender.  Used only when OUTPUT_MODE is
# "remote".
INCREMENTAL_DIR=${statedirectory}/incremental

###

# The type of logging to use.  Valid values are "legacy" and "syslog".
LOG_TYPE=syslog

# The lowest level of logging to actually log.  Valid values are:
# emerg, alert, crit, err, warning, notice, info, debug
LOG_LEVEL=info

# The full path of the directory where the log files will be written
# when LOG_TYPE is "legacy".
LOG_DIR=${statedirectory}/log

# The full path of the directory where the PID file will be written
PID_DIR=${LOG_DIR}

# The user this program runs as; root permission is required only when
# rwflowpack listens on a privileged port.
USER=root

# Extra options to pass to rwflowpack
EXTRA_OPTIONS=
