Configuration » History » Revision 10
Revision 9 (Adrian Georgescu, 07/31/2012 09:58 PM) → Revision 10/11 (Adrian Georgescu, 01/28/2013 04:51 PM)
h1. Configuration The server default configuration should just work. If you need to tweak some settings below is a list of all configurable parameters: h2. General server settings To change the default settings copy config.ini.sample to /etc/sylkserver/config.ini <pre> ; 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 Map user 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 specific application name ; application_map = echo:echo,123:conference,test:ircconference,gmail.com:xmppgateway 123:conference,test:irc-conference ; 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, 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 </pre> h2. Applications settings h3. Conference To change the default settings copy conference.ini.sample to /etc/sylkserver/conference.ini <pre> ; SylkServer Conference application configuration file [Conference] ; The following settings are the default used by the software, uncomment them ; only if you want to make changes ; db_uri = sqlite:///var/lib/sylkserver/conference.sqlite ; Database table name for storing messages history ; history_table = message_history ; Replay last chat messages after joining a room ; replay_history = 20 ; Directory for storing files transferred to rooms (a subdirectory for each room will be created) ; file_transfer_dir = /var/spool/sylkserver ; File transfer push support. If enabled files will be pushed to all active ; participants after receiving the file ; push_file_transfer = False ; Directory where images use by the Screen Sharing functionality will be stored ; screen_sharing_dir = /var/spool/sylkserver/screensharing ; IP address used for serving Screen Sharing HTTP requests, empty string means listen on interface used ; by the default route ; screen_sharing_ip = ; Port where Screen Sharing HTTP server will listen on, set to 0 for random ; screen_sharing_port = 0 ; Use HTTPS instead of HTTP ; screen_sharing_use_https = True ; Server certificate for HTTPS connections ; screen_sharing_certificate = /etc/sylkserver/tls/default.crt ; Advertise the conference server and each room in Bonjour ; use_bonjour = False ; Access Lists Default Policy ; Apache-style access lists for the caller using SIP domains or SIP URIs ; https://httpd.apache.org/docs/2.2/mod/mod_authz_host.html#order ; ; access_policy = allow, deny ; allow = all ; deny = none ; Access Lists can be applied per room overriding the Default Policy ; ; [test@domain.com] ; access_policy = allow, deny ; allow = example.com, test@domain.com ; deny = all </pre> h3. XMPP gateway To change the default settings copy xmppgateway.ini.sample to /etc/sylkserver/xmppgateway.ini <pre> ; SylkServer XMPP gateway application configuration file [general] ; Comma-separated list of domains for which this server is responsible ; Add the xmmp-server records into the DNS server responsable for these domains ; 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 ; 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 </pre> h3. IRC To change the default settings copy ircconference.ini.sample to /etc/sylkserver/ircconference.ini <pre> [123] channel = test server = irc.freenode.net:6667 </pre>