spectrum.cfg(5)                 Spectrum Manual                spectrum.cfg(5)



NAME
       spectrumc.cfg - spectrum configuration file

FULL PATH
       Depends on local setup, but usually in /etc/spectrum.

DESCRIPTION
       This man-page describes the fileformat for spectrum configuration
       files. With spectrum, each protocol configuration (e.g. for icq, msn,
       ...) runs as its own instance and hence requires its own configuration
       file.

       The fileformat is structured into four sections: service, logging,
       database and purple. The beginning is marked by the section enclosed in
       brackets, here is an example:

              [service]
              # lines starting with a '#' are considered a comment.
              enable=1
              protocol=xmpp
              ...
              [logging]

FILENAME
       The filename itself can be used to configure a few configuration
       details. This is intended to enable running all spectrum instances with
       identical configuration files that only differ in their filename. You
       can use this feature to have only one file and symlink (see ln(1)) it
       for each instance.

       The syntax of the filename is:

           jid[:protocol[:port]].cfg or
           protocol:port.cfg

       So a full filename would be xmpp.example.com:xmpp:1000.cfg or, if only
       two fields are given, xmpp:1000.cfg. You can use these settings by
       using the strings "$filename:jid" (if given), "$filename:protocol" and
       "$filename:port" (without quotes) in the configuration file.

COMMON OPTIONS
       Most options are common to all protocol configurations. Settings can
       only be omitted if there is a default value or if it is explicitly
       marked as optional.


   SECTION service
       enable=bool
              To disable the spectrum instance, set bool to 0 (default:
              enable=1).

       protocol=protocol
              Have this spectrum instance use protocol. Valid values are aim,
              facebook, gg, icq, irc, msn, msn_pecan, myspace, qq, simple,
              twitter, xmpp or yahoo.

       server=address
              Your XMPP-server is available at address, the setting can be any
              IPv4- or IPv6-address or a fully qualified domain name. Most of
              the time address will just be 127.0.0.1.

              Note: IPv6 support is currently untested.

       port=port
              Use port as the component port.

       jid=jid
              Use jid as the component JID.

       use_proxy=bool
              If bool is 1, the http_proxy env var will be used as the proxy
              server (default: 0).  Example:
                     http_proxy="http://user:passwd@your.proxy.server:port/"

       config_interface=path
              Spectrum opens a local socket at path where it replies to some
              XMPP-packets. This setting is used by the spectrumctl-action
              stats and the munin plugin. The default is
              /var/run/spectrum/$jid.sock

       filetransfer_bind_address=IP:port
              The filetransfer proxy will bind to IP:port. IP has to be a
              public IP. Example: 192.0.2.1:12345.  Only used when
              filetransfer is enabled (see transport_features and vip_features
              settings).

       filetransfer_public_address=IP:port
              The IP and port that will be sent as a stream host upon a
              filetransfer request. Example: 192.0.2.1:12345.  Only used when
              filetransfer is enabled (see transport_features and vip_features
              settings).

       filetransfer_cache==directory
              Downloaded files will be saved at directory.  Only used when
              filetransfer is enabled (see transport_features and vip_features
              settings).

       filetransfer_web=URL
              Downloaded files will be available at URL. Note that it is your
              job to configure your webserver accordingly.

       admins=user@example.com,...
              Optional. Comma-seperated list of transport administrators who
              have access to admin adhoc commands.

       name=name
              The transport will show up in Service Discovery as name.

       language=lang
              Use lang as the default language for spetrum (default: en).

       transport_features=feature;...
              List of features available on the transport, seperated by
              semicolons (';'), feature must be a combination of avatars,
              chatstates and filetransfer. By default, spectrum offers all
              three features.

       vip_mode=mode
              If mode is 1, users will be devided into two groups based on a
              database table. See also: only_for_vip, allowed_servers and
              vip_features (default: 0).

       only_for_vip=bool
              If both vip_mode and only_for_vip are set to 1, the transport
              will only be available to VIP users (default: 0).

       allowed_servers=server;...
              Optional. On a VIP only transport, accounts on any of the given
              servers are able to use the transport even if they are not VIP
              users.
              This feature is useful if you want to enable transport only for
              users from your server, but also want to give access to VIP
              users from other servers (for example from GTalk).

       vip_features=feature;...
              List of features available only for VIP users. Ignored if
              vip_mode=0. List of features is the same as in
              transport_feauters.

       pid_file=path
              Spectrum will put its PID file at path (default:
              /var/run/spectrum/$jid).


   SECTION logging
       log_file=path
              Create log-file at path.

       log_areas=purple;xml
              A combination of purple and xml.


   SECTION database
       type=type
              Either use sqlite or mysql as database backend.

       host=hostname
              Connect to hostname when using mysql.

       user=name
              Use name as username when for connecting to mysql.

       password=pwd
              Use pwd as password when for connecting to mysql.

       database=db
              When using mysql, use db as database name, when using sqlite,
              use db to set the path to the database file.

       prefix=prefix
              Optional. Use prefix as database prefix to connect to a mysql
              database.


   SECTION purple
       userdir=directory
              Store dynamic user data in directory.


XMPP specific options
   SECTION service
       require_tls=bool
              Require TLS to connect to the legacy network. Set this to 0 to
              enable connectivity to the Facebook Jabber server (default: 1).


AUTHOR
       Copyright (C) 2009-2010 by Spectrum engineers:

       o   Jan Kaluza <hanzz@soc.pidgin.im>
       o   Mathias Ertl <mati@fsinf.at>
       o   Paul Aurich <paul@darkrain42.org>

       License GPLv3+: GNU GPL version 3 or later.  This is free software: you
       are free to change and redistribute it.  There is NO WARRANTY, to the
       extent permitted by law.

       See http://gnu.org/licenses/gpl.html for more information.

SEE ALSO
       spectrum(1), spectrumctl(8)


BUGS
       Please submit bugs to our issue tracker at github:
       http://github.com/hanzz/spectrum/issues



Version 0.1-git                 March 31, 2010                 spectrum.cfg(5)
