Configuration

Version 9 (Adrian Georgescu, 07/31/2012 09:58 pm)

1 1 Adrian Georgescu
h1. Configuration
2 1 Adrian Georgescu
3 9 Adrian Georgescu
The server default configuration should just work. If you need to tweak some settings below is a list of all configurable parameters:
4 8 Adrian Georgescu
5 7 Adrian Georgescu
h2. General server settings
6 1 Adrian Georgescu
7 3 Adrian Georgescu
To change the default settings copy config.ini.sample  to /etc/sylkserver/config.ini
8 1 Adrian Georgescu
9 1 Adrian Georgescu
<pre>
10 2 Adrian Georgescu
; SylkServer configuration file
11 1 Adrian Georgescu
[Server]
12 1 Adrian Georgescu
13 1 Adrian Georgescu
; The following settings are the default used by the software, uncomment
14 1 Adrian Georgescu
; them only if you want to make changes
15 1 Adrian Georgescu
16 1 Adrian Georgescu
; default_application = conference
17 1 Adrian Georgescu
18 1 Adrian Georgescu
; Map user part of the Request URI to a specific application
19 1 Adrian Georgescu
; application_map = 123:conference,test:irc-conference
20 1 Adrian Georgescu
21 1 Adrian Georgescu
; trace_dir = /var/log/sylkserver
22 1 Adrian Georgescu
; trace_core = False
23 1 Adrian Georgescu
; trace_sip = False
24 1 Adrian Georgescu
; trace_msrp = False
25 1 Adrian Georgescu
; trace_notifications = False
26 1 Adrian Georgescu
27 1 Adrian Georgescu
; TLS can be used for encryption of SIP signaling and MSRP media. TLS is
28 1 Adrian Georgescu
; disabled by default.  To enable TLS, you must have a valid X.509
29 1 Adrian Georgescu
; certificate and configure it below, then set the local_tls_port in the SIP
30 1 Adrian Georgescu
; section and use_tls in MSRP section
31 1 Adrian Georgescu
32 1 Adrian Georgescu
; The X.509 Certificate Authorities file
33 1 Adrian Georgescu
; ca_file = /etc/sylkserver/tls/ca.crt
34 1 Adrian Georgescu
35 1 Adrian Georgescu
; The file containing X.509 certificate and private key in unencrypted format
36 1 Adrian Georgescu
; certificate = /etc/sylkserver/tls/default.crt
37 1 Adrian Georgescu
38 1 Adrian Georgescu
; verify_server = False
39 1 Adrian Georgescu
40 1 Adrian Georgescu
41 1 Adrian Georgescu
[SIP]
42 1 Adrian Georgescu
43 1 Adrian Georgescu
; SIP transport settings
44 1 Adrian Georgescu
; IP address used for SIP signaling; empty string or any means listen on interface used
45 1 Adrian Georgescu
; by the default route
46 1 Adrian Georgescu
; local_ip =
47 1 Adrian Georgescu
48 1 Adrian Georgescu
; Ports used for SIP transports, if not set to any value the transport will be disabled
49 1 Adrian Georgescu
; local_udp_port = 5060
50 1 Adrian Georgescu
; local_tcp_port = 5060
51 1 Adrian Georgescu
; local_tls_port = 5061
52 1 Adrian Georgescu
53 1 Adrian Georgescu
; If set all outbound SIP requests will be sent through this SIP proxy
54 1 Adrian Georgescu
; outbound_proxy =
55 1 Adrian Georgescu
56 1 Adrian Georgescu
; A comma-separated list of hosts or networks to trust.
57 1 Adrian Georgescu
; The elements can be an IP address in CIDR format, a
58 1 Adrian Georgescu
; hostname or an IP address (in the latter 2 a mask of 32
59 1 Adrian Georgescu
; is assumed), or the special keywords 'any' and 'none'
60 1 Adrian Georgescu
; (being equivalent to 0.0.0.0/0 and 0.0.0.0/32
61 1 Adrian Georgescu
; respectively). It defaults to 'any'.
62 1 Adrian Georgescu
; trusted_peers =
63 1 Adrian Georgescu
64 1 Adrian Georgescu
65 1 Adrian Georgescu
[MSRP]
66 1 Adrian Georgescu
67 1 Adrian Georgescu
; MSRP transport settings
68 1 Adrian Georgescu
69 1 Adrian Georgescu
; A valid X.509 certificate is required for MSRP to work over TLS.
70 1 Adrian Georgescu
; TLS is enabled by default, a default TLS certificate is provided with SylkServer.
71 1 Adrian Georgescu
; use_tls = True
72 1 Adrian Georgescu
73 1 Adrian Georgescu
74 1 Adrian Georgescu
[RTP]
75 1 Adrian Georgescu
76 1 Adrian Georgescu
; RTP transport settings
77 1 Adrian Georgescu
78 1 Adrian Georgescu
; Allowed codec list, valid values: G722, speex, PCMU, PCMA, iLBC, GSM
79 1 Adrian Georgescu
; audio_codecs = G722,speex,PCMU,PCMA
80 1 Adrian Georgescu
81 1 Adrian Georgescu
; Port range used for RTP
82 1 Adrian Georgescu
; port_range = 50000:50500
83 1 Adrian Georgescu
84 1 Adrian Georgescu
; SRTP valid values: disabled, mandatory, optional
85 1 Adrian Georgescu
; srtp_encryption = optional
86 1 Adrian Georgescu
87 1 Adrian Georgescu
; RTP stream timeout, session will be disconnected after this value
88 1 Adrian Georgescu
; timeout = 30
89 1 Adrian Georgescu
90 1 Adrian Georgescu
</pre>
91 1 Adrian Georgescu
92 6 Adrian Georgescu
h2. Applications settings
93 1 Adrian Georgescu
94 6 Adrian Georgescu
h3. Conference
95 6 Adrian Georgescu
96 3 Adrian Georgescu
To change the default settings copy conference.ini.sample  to /etc/sylkserver/conference.ini
97 3 Adrian Georgescu
98 3 Adrian Georgescu
99 1 Adrian Georgescu
<pre>
100 1 Adrian Georgescu
; SylkServer Conference application configuration file
101 1 Adrian Georgescu
102 1 Adrian Georgescu
[Conference]
103 1 Adrian Georgescu
104 1 Adrian Georgescu
; The following settings are the default used by the software, uncomment them
105 1 Adrian Georgescu
; only if you want to make changes
106 1 Adrian Georgescu
107 1 Adrian Georgescu
; db_uri = sqlite:///var/lib/sylkserver/conference.sqlite
108 1 Adrian Georgescu
109 1 Adrian Georgescu
; Database table name for storing messages history
110 1 Adrian Georgescu
; history_table = message_history
111 1 Adrian Georgescu
112 1 Adrian Georgescu
; Replay last chat messages after joining a room
113 1 Adrian Georgescu
; replay_history = 20
114 1 Adrian Georgescu
115 1 Adrian Georgescu
; Directory for storing files transferred to rooms (a subdirectory for each room will be created)
116 1 Adrian Georgescu
; file_transfer_dir = /var/spool/sylkserver
117 1 Adrian Georgescu
118 1 Adrian Georgescu
; File transfer push support. If enabled files will be pushed to all active
119 1 Adrian Georgescu
; participants after receiving the file
120 1 Adrian Georgescu
; push_file_transfer = False
121 1 Adrian Georgescu
122 1 Adrian Georgescu
; Directory where images use by the Screen Sharing functionality will be stored
123 1 Adrian Georgescu
; screen_sharing_dir = /var/spool/sylkserver/screensharing
124 1 Adrian Georgescu
125 1 Adrian Georgescu
; IP address used for serving Screen Sharing HTTP requests, empty string means listen on interface used
126 1 Adrian Georgescu
; by the default route
127 1 Adrian Georgescu
; screen_sharing_ip =
128 1 Adrian Georgescu
129 1 Adrian Georgescu
; Port where Screen Sharing HTTP server will listen on, set to 0 for random
130 1 Adrian Georgescu
; screen_sharing_port = 0
131 1 Adrian Georgescu
132 1 Adrian Georgescu
; Use HTTPS instead of HTTP
133 1 Adrian Georgescu
; screen_sharing_use_https = True
134 1 Adrian Georgescu
135 1 Adrian Georgescu
; Server certificate for HTTPS connections
136 1 Adrian Georgescu
; screen_sharing_certificate = /etc/sylkserver/tls/default.crt
137 1 Adrian Georgescu
138 1 Adrian Georgescu
; Advertise the conference server and each room in Bonjour
139 1 Adrian Georgescu
; use_bonjour = False
140 1 Adrian Georgescu
141 1 Adrian Georgescu
; Access Lists Default Policy
142 1 Adrian Georgescu
; Apache-style access lists for the caller using SIP domains or SIP URIs
143 1 Adrian Georgescu
; https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#order
144 1 Adrian Georgescu
;
145 1 Adrian Georgescu
; access_policy = allow, deny
146 1 Adrian Georgescu
; allow = all
147 1 Adrian Georgescu
; deny = none
148 1 Adrian Georgescu
149 1 Adrian Georgescu
; Access Lists can be applied per room overriding the Default Policy
150 1 Adrian Georgescu
;
151 1 Adrian Georgescu
; [test@domain.com]
152 1 Adrian Georgescu
; access_policy = allow, deny
153 1 Adrian Georgescu
; allow = example.com, test@domain.com
154 1 Adrian Georgescu
; deny = all
155 1 Adrian Georgescu
156 1 Adrian Georgescu
</pre>
157 1 Adrian Georgescu
158 6 Adrian Georgescu
h3. XMPP gateway
159 3 Adrian Georgescu
160 3 Adrian Georgescu
To change the default settings copy xmppgateway.ini.sample  to /etc/sylkserver/xmppgateway.ini
161 3 Adrian Georgescu
162 1 Adrian Georgescu
163 1 Adrian Georgescu
<pre>
164 1 Adrian Georgescu
; SylkServer XMPP gateway application configuration file
165 1 Adrian Georgescu
166 1 Adrian Georgescu
[general]
167 1 Adrian Georgescu
168 1 Adrian Georgescu
; Comma-separated list of domains for which this server is responsible
169 1 Adrian Georgescu
; Add the xmmp-server records into the DNS server responsable for these domains
170 1 Adrian Georgescu
; At least one domain is required!
171 1 Adrian Georgescu
; domains =
172 1 Adrian Georgescu
173 1 Adrian Georgescu
; The following settings are the default used by the software, uncomment
174 1 Adrian Georgescu
; them only if you want to make changes
175 1 Adrian Georgescu
176 1 Adrian Georgescu
; Prefix that will be appended to all domains in the above setting, which will
177 1 Adrian Georgescu
; be used as a Multi User Chat (MUC) component
178 1 Adrian Georgescu
; muc_prefix = conference
179 1 Adrian Georgescu
180 1 Adrian Georgescu
; IP address used for listening to XMPP connections; empty string or any means listen on interface used
181 1 Adrian Georgescu
; by the default route
182 1 Adrian Georgescu
; local_ip =
183 1 Adrian Georgescu
184 1 Adrian Georgescu
; local_port = 5269
185 1 Adrian Georgescu
186 1 Adrian Georgescu
; If set to True (default) MSRP will be used to translate XMPP Instant Messaging, else SIP MESSAGE will be used
187 1 Adrian Georgescu
; Note: XMPP 'normal' messages (not chat messages) are always translated to SIP MESSAGE requests
188 1 Adrian Georgescu
; use_msrp_for_chat = True
189 1 Adrian Georgescu
190 1 Adrian Georgescu
; Timeout to terminate a SIP session if no chat traffic was received
191 1 Adrian Georgescu
; sip_session_timeout = 600
192 1 Adrian Georgescu
193 1 Adrian Georgescu
; Enable verbose logging of XMPP stantzas
194 1 Adrian Georgescu
; trace_xmpp = False
195 1 Adrian Georgescu
</pre>
196 1 Adrian Georgescu
197 1 Adrian Georgescu
 
198 6 Adrian Georgescu
h3. IRC
199 5 Adrian Georgescu
200 5 Adrian Georgescu
To change the default settings copy ircconference.ini.sample  to /etc/sylkserver/ircconference.ini
201 5 Adrian Georgescu
202 5 Adrian Georgescu
<pre>
203 5 Adrian Georgescu
[123]
204 5 Adrian Georgescu
channel = test
205 5 Adrian Georgescu
server = irc.freenode.net:6667
206 5 Adrian Georgescu
</pre>