Configuration

Version 11 (Adrian Georgescu, 01/28/2013 04:51 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 10 Adrian Georgescu
12 1 Adrian Georgescu
[Server]
13 1 Adrian Georgescu
14 1 Adrian Georgescu
; The following settings are the default used by the software, uncomment
15 1 Adrian Georgescu
; them only if you want to make changes
16 1 Adrian Georgescu
17 1 Adrian Georgescu
; default_application = conference
18 1 Adrian Georgescu
19 10 Adrian Georgescu
; Statically map a Request URI to a specific application. In the example
20 10 Adrian Georgescu
; below, 123 is matched 1st against the domain part, than the username part
21 10 Adrian Georgescu
; of the Request URI This static mapping can be overwritten by adding
22 10 Adrian Georgescu
; X-Sylk-App header set to the value of a valid SylkServer application name
23 10 Adrian Georgescu
; application_map = echo:echo,123:conference,test:ircconference,gmail.com:xmppgateway
24 1 Adrian Georgescu
25 10 Adrian Georgescu
; Disable the specified applications
26 10 Adrian Georgescu
; disabled_applications =
27 10 Adrian Georgescu
28 1 Adrian Georgescu
; trace_dir = /var/log/sylkserver
29 1 Adrian Georgescu
; trace_core = False
30 1 Adrian Georgescu
; trace_sip = False
31 1 Adrian Georgescu
; trace_msrp = False
32 1 Adrian Georgescu
; trace_notifications = False
33 1 Adrian Georgescu
34 1 Adrian Georgescu
; TLS can be used for encryption of SIP signaling and MSRP media. TLS is
35 1 Adrian Georgescu
; disabled by default.  To enable TLS, you must have a valid X.509
36 1 Adrian Georgescu
; certificate and configure it below, then set the local_tls_port in the SIP
37 1 Adrian Georgescu
; section and use_tls in MSRP section
38 1 Adrian Georgescu
39 1 Adrian Georgescu
; The X.509 Certificate Authorities file
40 1 Adrian Georgescu
; ca_file = /etc/sylkserver/tls/ca.crt
41 1 Adrian Georgescu
42 1 Adrian Georgescu
; The file containing X.509 certificate and private key in unencrypted format
43 1 Adrian Georgescu
; certificate = /etc/sylkserver/tls/default.crt
44 1 Adrian Georgescu
45 1 Adrian Georgescu
; verify_server = False
46 1 Adrian Georgescu
47 10 Adrian Georgescu
; Enable Bonjour capabilities for applications
48 10 Adrian Georgescu
; enable_bonjour = False
49 1 Adrian Georgescu
50 1 Adrian Georgescu
[SIP]
51 1 Adrian Georgescu
52 1 Adrian Georgescu
; SIP transport settings
53 1 Adrian Georgescu
; IP address used for SIP signaling; empty string or any means listen on interface used
54 1 Adrian Georgescu
; by the default route
55 1 Adrian Georgescu
; local_ip =
56 1 Adrian Georgescu
57 1 Adrian Georgescu
; Ports used for SIP transports, if not set to any value the transport will be disabled
58 1 Adrian Georgescu
; local_udp_port = 5060
59 1 Adrian Georgescu
; local_tcp_port = 5060
60 1 Adrian Georgescu
; local_tls_port = 5061
61 1 Adrian Georgescu
62 10 Adrian Georgescu
; If set, all outbound SIP requests will be sent through this SIP proxy
63 10 Adrian Georgescu
; The proxy address format is: proxy.example.com:5061;transport=tls
64 10 Adrian Georgescu
; Transport can be udp, tcp or tls, if skipped it is considered udp
65 10 Adrian Georgescu
; If only the hostname is set, RFC3263 lookups are performed to lookup 
66 10 Adrian Georgescu
; the outbound proxy server address
67 1 Adrian Georgescu
; outbound_proxy =
68 1 Adrian Georgescu
69 1 Adrian Georgescu
; A comma-separated list of hosts or networks to trust.
70 1 Adrian Georgescu
; The elements can be an IP address in CIDR format, a
71 1 Adrian Georgescu
; hostname or an IP address (in the latter 2 a mask of 32
72 1 Adrian Georgescu
; is assumed), or the special keywords 'any' and 'none'
73 1 Adrian Georgescu
; (being equivalent to 0.0.0.0/0 and 0.0.0.0/32
74 1 Adrian Georgescu
; respectively). It defaults to 'any'.
75 1 Adrian Georgescu
; trusted_peers =
76 1 Adrian Georgescu
77 1 Adrian Georgescu
78 1 Adrian Georgescu
[MSRP]
79 1 Adrian Georgescu
80 1 Adrian Georgescu
; MSRP transport settings
81 1 Adrian Georgescu
82 1 Adrian Georgescu
; A valid X.509 certificate is required for MSRP to work over TLS.
83 1 Adrian Georgescu
; TLS is enabled by default, a default TLS certificate is provided with SylkServer.
84 1 Adrian Georgescu
; use_tls = True
85 1 Adrian Georgescu
86 1 Adrian Georgescu
87 1 Adrian Georgescu
[RTP]
88 1 Adrian Georgescu
89 1 Adrian Georgescu
; RTP transport settings
90 1 Adrian Georgescu
91 1 Adrian Georgescu
; Allowed codec list, valid values: G722, speex, PCMU, PCMA, iLBC, GSM
92 1 Adrian Georgescu
; audio_codecs = G722,speex,PCMU,PCMA
93 1 Adrian Georgescu
94 1 Adrian Georgescu
; Port range used for RTP
95 1 Adrian Georgescu
; port_range = 50000:50500
96 1 Adrian Georgescu
97 1 Adrian Georgescu
; SRTP valid values: disabled, mandatory, optional
98 1 Adrian Georgescu
; srtp_encryption = optional
99 1 Adrian Georgescu
100 1 Adrian Georgescu
; RTP stream timeout, session will be disconnected after this value
101 1 Adrian Georgescu
; timeout = 30
102 1 Adrian Georgescu
103 1 Adrian Georgescu
104 1 Adrian Georgescu
</pre>
105 1 Adrian Georgescu
106 6 Adrian Georgescu
h3. XMPP gateway
107 3 Adrian Georgescu
108 3 Adrian Georgescu
To change the default settings copy xmppgateway.ini.sample  to /etc/sylkserver/xmppgateway.ini
109 3 Adrian Georgescu
110 1 Adrian Georgescu
111 1 Adrian Georgescu
<pre>
112 1 Adrian Georgescu
; SylkServer XMPP gateway application configuration file
113 1 Adrian Georgescu
114 1 Adrian Georgescu
[general]
115 1 Adrian Georgescu
116 1 Adrian Georgescu
; Comma-separated list of domains for which this server is responsible
117 11 Adrian Georgescu
; Add the xmpp-server records into the DNS server responsable for these domains,
118 11 Adrian Georgescu
; e.g.: _xmpp-server._tcp.example.com. IN SRV	0 0 5269 sylkserver.example.com.
119 1 Adrian Georgescu
; At least one domain is required!
120 1 Adrian Georgescu
; domains =
121 1 Adrian Georgescu
122 1 Adrian Georgescu
; The following settings are the default used by the software, uncomment
123 1 Adrian Georgescu
; them only if you want to make changes
124 1 Adrian Georgescu
125 1 Adrian Georgescu
; Prefix that will be appended to all domains in the above setting, which will
126 1 Adrian Georgescu
; be used as a Multi User Chat (MUC) component
127 11 Adrian Georgescu
; Add the xmpp-server records into the DNS server for the conference domains,
128 11 Adrian Georgescu
; e.g.: _xmpp-server._tcp.conference.example.com. IN SRV 0 0 5269 sylkserver.example.com.
129 1 Adrian Georgescu
; muc_prefix = conference
130 1 Adrian Georgescu
131 1 Adrian Georgescu
; IP address used for listening to XMPP connections; empty string or any means listen on interface used
132 1 Adrian Georgescu
; by the default route
133 1 Adrian Georgescu
; local_ip =
134 1 Adrian Georgescu
135 1 Adrian Georgescu
; local_port = 5269
136 1 Adrian Georgescu
137 1 Adrian Georgescu
; If set to True (default) MSRP will be used to translate XMPP Instant Messaging, else SIP MESSAGE will be used
138 1 Adrian Georgescu
; Note: XMPP 'normal' messages (not chat messages) are always translated to SIP MESSAGE requests
139 1 Adrian Georgescu
; use_msrp_for_chat = True
140 1 Adrian Georgescu
141 1 Adrian Georgescu
; Timeout to terminate a SIP session if no chat traffic was received
142 1 Adrian Georgescu
; sip_session_timeout = 600
143 1 Adrian Georgescu
144 1 Adrian Georgescu
; Enable verbose logging of XMPP stantzas
145 1 Adrian Georgescu
; trace_xmpp = False
146 1 Adrian Georgescu
</pre>
147 1 Adrian Georgescu
148 1 Adrian Georgescu
 
149 6 Adrian Georgescu
h3. IRC
150 5 Adrian Georgescu
151 5 Adrian Georgescu
To change the default settings copy ircconference.ini.sample  to /etc/sylkserver/ircconference.ini
152 5 Adrian Georgescu
153 5 Adrian Georgescu
<pre>
154 5 Adrian Georgescu
[123]
155 5 Adrian Georgescu
channel = test
156 5 Adrian Georgescu
server = irc.freenode.net:6667
157 5 Adrian Georgescu
</pre>