1spectrum.cfg(5) Spectrum Manual spectrum.cfg(5)
2
6 spectrumc.cfg - spectrum configuration file
7
9 Depends on local setup, but usually in /etc/spectrum.
10
12 This man-page describes the fileformat for spectrum configuration
13 files. With spectrum, each protocol configuration (e.g. for icq, msn,
14 ...) runs as its own instance and hence requires its own configuration
15 file.
16 The fileformat is structured into four sections: service, logging,
18 database and purple. The beginning is marked by the section enclosed in
19 brackets, here is an example:
20 [service]
22 # lines starting with a '#' are considered a comment.
23 enable=1
24 protocol=xmpp
25 ...
26 [logging]
27
29 The filename itself can be used to configure a few configuration
30 details. This is intended to enable running all spectrum instances with
31 identical configuration files that only differ in their filename. You
32 can use this feature to have only one file and symlink (see ln(1)) it
33 for each instance.
34 The syntax of the filename is:
36 jid[:protocol[:port]].cfg or
38 protocol:port.cfg
39 So a full filename would be xmpp.example.com:xmpp:1000.cfg or, if only
41 two fields are given, xmpp:1000.cfg. You can use these settings by
42 using the strings "$filename:jid" (if given), "$filename:protocol" and
43 "$filename:port" (without quotes) in the configuration file.
44
46 Most options are common to all protocol configurations. Settings can
47 only be omitted if there is a default value or if it is explicitly
48 marked as optional.
49 SECTION service
52 enable=bool
53 To disable the spectrum instance, set bool to 0 (default:
54 enable=1).
55 protocol=protocol
57 Have this spectrum instance use protocol. Valid values are aim,
58 facebook, gg, icq, irc, msn, msn_pecan, myspace, qq, simple,
59 twitter, xmpp or yahoo.
60 server=address
62 Your XMPP-server is available at address, the setting can be any
63 IPv4- or IPv6-address or a fully qualified domain name. Most of
64 the time address will just be 127.0.0.1.
65 Note: IPv6 support is currently untested.
67 port=port
69 Use port as the component port.
70 jid=jid
72 Use jid as the component JID.
73 use_proxy=bool
75 If bool is 1, the http_proxy env var will be used as the proxy
76 server (default: 0). Example:
77 http_proxy="http://user:passwd@your.proxy.server:port/"
78 config_interface=path
80 Spectrum opens a local socket at path where it replies to some
81 XMPP-packets. This setting is used by the spectrumctl-action
82 stats and the munin plugin. The default is /var/run/spec‐
83 trum/$jid.sock
84 filetransfer_bind_address=IP:port
86 The filetransfer proxy will bind to IP:port. IP has to be a pub‐
87 lic IP. Example: 192.0.2.1:12345. Only used when filetransfer
88 is enabled (see transport_features and vip_features settings).
89 filetransfer_public_address=IP:port
91 The IP and port that will be sent as a stream host upon a file‐
92 transfer request. Example: 192.0.2.1:12345. Only used when
93 filetransfer is enabled (see transport_features and vip_features
94 settings).
95 filetransfer_cache==directory
97 Downloaded files will be saved at directory. Only used when
98 filetransfer is enabled (see transport_features and vip_features
99 settings).
100 filetransfer_web=URL
102 Downloaded files will be available at URL. Note that it is your
103 job to configure your webserver accordingly.
104 admins=user@example.com,...
106 Optional. Comma-seperated list of transport administrators who
107 have access to admin adhoc commands.
108 name=name
110 The transport will show up in Service Discovery as name.
111 language=lang
113 Use lang as the default language for spetrum (default: en).
114 transport_features=feature;...
116 List of features available on the transport, seperated by semi‐
117 colons (';'), feature must be a combination of avatars, chat‐
118 states and filetransfer. By default, spectrum offers all three
119 features.
120 vip_mode=mode
122 If mode is 1, users will be devided into two groups based on a
123 database table. See also: only_for_vip, allowed_servers and
124 vip_features (default: 0).
125 only_for_vip=bool
127 If both vip_mode and only_for_vip are set to 1, the transport
128 will only be available to VIP users (default: 0).
129 allowed_servers=server;...
131 Optional. On a VIP only transport, accounts on any of the given
132 servers are able to use the transport even if they are not VIP
133 users.
134 This feature is useful if you want to enable transport only for
135 users from your server, but also want to give access to VIP
136 users from other servers (for example from GTalk).
137 vip_features=feature;...
139 List of features available only for VIP users. Ignored if
140 vip_mode=0. List of features is the same as in trans‐
141 port_feauters.
142 pid_file=path
144 Spectrum will put its PID file at path (default: /var/run/spec‐
145 trum/$jid).
146 SECTION logging
149 log_file=path
150 Create log-file at path.
151 log_areas=purple;xml
153 A combination of purple and xml.
154 SECTION database
157 type=type
158 Either use sqlite or mysql as database backend.
159 host=hostname
161 Connect to hostname when using mysql.
162 user=name
164 Use name as username when for connecting to mysql.
165 password=pwd
167 Use pwd as password when for connecting to mysql.
168 database=db
170 When using mysql, use db as database name, when using sqlite,
171 use db to set the path to the database file.
172 prefix=prefix
174 Optional. Use prefix as database prefix to connect to a mysql
175 database.
176 SECTION purple
179 userdir=directory
180 Store dynamic user data in directory.
181
184 SECTION service
185 require_tls=bool
186 Require TLS to connect to the legacy network. Set this to 0 to
187 enable connectivity to the Facebook Jabber server (default: 1).
188
191 Copyright © 2009-2010 by Spectrum engineers:
192 · Jan Kaluza <hanzz@soc.pidgin.im>
194 · Mathias Ertl <mati@fsinf.at>
195 · Paul Aurich <paul@darkrain42.org>
196 License GPLv3+: GNU GPL version 3 or later. This is free software: you
198 are free to change and redistribute it. There is NO WARRANTY, to the
199 extent permitted by law.
200 See http://gnu.org/licenses/gpl.html for more information.
202
204 spectrum(1), spectrumctl(8)
205
208 Please submit bugs to our issue tracker at github:
209 http://github.com/hanzz/spectrum/issues
210Version 0.1-git March 31, 2010 spectrum.cfg(5)