Configuration¶

The server default configuration should just work. If you need to tweak some settings below is a list of all configurable parameters:

General server settings¶

To change the default settings copy config.ini.sample to /etc/sylkserver/config.ini

; SylkServer configuration file

[Server]

; The following settings are the default used by the software, uncomment
; them only if you want to make changes

; default_application = conference

; Statically map a Request URI to a specific application. In the example
; below, 123 is matched 1st against the domain part, than the username part
; of the Request URI This static mapping can be overwritten by adding
; X-Sylk-App header set to the value of a valid SylkServer application name
; application_map = echo:echo,123:conference,test:ircconference,gmail.com:xmppgateway

; Disable the specified applications
; disabled_applications =

; trace_dir = /var/log/sylkserver
; trace_core = False
; trace_sip = False
; trace_msrp = False
; trace_notifications = False

; TLS can be used for encryption of SIP signaling and MSRP media. TLS is
; disabled by default.  To enable TLS, you must have a valid X.509
; certificate and configure it below, then set the local_tls_port in the SIP
; section and use_tls in MSRP section

; The X.509 Certificate Authorities file
; ca_file = /etc/sylkserver/tls/ca.crt

; The file containing X.509 certificate and private key in unencrypted format
; certificate = /etc/sylkserver/tls/default.crt

; verify_server = False

; Enable Bonjour capabilities for applications
; enable_bonjour = False

[SIP]

; SIP transport settings
; IP address used for SIP signaling; empty string or any means listen on interface used
; by the default route
; local_ip =

; Ports used for SIP transports, if not set to any value the transport will be disabled
; local_udp_port = 5060
; local_tcp_port = 5060
; local_tls_port = 5061

; If set, all outbound SIP requests will be sent through this SIP proxy
; The proxy address format is: proxy.example.com:5061;transport=tls
; Transport can be udp, tcp or tls, if skipped it is considered udp
; If only the hostname is set, RFC3263 lookups are performed to lookup 
; the outbound proxy server address
; outbound_proxy =

; A comma-separated list of hosts or networks to trust.
; The elements can be an IP address in CIDR format, a
; hostname or an IP address (in the latter 2 a mask of 32
; is assumed), or the special keywords 'any' and 'none'
; (being equivalent to 0.0.0.0/0 and 0.0.0.0/32
; respectively). It defaults to 'any'.
; trusted_peers =

[MSRP]

; MSRP transport settings

; A valid X.509 certificate is required for MSRP to work over TLS.
; TLS is enabled by default, a default TLS certificate is provided with SylkServer.
; use_tls = True

[RTP]

; RTP transport settings

; Allowed codec list, valid values: G722, speex, PCMU, PCMA, iLBC, GSM
; audio_codecs = G722,speex,PCMU,PCMA

; Port range used for RTP
; port_range = 50000:50500

; SRTP valid values: disabled, mandatory, optional
; srtp_encryption = optional

; RTP stream timeout, session will be disconnected after this value
; timeout = 30

XMPP gateway¶

To change the default settings copy xmppgateway.ini.sample to /etc/sylkserver/xmppgateway.ini

; SylkServer XMPP gateway application configuration file

[general]

; Comma-separated list of domains for which this server is responsible
; Add the xmpp-server records into the DNS server responsable for these domains,
; e.g.: _xmpp-server._tcp.example.com. IN SRV    0 0 5269 sylkserver.example.com.
; At least one domain is required!
; domains =

; The following settings are the default used by the software, uncomment
; them only if you want to make changes

; Prefix that will be appended to all domains in the above setting, which will
; be used as a Multi User Chat (MUC) component
; Add the xmpp-server records into the DNS server for the conference domains,
; e.g.: _xmpp-server._tcp.conference.example.com. IN SRV 0 0 5269 sylkserver.example.com.
; muc_prefix = conference

; IP address used for listening to XMPP connections; empty string or any means listen on interface used
; by the default route
; local_ip =

; local_port = 5269

; If set to True (default) MSRP will be used to translate XMPP Instant Messaging, else SIP MESSAGE will be used
; Note: XMPP 'normal' messages (not chat messages) are always translated to SIP MESSAGE requests
; use_msrp_for_chat = True

; Timeout to terminate a SIP session if no chat traffic was received
; sip_session_timeout = 600

; Enable verbose logging of XMPP stantzas
; trace_xmpp = False

IRC¶

To change the default settings copy ircconference.ini.sample to /etc/sylkserver/ircconference.ini

[123]
channel = test
server = irc.freenode.net:6667