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