Merge anthm's monitor fixes (better default path, set variable for monitor) (bug...
[asterisk/asterisk.git] / doc / README.extconfig
1 Asterisk external configuration
2 ===============================
3
4 The Asterisk external configuration engine is the result of work by
5 Anthony Minessale II, Mark Spencer and Constantine Filin
6 It is designed to provide a flexible, seamless integration between
7 Asterisk's internal configuration structure and external SQL other other
8 databases (maybe even LDAP one day).
9
10 External configuration is configured in /etc/asterisk/extconfig.conf
11 allowing you to map any configuration file (static mappings) to
12 be pulled from the database, or to map special runtime entries which
13 permit the dynamic creation of objects, entities, peers, etc. without
14 the necessity of a reload.
15
16 Generally speaking, the columns in your tables should line up with the
17 fields you would specify in the given entity declaration.  If an entry
18 would appear more than once, in the column it should be separated by a
19 semicolon. For example, an entity that looks like:
20
21 [foo]
22 host=dynamic
23 secret=bar
24 context=default
25 context=local
26
27 could be stored in a table like this:
28
29 +------+--------+-------+--------------+----------+-----+-----------+
30 | name | host   | secret| context      | ipaddr   | port| regseconds|
31 +------+--------+-------+--------------+----------+-----+-----------+
32 | foo  | dynamic|  bar  | default;local| 127.0.0.1| 4569| 1096954152|
33 +------+--------+-------+--------------+----------+-----+-----------+
34
35 Note that for use with IAX or SIP, the table will also need the "name", 
36 "ipaddr", "port", "regseconds" columns.  If you wanted to be able to 
37 configure the callerid, you could just add a callerid column to the 
38 table, for example.
39
40 A SIP table would look more like this:
41
42 +------+--------+-------+----------+-----+------------+----------+
43 | name | host   | secret| ipaddr   | port| regseconds | username |
44 +------+--------+-------+----------+-----+------------+----------+
45 | foo  | dynamic|  bar  | 127.0.0.1| 4569| 1096954152 |   1234   |
46 +------+--------+-------+----------+-----+------------+----------+
47
48 in order to store appropriate parameters required for SIP.
49
50 A Voicemail table would look more like this:
51
52 +----------+---------+----------+----------+-----------+---------------+
53 | uniqueid | mailbox | context  | password |email      |   fullname    | 
54 +----------+---------+----------+----------+-----------+---------------+
55 |        1 |   1234  | default  |  4242    | a@b.com   | Joe Schmoe    | 
56 +----------+---------+----------+----------+-----------+---------------+
57
58 The uniqueid should be unique to each voicemail user and can be 
59 autoincrement.  It need not have any relation to the mailbox or context.
60
61 An extension table would look more like this:
62
63 +----------+---------+----------+-------+-----------+
64 | context  |  exten  | priority |  app  |  appdata  |
65 +----------+---------+----------+-------+-----------+
66 |  default |    1234 |        1 |  Dial |     Zap/1 |
67 +----------+---------+----------+-------+-----------+
68
69 In the dialplan you just use the Realtime switch:
70
71 [foo]
72 switch => Realtime
73
74 or:
75
76 [bar]
77 switch => Realtime/bar@extensions
78