codecs.conf.sample: update codec opus docs
[asterisk/asterisk.git] / configs / samples / extconfig.conf.sample
1 ;
2 ; Static and realtime external configuration
3 ; engine configuration
4 ;
5 ; See https://wiki.asterisk.org/wiki/display/AST/Realtime+Database+Configuration
6 ; for basic table formatting information.
7 ;
8 [settings]
9 ;
10 ; Static configuration files:
11 ;
12 ; file.conf => driver,database[,table[,priority]]
13 ;
14 ; maps a particular configuration file to the given
15 ; database driver, database and table (or uses the
16 ; name of the file as the table if not specified)
17 ;
18 ; Uncomment to load queues.conf via the odbc engine.
19 ;
20 ;queues.conf => odbc,asterisk,ast_config
21 ;extensions.conf => sqlite,asterisk,ast_config
22 ;
23 ; The following files CANNOT be loaded from Realtime storage:
24 ;       asterisk.conf
25 ;       extconfig.conf (this file)
26 ;       logger.conf
27 ;
28 ; Additionally, the following files cannot be loaded from
29 ; Realtime storage unless the storage driver is loaded
30 ; early using 'preload' statements in modules.conf:
31 ;       manager.conf
32 ;       cdr.conf
33 ;       rtp.conf
34 ;
35 ; Named ACLs specified in realtime also can not be used
36 ; from manager.conf unless the storage driver is preloaded.
37 ; Attempting to use a realtime stored named ACL before the
38 ; driver is loaded will result in an invalid ACL which
39 ; rejects all addresses.
40 ;
41 ; Realtime configuration engine
42 ;
43 ; maps a particular family of realtime
44 ; configuration to a given database driver,
45 ; database and table (or uses the name of
46 ; the family if the table is not specified
47 ;
48 ;example => odbc,asterisk,alttable,1
49 ;example => mysql,asterisk,alttable,2
50 ;example2 => ldap,"dc=oxymium,dc=net",example2
51 ;
52 ; Additionally, priorities are now supported for use as failover methods
53 ; for retrieving realtime data.  If one connection fails to retrieve any
54 ; information, the next sequential priority will be tried next.  This
55 ; especially works well with ODBC connections, since res_odbc now caches
56 ; when connection failures occur and prevents immediately retrying those
57 ; connections until after a specified timeout.  Note:  priorities must
58 ; start at 1 and be sequential (i.e. if you have only priorities 1, 2,
59 ; and 4, then 4 will be ignored, because there is no 3).
60 ;
61 ;
62 ; Possible driver backends:
63 ;
64 ; "odbc" is shown in the examples below, but is not the only valid realtime
65 ; engine.  Here are several of the possible options:
66 ;    odbc ... res_config_odbc
67 ;    sqlite ... res_config_sqlite
68 ;    sqlite3 ... res_config_sqlite3
69 ;    pgsql ... res_config_pgsql
70 ;    curl ... res_config_curl
71 ;    ldap ... res_config_ldap
72 ;    mysql ... res_config_mysql (available via add-ons in menuselect)
73 ;
74 ; Note: The res_config_pgsql and res_config_sqlite backends configure the
75 ; database used in their respective configuration files and ignore the
76 ; database name configured in this file.
77 ;
78 ;iaxusers => odbc,asterisk
79 ;iaxpeers => odbc,asterisk
80 ;sippeers => odbc,asterisk
81 ;sipregs => odbc,asterisk ; (avoid sipregs if possible, e.g. by using a view)
82 ;ps_endpoints => odbc,asterisk
83 ;ps_auths => odbc,asterisk
84 ;ps_aors => odbc,asterisk
85 ;ps_domain_aliases => odbc,asterisk
86 ;ps_endpoint_id_ips => odbc,asterisk
87 ;ps_outbound_publishes => odbc,asterisk
88 ;ps_inbound_publications = odbc,asterisk
89 ;ps_asterisk_publications = odbc,asterisk
90 ;voicemail => odbc,asterisk
91 ;extensions => odbc,asterisk
92 ;meetme => mysql,general
93 ;queues => odbc,asterisk
94 ;queue_members => odbc,asterisk
95 ;queue_rules => odbc,asterisk
96 ;acls => odbc,asterisk
97 ;musiconhold => mysql,general
98 ;queue_log => mysql,general
99 ;
100 ;
101 ; While most dynamic realtime engines are automatically used when defined in
102 ; this file, 'extensions', distinctively, is not.  To activate dynamic realtime
103 ; extensions, you must turn them on in each respective context within
104 ; extensions.conf with a switch statement.  The syntax is:
105 ;      switch => Realtime/[[db_context@]tablename]/<opts>
106 ; The only option available currently is the 'p' option, which disallows
107 ; extension pattern queries to the database.  If you have no patterns defined
108 ; in a particular context, this will save quite a bit of CPU time.  However,
109 ; note that using dynamic realtime extensions is not recommended anymore as a
110 ; best practice; instead, you should consider writing a static dialplan with
111 ; proper data abstraction via a tool like func_odbc.