Configuration

Version 5 (Adrian Georgescu, 07/12/2012 04:46 pm)

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