Improve sample configuration files (bug #1125)
[asterisk/asterisk.git] / configs / sip.conf.sample
1 ;
2 ; SIP Configuration for Asterisk
3 ;
4 ; Syntax for specifying a SIP device in extensions.conf is
5 ; SIP/devicename where devicename is defined in a section below.
6 ;
7 ; You may also use 
8 ; SIP/username@domain to call any SIP user on the Internet
9 ; (Don't forget to enable DNS SRV records if you want to use this)
10
11 ; If you define a SIP proxy as a peer below, you may call
12 ; SIP/proxyhostname/user or SIP/user@proxyhostname 
13 ; where the proxyhostname is defined in a section below 
14
15 ; Useful CLI commands to check peers/users:
16 ;   sip show peers              Show all SIP peers (including friends)
17 ;   sip show users              Show all SIP users (including friends)
18 ;   sip show registry           Show status of hosts we register with
19 ;
20 ;   sip debug                   Show all SIP messages
21 ;
22
23 [general]
24 context=default                 ; Default context for incoming calls
25 ;realm=mydomain.tld             ; Realm for digest authentication
26                                 ; defaults to "asterisk"
27                                 ; Realms MUST be globally unique according to RFC 3261
28                                 ; Set this to your host name or domain name
29 port=5060                       ; UDP Port to bind to (SIP standard port is 5060)
30 bindaddr=0.0.0.0                ; IP address to bind to (0.0.0.0 binds to all)
31 ;srvlookup=yes                  ; Enable DNS SRV lookups on outbound calls
32                                 ; Note: Asterisk only uses the first host in SRV records
33 ;pedantic=yes                   ; Enable slow, pedantic checking for Pingtel
34                                 ; and multiline formatted headers for strict
35                                 ; SIP compatibility
36 ;tos=184                        ; Set IP QoS to either a keyword or numeric val
37 ;tos=lowdelay                   ; lowdelay,throughput,reliability,mincost,none
38 ;maxexpirey=3600                ; Max length of incoming registration we allow
39 ;defaultexpirey=120             ; Default length of incoming/outoing registration
40 ;notifymimetype=text/plain      ; Allow overriding of mime type in NOTIFY
41 ;videosupport=yes               ; Turn on support for SIP video
42
43 ;disallow=all                   ; First disallow all codecs
44 ;allow=ulaw                     ; Allow codecs in order of preference
45 ;allow=ilbc                     ; Note: codec order is respected only in [general]
46 ;musicclass=default             ; Sets the default music on hold class for all SIP calls
47                                 ; This may also be set for individual users/peers
48 ;language=en                    ; Default language setting for all users/peers
49                                 ; This may also be set for individual users/peers
50 ;relaxdtmf=yes                  ; Relax dtmf handling
51
52
53 ; Asterisk can register as a SIP user agent to a SIP proxy (provider)
54 ; Format for the register statement is:
55 ;       register => user[:secret[:authuser]]@host[:port][/extension]
56 ;
57 ; If no extension is given, the 's' extension is used. The extension
58 ; needs to be defined in extensions.conf to be able to accept calls
59 ; from this SIP proxy (provider)
60 ;
61 ; host is either a host name defined in DNS or the name of a 
62 ; section defined below.
63 ;
64 ; Examples:
65 ;
66 ;register => 1234:password@mysipprovider.com    
67 ;
68 ;     This will pass incoming calls to the 's' extension
69 ;
70 ;
71 ;register => 2345:password@sip_proxy/1234
72 ;
73 ;    Register 2345 at sip provider 'sip_proxy'.  Calls from this provider connect to local 
74 ;    extension 1234 in extensions.conf default context, unless you define 
75 ;    unless you configure a [sip_proxy] section below, and configure a context.
76 ;        Tip 1: Avoid assigning hostname to a sip.conf section like [provider.com]
77 ;        Tip 2: Use separate type=peer and type=user sections for SIP providers
78 ;                      (instead of type=friend) if you have calls in both directions
79   
80
81 ;externip = 200.201.202.203     ; Address that we're going to put in outbound SIP messages
82                                 ; if we're behind a NAT
83
84                                 ; The externip and localnet is used
85                                 ; when registering and communicating with other proxies
86                                 ; that we're registered with
87                                 ; You may add multiple local networks.  A reasonable set of defaults
88                                 ; are:
89 ;localnet=192.168.0.0/255.255.0.0; All RFC 1918 addresses are local networks
90 ;localnet=10.0.0.0/255.0.0.0    ; Also RFC1918
91 ;localnet=172.16.0.0/12         ; Another RFC1918 with CIDR notation
92 ;localnet=169.254.0.0/255.255.0.0 ;Zero conf local network
93
94 ;-----------------------------------------------------------------------------------
95 ; Users and peers have different settings available. Friends have all settings,
96 ; since a friend is both a peer and a user
97 ;
98 ; User config options:        Peer configuration:
99 ; --------------------        -------------------
100 ; context                     context
101 ; permit                      permit
102 ; deny                        deny
103 ; auth                        auth
104 ; secret                      secret
105 ; md5secret                   md5secret
106 ; dtmfmode                    dtmfmode
107 ; canreinvite                 canreinvite
108 ; nat                         nat
109 ; callgroup                   callgroup
110 ; pickupgroup                 pickupgroup
111 ; language                    language
112 ; allow                       allow
113 ; disallow                    disallow
114 ; insecure                    insecure
115 ; callerid
116 ; accountcode
117 ; amaflags
118 ; incominglimit
119 ; outgoinglimit
120 ; restrictcid
121 ;                             mailbox
122 ;                             username
123 ;                             template
124 ;                             fromdomain
125 ;                             fromuser
126 ;                             host
127 ;                             mask
128 ;                             port
129 ;                             qualify
130 ;                             defaultip
131
132
133 ;[sip_proxy]
134 ; For incoming calls only. Example: FWD (Free World Dialup)
135 ;type=user
136 ;context=from-fwd
137
138 ;[sip_proxy-out]
139 ;type=peer                  ; we only want to call out, not be called
140 ;secret=guessit
141 ;username=yourusername
142 ;fromuser=yourusername         ; Many SIP providers require this!
143 ;host=box.provider.com
144
145 ;[grandstream1]
146 ;type=friend                   ; either "friend" (peer+user), "peer" or "user"
147 ;context=from-sip
148 ;username=grandstream1         ; usually matches the [section] title
149 ;fromuser=grandstream1         ; overrides the callerid, e.g. required by FWD
150 ;callerid=John Doe <1234>
151 ;host=192.168.0.23             ; we have a static but private IP address
152 ;nat=no                        ; there is not NAT between phone and Asterisk
153 ;canreinvite=yes               ; allow RTP voice traffic to bypass Asterisk
154 ;dtmfmode=info                 ; either RFC2833 or INFO for the BudgeTone
155 ;outgoinglimit=1               ; disable callwaiting signal (2nd call to phone)
156 ;incominglimit=1               ; permit only 1 outgoing call at a time
157 ;mailbox=1234@default  ; mailbox 1234 in voicemail context "default"
158 ;disallow=all                  ; need to disallow=all before we can use allow=
159 ;allow=ulaw                    ; Note: In user sections the order of codecs
160                                ; listed with allow= does NOT matter!
161 ;allow=alaw
162 ;allow=g723.1                  ; Asterisk only supports g723.1 pass-thru!
163 ;allow=g729                    ; Pass-thru only unless g729 license obtained
164
165
166 ;[xlite1]
167 ;Turn off silence suppression in X-Lite ("Transmit Silence"=YES)!
168 ;Note that Xlite sends NAT keep-alive packets, so qualify=yes is not needed
169 ;type=friend
170 ;username=xlite1
171 ;callerid="Jane Smith" <5678>
172 ;host=dynamic
173 ;nat=yes                       ; X-Lite is behind a NAT router
174 ;canreinvite=no                ; Typically set to NO if behind NAT
175 ;disallow=all
176 ;allow=gsm                     ; GSM consumes far less bandwidth than ulaw
177 ;allow=ulaw
178 ;allow=alaw
179
180
181 ;[snom]
182 ;type=friend                    ; Friends place calls and receive calls
183 ;context=from-sip               ; Context for incoming calls from this user
184 ;secret=blah
185 ;host=dynamic                   ; This peer register with us
186 ;dtmfmode=inband                ; Choices are inband, rfc2833, or info
187 ;defaultip=192.168.0.59         ; IP used until peer registers
188 ;mailbox=1234,2345              ; Mailboxes for message waiting indicator
189 ;restrictcid=yes                ; To have the callerid restriced -> sent as ANI
190 ;disallow=all
191 ;allow=ulaw                     ; dtmfmode=inband only works with ulaw or alaw!
192 ;mailbox=1234@context,2345      ; Mailbox(-es) for message waiting indicator
193
194
195 ;[pingtel]
196 ;type=friend
197 ;username=pingtel
198 ;secret=blah
199 ;host=dynamic
200 ;insecure=yes                   ; To match a peer based by IP address only and not peer
201 ;insecure=very                  ; To allow registered hosts to call without re-authenticating
202 ;qualify=1000                   ; Consider it down if it's 1 second to reply
203                                 ; Helps with NAT session
204                                 ; qualify=yes uses default value
205 ;callgroup=1,3-4                ; We are in caller groups 1,3,4
206 ;pickupgroup=1,3-5              ; We can do call pick-p for call group 1,3,4,5
207 ;defaultip=192.168.0.60         ; IP address to use if peer has not registred
208
209 ;[cisco1]
210 ;type=friend
211 ;username=cisco1
212 ;secret=blah
213 ;qualify=200                    ; Qualify peer is no more than 200ms away
214 ;nat=yes                        ; This phone may be natted
215                                 ; Send SIP and RTP to  IP address that packet is 
216                                 ; received from instead of trusting SIP headers 
217 ;host=dynamic                   ; This device registers with us
218 ;canreinvite=no                 ; Asterisk by default tries to redirect the
219                                 ; RTP media stream (audio) to go directly from
220                                 ; the caller to the callee.  Some devices do not
221                                 ; support this (especially if one of them is 
222                                 ; behind a NAT).
223 ;defaultip=192.168.0.4
224
225 ;[cisco2]
226 ;type=friend
227 ;username=cisco2
228 ;fromuser=markster              ; Specify user to put in "from" instead of callerid
229 ;fromdomain=yourdomain.com      ; Specify domain to put in "from" instead of callerid
230                                 ; fromuser and fromdomain are used when Asterisk
231                                 ; places calls to this account.  It is not used for
232                                 ; calls from this account.
233 ;secret=blah
234 ;host=dynamic
235 ;defaultip=192.168.0.4
236 ;amaflags=default               ; Choices are default, omit, billing, documentation
237 ;accountcode=markster           ; Users may be associated with an accountcode to ease billing