# Sugarplum configuration
#
# The format is name:<optional whitespace>value (perl pattern \w+:\s*(\S.*)),
# and is subject to machine-translatable change in future revisions.  Blank
# lines and lines beginning with # (leading whitespace permitted) are ignored.
#
# Values presented here are the defaults.

# log level (0 for no logging besides the webserver's own)
#
# loglevel: 0

# log file (if loglevel set true)
#
# (don't forget to make the file writable by your web-server, see
#  /usr/share/doc/sugarplum/README.Debian for more info)
#
# logfile: /var/log/sugarplum.log


# Should sugarplum work deterministically?  If set true, a given URL
# will always seed perl's RNG with a consistent value (sum of the ordinal
# values of the bytes in the PATH_INFO variable) -- consequently the same
# random values will be picked, so multiple reloads of any given URL in
# sugarplum will produce identical output.  Hence if a harvester were to
# check for poison by comparing data on subsequent loads, they won't be
# tipped off.
#
# deterministic: 1

# If set, the system hostname will be included in the seed in
# deterministic mode.  This introduces variance into different
# sugarplum installations with identical paths (e.g. /sugarplum/),
# thus preventing an attacker from doing hash-based poison
# avoidance.  This is desirable in all cases other than when
# using sugarplum on sites run on clustered servers, where the
# hostname may not be consistent across multiple loads of the
# same URI.
# deterministic_by_hostname: 1

# If set, the HTTP server name will be rolled into the seed
# in deterministic mode.  This yields differing sugarplum
# output across different virtualhosts, or indeed across
# different servers.  A possible drawback is that it may be
# possible for an attacker to detect the poison programmatically
# on sites using wildcard-matched vhosts.
# deterministic_by_httphost: 1

# path to the dictionary
#
# dictfile: /usr/share/dict/words

# Path to a list of predefined addresses to be included in output.
# Not needed if use_spammerlist is set false.
#
# spammerfile: /etc/sugarplum/spammers


## Address balances

# If true, randomly generated email addresses will be
# included in the output.  See poison_address_frequency.
#
# use_poison_addresses: 0

# If true, generated addresses will be used based on those
# inside your teergrube -- see address_teergrube_frequency.
#
# (note: i've set this to 0 because we don't want to give out invalid
# teergrube addresses, that's a dead giveaway)
use_teergrube_addresses: 0

# If true, entries from 'spammerfile' will be be included as addresses.  See
# poison_spammer_frequency.
#
# use_spammerlist: 0


## HTML output characteristics

# How many paragraphs of poisoned output?
#
# poison_paragraphs: 4

# Should the background be randomized?  (arguably improves
# page plausibility, but often looks wonky to humans)
#
# poison_random_background: 1

# How deep should the URLs recurse (remember, this is
# an exponential factor)
#
# poison_maxdepth: 4

# Minimum number of words per paragraph?
#
# poison_paragraph_wordcount_base: 50

# Random range of words beyond the base?
#
# poison_paragraph_wordcount_range: 75

# Column before which lines in output should have newlines
# appended; simulates editor linewrap.  Set very high to
# disable linewrap.
#
# poison_paragraph_linewrap_col: 78

# What percentage of email addresses should be derived from a
# dictionary word? (range 0 to 1 inclusive)
#
# poison_word_username_frequency: 0.6

# and of those, what percentage should have numbers attached to the
# end (as with AOL and similar providers)?  (0-1 inclusive)
#
# poison_wordnumber_username_frequency: 0.3

# ...and if so, up to how many digits?
#
# poison_wordnumber_username_maxdigits: 4

# The below should add up to 1 in any combination.
# poison_spammer_frequency has been renamed -- poison_address_frequency
# now specifies the frequency of all addresses, while
# address_spammer_frequency (below) denotes the portion of addresses
# taken from known spammers.

# Percentage of words which should be poisoned addresses (see below)
#
# poison_address_frequency: 0.02

# Percentage of words which should be normal words
#
# poison_dictword_frequency: 0.98


# Settings regulating what proportions of address types will be
# emitted -- should add up to 1.  Any zero value disables the feature.

# Percentage of addresses emitted which should be taken from
# the list of known spammers (0 to disable)
#
# address_spammer_frequency: 0.2

# Percentage of addresses emitted which should be generated in
# the teergrube (randomuser@teergrube.domain.tld):
#
# address_teergrube_frequency: 0.4

# Percentage of addresses emitted which should simply be totally
# random (0 to disable):
#
# address_random_frequency: 0.4


## Teergrube configuration

# A fully-qualified hostname to be used in teergrube addresses.  This
# should be the address of your teergrube host if you have one, or a suitable
# invalid address if not.
#
# teergrube_address_fqdn: thick-sticky-stuff.invalid.tld

