added sample config

3 files changed, 234 insertions, 0 deletions

diff --git a/docs/examples/accounts b/docs/examples/accounts
new file mode 100644
index 0000000..2b4a39c
--- /dev/null
+++ b/docs/examples/accounts
@@ -0,0 +1,58 @@
+#
+# SIP accounts - one account per line -- sample configuration
+#
+# Displayname <sip:user:password@domain;uri-params>;addr-params
+#
+#  uri-params:
+#    ;transport={udp,tcp,tls}
+#
+#  addr-params:
+#    ;answermode={manual,early,auto}
+#    ;audio_codecs=speex/16000,pcma,...
+#    ;auth_user=username
+#    ;mediaenc={srtp,srtp-mand,srtp-mandf,dtls_srtp,zrtp}
+#    ;medianat={stun,turn,ice}
+#    ;outbound="sip:primary.example.com;transport=tcp"
+#    ;outbound2=sip:secondary.example.com
+#    ;ptime={10,20,30,40,...}
+#    ;regint=3600
+#    ;pubint=0 (publishing off)
+#    ;regq=0.5
+#    ;rtpkeep={zero,stun,dyna,rtcp}
+#    ;sipnat={outbound}
+#    ;stunserver=stun:[user:pass]@host[:port]
+#    ;video_codecs=h264,h263,...
+#
+# Examples:
+#
+#  <sip:user:secret@domain.com;transport=tcp>
+#  <sip:user:secret@1.2.3.4;transport=tcp>
+#  <sip:user:secret@[2001:df8:0:16:216:6fff:fe91:614c]:5070;transport=tcp>
+#
+
+
+#
+# A very basic example
+#
+<sip:user@iptel.org>
+
+
+#
+# Use SIP Outbound over TCP, with ICE for Media NAT Traversal, and DTLS-SRTP for encryption
+#
+<sip:user:pass@example.com>;sipnat=outbound;outbound="sip:example.com;transport=tcp";medianat=ice;mediaenc=dtls_srtp
+
+
+#
+# Use ICE for Media NAT Traversal, using a specific STUN-server
+#
+<sip:user:pass@example.com>;medianat=ice;stunserver="stun:username:password@stunserver.org"
+
+
+#
+# Force audio-codec 'opus' and video-codec 'vp8'
+#
+<sip:user:pass@example.com>;audio_codecs=opus/48000/2;video_codecs=vp8
+
+
+# ... more examples can be added here ...
diff --git a/docs/examples/config b/docs/examples/config
new file mode 100644
index 0000000..7ad1c83
--- /dev/null
+++ b/docs/examples/config
@@ -0,0 +1,165 @@
+#
+# baresip configuration -- example for linux
+#
+
+#------------------------------------------------------------------------------
+
+# Core
+poll_method		epoll		# poll, select, epoll ..
+
+# SIP
+sip_trans_bsize		128
+#sip_listen		0.0.0.0:5060
+#sip_certificate	cert.pem
+
+# Audio
+audio_player		alsa,default
+audio_source		alsa,default
+audio_alert		alsa,default
+audio_srate		8000-48000
+audio_channels		1-2
+#ausrc_srate		48000
+#auplay_srate		48000
+#ausrc_channels		0
+#auplay_channels		0
+
+# Video
+#video_source		v4l2,/dev/video0
+#video_display		x11,nil
+video_size		352x288
+video_bitrate		512000
+video_fps		25
+
+# AVT - Audio/Video Transport
+rtp_tos			184
+#rtp_ports		10000-20000
+#rtp_bandwidth		512-1024 # [kbit/s]
+rtcp_enable		yes
+rtcp_mux		no
+jitter_buffer_delay	5-10		# frames
+rtp_stats		no
+
+# Network
+#dns_server		10.0.0.1:53
+#net_interface		wlan1
+
+# BFCP
+#bfcp_proto		udp
+
+#------------------------------------------------------------------------------
+# Modules
+
+#module_path		/usr/local/lib/baresip/modules
+
+# UI Modules
+module			stdio.so
+#module			cons.so
+#module			evdev.so
+#module			httpd.so
+
+# Audio codec Modules (in order)
+module			opus.so
+#module			silk.so
+#module			amr.so
+#module			g7221.so
+#module			g722.so
+#module			g726.so
+module			g711.so
+#module			gsm.so
+#module			l16.so
+#module			speex.so
+#module			bv32.so
+
+# Audio filter Modules (in encoding order)
+#module			vumeter.so
+#module			sndfile.so
+#module			speex_aec.so
+#module			speex_pp.so
+#module			plc.so
+
+# Audio driver Modules
+module			alsa.so
+#module			portaudio.so
+
+# Video codec Modules (in order)
+module			avcodec.so
+module			vpx.so
+
+# Video filter Modules (in encoding order)
+#module			selfview.so
+
+# Video source modules
+#module			v4l.so
+module			v4l2.so
+#module			avformat.so
+#module			x11grab.so
+#module			cairo.so
+
+# Video display modules
+module			x11.so
+#module			sdl2.so
+
+# Audio/Video source modules
+#module			rst.so
+#module			gst.so
+
+# Media NAT modules
+module			stun.so
+module			turn.so
+module			ice.so
+#module			natpmp.so
+
+# Media encryption modules
+#module			srtp.so
+module			dtls_srtp.so
+
+
+#------------------------------------------------------------------------------
+# Temporary Modules (loaded then unloaded)
+
+module_tmp		uuid.so
+module_tmp		account.so
+
+
+#------------------------------------------------------------------------------
+# Application Modules
+
+module_app		auloop.so
+module_app		contact.so
+module_app		menu.so
+#module_app		mwi.so
+#module_app		natbd.so
+#module_app		presence.so
+#module_app		syslog.so
+module_app		vidloop.so
+
+
+#------------------------------------------------------------------------------
+# Module parameters
+
+
+cons_listen		0.0.0.0:5555
+
+evdev_device		/dev/input/event0
+
+# Speex codec parameters
+speex_quality		7 # 0-10
+speex_complexity	7 # 0-10
+speex_enhancement	0 # 0-1
+speex_vbr		0 # Variable Bit Rate 0-1
+speex_vad		0 # Voice Activity Detection 0-1
+speex_agc_level		8000
+
+# NAT Behavior Discovery
+natbd_server		creytiv.com
+natbd_interval		600		# in seconds
+
+# Selfview
+video_selfview		window # {window,pip}
+#selfview_size		64x64
+
+# ICE
+ice_turn		no
+ice_debug		no
+ice_nomination		regular	# {regular,aggressive}
+ice_mode		full	# {full,lite}
diff --git a/docs/examples/contacts b/docs/examples/contacts
new file mode 100644
index 0000000..b5131a6
--- /dev/null
+++ b/docs/examples/contacts
@@ -0,0 +1,11 @@
+#
+# SIP contacts
+#
+# Displayname <sip:user@domain>;addr-params
+#
+#  addr-params:
+#    ;presence={none,p2p}
+#
+
+"Echo Server" <sip:echo@creytiv.com>
+"alfredh" <sip:alfredh@home>;presence=p2p