WIRED.CONF(5)               BSD File Formats Manual              WIRED.CONF(5)

NAME
     wired.conf -- wired(8) configuration file

DESCRIPTION
     wired.conf is the wired(8) configuration file. It consists of keywords
     and arguments in a `key = value' format, separated by newlines. Lines
     starting with `#' are ignored.

     Paths are interpreted as absolute if they begin with a `/', otherwise
     they are relative to the server root. Boolean values should be either
     `yes' or `no'.

     The possible keywords and their meanings are as follows:

     address
         A specific address, host name or interface name to bind to, instead
         of binding to all available addresses. Can be specified more than
         once, for each address the server should listen on.

         Example: address = 127.0.0.1, address = localhost, address = eth0

     ban time
         Number of seconds a temporary ban lasts.

         Example: ban time = 1800

     bandwidth
         Connection bandwidth in bytes/sec. Sent to trackers on registration.

         Example: bandwidth = 64000

     banlist
         Path to the banlist file. Its format is described in wired(8).

         Example: banlist = banlist

     banner
         Path to an image file that will be sent to clients as the banner. PNG
         file format is recommended. Maximum image size is 200x32 pixels.

         Example: banner = banner.png

     certificate
         Path to an OpenSSL certificate PEM file. It can be generated by the
         OpenSSL req(1) program.

         Example: certificate = etc/certificate.pem

     client downloads
         Maximum number of downloads per client.

         Example: client downloads = 1

     client uploads
         Maximum number of uploads per client.

         Example: client uploads = 1

     control cipher
         An OpenSSL cipher list to use for the control connection. Its format
         is described in the OpenSSL ciphers(1) program.

         Example: control cipher = ALL:NULL:!MD5:@STRENGTH

     description
         A short description of the server.

         Example: description = My Wired Server

     files
         Path to the files directory.

         Example: files = files

     group
         Name or id of the group that wired(8) should operate as.

         Example: group = daemon

     groups
         Path to the groups file. Its format is described in wired(8).

         Example: groups = groups

     idle time
         Number of seconds after which to mark inactive clients as idle.

         Example: idle time = 600

     ignore expression
         A regular expression of patterns to ignore in file listings. Its for-
         mat is described in re_format(7).

         Example: ignore expression = /CVS/

     index
         Path to an index file. If it is defined, wired will generate an index
         of all files.

         Example: index = files.index

     index time
         If set, indexes files after this many seconds. Without it, no auto-
         matic indexing takes place.

         Example: index time = 3600

     name
         Name of the server.

         Example: name = Wired Server

     news
         Path to a news file.

         Example: news = news

     news limit
         If set, the news file will be truncated after this many entries.

         Example: news limit = 100

     pid
         Path to a file in which to place the process id of the running
         wired(8) daemon.

         Example: pid = wired.pid

     port
         Port number to listen on.

         Example: port = 2000

     register
         If set, registers with all configured trackers.

         Example: register = yes

     search method
         Method to use for client file searches. Can be either "live" for live
         search or "index" for indexed ones. If set to search the index, make
         sure the index has been enabled.

         Example: search method = index

     show dot files
         If set, file listings will include files beginning with a `.'.

         Example: show dot files = no

     show invisible files
         If set, file listings will include files that are marked invisible by
         Mac OS. Only available on Mac OS X.

         Example: show invisible files = no

     status
         Path to a file in which to place the current status. Its file format
         is described in wired(8).

         Example: status = wired.status

     total downloads
         Maximum number of downloads across all clients.

         Example: total downloads = 10

     total download speed
         Maximum speed of downloads in bytes/sec.

         Example: total download speed = 64000

     total uploads
         Maximum number of uploads across all clients.

         Example: total uploads = 10

     total upload speed
         Maximum speed of upload in bytes/sec.

         Example: total upload speed = 64000

     tracker
         A URL of a tracker to register with. The tracker is connected to at
         startup, and then periodically informed with status updates. The path
         of the URL is the category to register as. Can be specified more than
         once, for each tracker that the server should register with.

         Example: tracker = wiredtracker://my.tracker.com/Regional/Europe

     transfer cipher
         An OpenSSL cipher list to use for the control connection. Its format
         is described in the OpenSSL ciphers(1) program.

         Example: transfer cipher = ALL:NULL:!MD5:@STRENGTH

     url
         The URL of this server to send to trackers. If this does not resolve
         back to the address the server is connecting from, the tracker may
         rewrite the URL or deny registration altogether.

         Example: wired://my.server.com/

     user
         Name or id of the user that wired(8) should operate as.

         Example: user = wired

     users
         Path to the users file. Its format is described in wired(8).

         Example: users = users

     zeroconf
         If set, enables the use of Zeroconf service publication to allow
         clients on the local network to automatically find the server.

         Example: zeroconf = yes

AUTHORS
     wired and the Wired protocol were developed by Axel Andersson, Zanka
     Software.

SEE ALSO
     wired(8), wiredctl(1)

BSD                              May 27, 2007                              BSD