Add DUNDi.... (http://www.dundi.com)
[asterisk/asterisk.git] / configs / dundi.conf.sample
1 ;
2 ; DUNDi configuration file
3 ;
4 ;
5 [general]
6 ;
7 ; The "general" section contains general parameters relating
8 ; to the operation of the dundi client and server.
9 ;
10 ; The first part should be your complete contact information
11 ; should someone else in your peer group need to contact you.
12 ;
13 ;department=Your Department
14 ;organization=Your Company, Inc.
15 ;locality=Your City
16 ;stateprov=ST
17 ;country=US
18 ;email=your@email.com
19 ;phone=+12565551212
20 ;
21 ;
22 ; Specify bind address and port number.  Default is
23 ; 4520
24 ;
25 ;bindaddr=0.0.0.0
26 ;port=4520
27 ;
28 ; Our entity identifier (Should generally be the MAC address of the
29 ; machine it's running on.  Defaults to the first eth address, but you
30 ; can override it here, as long as you set it to the MAC of *something*
31 ; you own!)
32 ;
33 ;entityid=00:07:E9:3B:76:60
34 ;
35 ; Define the max depth in which to search the DUNDi system (also max # of 
36 ; seconds to wait for a reply)
37 ;
38 ttl=32
39 ;
40 ; If we don't get ACK to our DPREQUEST within 2000ms, and autokill is set
41 ; to yes, then we cancel the whole thing (that's enough time for one 
42 ; retransmission only).  This is used to keep things from stalling for a long
43 ; time for a host that is not available, but would be ill advised for bad 
44 ; connections.  In addition to 'yes' or 'no' you can also specify a number
45 ; of milliseconds.  See 'qualify' for individual peers to turn on for just
46 ; a specific peer.
47 ;
48 autokill=yes
49 ;
50 ; pbx_dundi creates a rotating key called "secret", under the family
51 ; 'secretpath'.  The default family is dundi (resulting in 
52 ; the key being held at dundi/secret).
53 ;
54 ;secretpath=dundi
55
56 [mappings]
57 ;
58 ; The "mappings" section maps DUNDi contexts
59 ; to contexts on the local asterisk system.  Remember
60 ; that numbers that are made available under the e164 
61 ; DUNDi context are regulated by the DUNDi General Peering 
62 ; Agreement (GPA) if you are a member of the DUNDi E.164
63 ; Peering System.
64 ;
65 ; dundi_context => local_context,weight,tech,dest[,options]]
66 ;
67 ; dundi_context is the name of the context being requested
68 ; within the DUNDi request
69 ;
70 ; local_context is the name of the context on the local system
71 ; in which numbers can be looked up for which responses shall be given.
72 ;
73 ; tech is the technology to use (IAX, SIP, H323)
74 ;
75 ; dest is the destination to supply for reaching that number.  Note
76 ; that the variable ${NUMBER} shall be replaced by the number being
77 ; requested.
78 ;
79 ; Further options may include:
80 ;
81 ; nounsolicited:  No unsolicited calls of any type permitted via this 
82 ;                 route
83 ; nocomunsolicit: No commercial unsolicited calls permitted via 
84 ;                 this route
85 ; residential:    This number is known to be a residence
86 ; commercial:     This number is known to be a business
87 ; mobile:         This number is known to be a mobile phone
88 ; nocomunsolicit: No commercial unsolicited calls permitted via 
89 ;                 this route
90 ; nopartial:      Do not search for partial matches
91 ;
92 ; There *must* exist an entry in mappings for DUNDi to respond
93 ; to any request, although it may be empty.
94 ;
95 ;e164 => dundi-e164-canonical,0,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
96 ;e164 => dundi-e164-customers,100,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
97 ;e164 => dundi-e164-via-pstn,400,IAX2,dundi:${SECRET}@${IPADDR}/${NUMBER},nounsolicited,nocomunsolicit,nopartial
98
99 ;digexten => default,0,IAX2,guest@lappy/${NUMBER}
100 ;asdf =>
101
102
103 ;
104 ;
105 ; The remaining sections represent the peers
106 ; that we fundamentally trust.  The section name
107 ; represents the name and optionally at a specific
108 ; DUNDi context if you want the trust to be established
109 ; for only a specific DUNDi context.
110 ;
111 ; inkey - What key they will be authenticating to us with
112 ;
113 ; outkey - What key we use to authenticate to them
114 ;
115 ; host - What their host is
116 ;
117 ; order - What search order to use.  May be 'primary', 'secondary', 
118 ;         'tertiary' or 'quartiary'.  In large systems, it is beneficial
119 ;         to only query one up-stream host in order to maximize caching
120 ;         value.  Adding one with primary and one with secondary gives you
121 ;         redundancy without sacraficing performance.
122 ;
123 ; include - Includes this peer when searching a particular context
124 ;           for lookup (set "all" to perform all lookups with that
125 ;           host.
126 ;
127 ; noinclude - Disincludes this peer when searching a particular context
128 ;             for lookup (set "all" to perform no lookups with that
129 ;             host.
130 ;
131 ; permit - Permits this peer to search a given DUNDi context on
132 ;          the local system.  Set "all" to permit this host to
133 ;          lookup all contexts.
134 ;
135 ; deny -   Denies this peer to search a given DUNDi context on
136 ;          the local system.  Set "all" to deny this host to
137 ;          lookup all contexts.
138 ;
139 ; model - inbound, outbound, or symmetric for whether we receive 
140 ;         requests only, transmit requests only, or do both.
141 ;
142 ; The '*' peer is special and matches an unspecified entity
143 ;
144
145 ;
146 ; Sample Primary e164 DUNDi peer
147 ;
148 [00:50:8B:F3:75:BB]
149 model = symmetric
150 host = 64.215.96.114
151 inkey = digium
152 outkey = misery
153 include = e164
154 permit = e164
155 qualify = yes
156
157 ;
158 ; Sample Secondary e164 DUNDi peer
159 ;
160 ;[00:A0:C9:96:92:84]
161 ;model = symmetric
162 ;host = misery.digium.com
163 ;inkey = misery
164 ;outkey = ourkey
165 ;include = e164
166 ;permit = e164
167 ;qualify = yes
168 ;order = secondary
169
170
171 ;[*]
172 ;