ClientConfiguration

From SeventeenOrBust

Old versions of the SeventeenOrBust client used varying methods of storing configuration information. The Windows clients used the Windows registry, but this turned out to be a bad idea. Using the registry makes it hard to use the client in some environments. Linux clients used a text file, but it wasn't very flexible. Neither version was as configurable as it could have been.

VersionThree of the client tries to improve on this. It too uses a file for configuration. Originally, an XML configuration file was considered, but this idea was rejected because it makes the configuration code more complicated than it needs to be. So the Java "property file" format was chosen instead.

See also Configuration files

A ClientConfiguration file might look like this:

my.username = anonymous
my.password = encrypted
my.password.md5 = AJHGVD62534JHGFEHJGF2345 | md5 hash for password

server.enabled = yes | no
server.host    = sb.seventeenorbust.com | sbp.pns.net
server.port    = 1700 | #

server.proxy.enabled  = yes | no (if 'no' other server.proxy. skipped)
server.proxy.type     = socks5
server.proxy.host     = proxy.mydomain.com
server.proxy.port     = 1080
server.proxy.username = proxyuser
server.proxy.password = secret

server.reportfrequency = 60 | #
server.retryinterval = 5 | #
server.prefetch = 2 | #

process.priority = 1 | # | idle | high | highest

log.files.enabled   = yes | no (if 'no' other log.files. skipped)
log.files.location  = ./log
log.files.threshold = debug
log.files.compress  = yes | no
log.files.sizelimit = 10485760 | #
log.files.agelimit  = 30 | #

cache.enabled  = yes | no
cache.location = ./cache

# Nuber of workunits to cache
cache.size = 3 | #

plugins.location = ./plugins

tray.icon = hidden | visible

run.as.service = true / for NT only

---

# - any number