codecs.conf.sample: update codec opus docs
[asterisk/asterisk.git] / configs / samples / manager.conf.sample
1 ;
2 ; AMI - The Asterisk Manager Interface
3 ;
4 ; Third party application call management support and PBX event supervision
5 ;
6 ; Use the "manager show commands" at the CLI to list available manager commands
7 ; and their authorization levels.
8 ;
9 ; "manager show command <command>" will show a help text.
10 ;
11 ; ---------------------------- SECURITY NOTE -------------------------------
12 ; Note that you should not enable the AMI on a public IP address. If needed,
13 ; block this TCP port with iptables (or another FW software) and reach it
14 ; with IPsec, SSH, or SSL vpn tunnel.  You can also make the manager
15 ; interface available over http/https if Asterisk's http server is enabled in
16 ; http.conf and if both "enabled" and "webenabled" are set to yes in
17 ; this file.  Both default to no.  httptimeout provides the maximum
18 ; timeout in seconds before a web based session is discarded.  The
19 ; default is 60 seconds.
20 ;
21 [general]
22 enabled = no
23 ;webenabled = yes
24
25 port = 5038
26 bindaddr = 0.0.0.0
27
28 ; Parameters that control AMI over TLS. ("enabled" must be set too).
29 ; You can open a connection to this socket with e.g.
30 ;
31 ;       openssl s_client -connect my_host:5039
32 ;
33 ;tlsenable=no           ; set to YES to enable it
34 ;tlsbindaddr=0.0.0.0:5039               ; address and port to bind to, default to bindaddr and port 5039
35 ;tlscertfile=/tmp/asterisk.pem  ; path to the certificate.
36 ;tlsprivatekey=/tmp/private.pem ; path to the private key, if no private given,
37                                 ; if no tlsprivatekey is given, default is to search
38                                                                 ; tlscertfile for private key.
39 ;tlscipher=<cipher string>      ; string specifying which SSL ciphers to use or not use
40 ;
41 ;allowmultiplelogin = yes               ; IF set to no, rejects manager logins that are already in use.
42 ;                               ; The default is yes.
43 ;
44 ;displayconnects = yes
45 ;
46 ; Add a Unix epoch timestamp to events (not action responses)
47 ;
48 ;timestampevents = yes
49
50 ;brokeneventsaction = yes   ; Restore previous behavior that caused the events
51                             ; action to not return a response in certain
52                             ; circumstances.  Defaults to 'no'.
53
54 ;
55 ; Display certain channel variables every time a channel-oriented
56 ; event is emitted:
57 ;
58 ; Note that this does incur a performance penalty and should be avoided if possible.
59 ;
60 ;channelvars = var1,var2,var3
61
62 ; debug = on    ; enable some debugging info in AMI messages (default off).
63                 ; Also accessible through the "manager debug" CLI command.
64
65 ; authtimeout specifies the maximum number of seconds a client has to
66 ; authenticate.  If the client does not authenticate beofre this timeout
67 ; expires, the client will be disconnected. (default: 30 seconds)
68
69 ;authtimeout = 30
70
71 ; authlimit specifies the maximum number of unauthenticated sessions that will
72 ; be allowed to connect at any given time.
73
74 ;authlimit = 50
75
76 ;httptimeout = 60
77 ; a) httptimeout sets the Max-Age of the http cookie
78 ; b) httptimeout is the amount of time the webserver waits
79 ;    on a action=waitevent request (actually its httptimeout-10)
80 ; c) httptimeout is also the amount of time the webserver keeps
81 ;    a http session alive after completing a successful action
82
83
84 ;[mark]
85 ;secret = mysecret
86 ;deny=0.0.0.0/0.0.0.0
87 ;permit=209.16.236.73/255.255.255.0
88 ;acl=named_acl_example               ; use a named ACL from acl.conf
89 ;
90 ;
91 ;setvar=PBXACCOUNT=edvina
92 ; The setvar option defines channel variables that will be set when this account
93 ; originates a call. You can define multiple setvar= commands for one manager
94 ; user.
95 ;
96 ;eventfilter=Event: Newchannel
97 ;eventfilter=Channel: (PJ)?SIP/(james|jim|john)-
98 ;eventfilter=!Channel: DAHDI/
99 ; The eventfilter option is used to whitelist or blacklist events per user.
100 ; A filter consists of an (unanchored) regular expression that is run on the
101 ; entire event data. If the first character of the filter is an exclamation
102 ; mark (!), the filter is appended to the blacklist instead of the whitelist.
103 ; After first checking the read access below, the regular expression filters
104 ; are processed as follows:
105 ; - If no filters are configured all events are reported as normal.
106 ; - If there are white filters only: implied black all filter processed first,
107 ; then white filters.
108 ; - If there are black filters only: implied white all filter processed first,
109 ; then black filters.
110 ; - If there are both white and black filters: implied black all filter processed
111 ; first, then white filters, and lastly black filters.
112
113 ;
114 ; If the device connected via this user accepts input slowly,
115 ; the timeout for writes to it can be increased to keep it
116 ; from being disconnected (value is in milliseconds)
117 ;
118 ; writetimeout = 100
119 ;
120 ;displayconnects = yes  ; Display on CLI user login/logoff
121 ;
122 ; Authorization for various classes
123 ;
124 ; Read authorization permits you to receive asynchronous events, in general.
125 ; Write authorization permits you to send commands and get back responses.  The
126 ; following classes exist:
127 ;
128 ; all       - All event classes below (including any we may have missed).
129 ; system    - General information about the system and ability to run system
130 ;             management commands, such as Shutdown, Restart, and Reload. This
131 ;             class also includes dialplan manipulation actions such as
132 ;             DialplanExtensionAdd and DialplanExtensionRemove.
133 ; call      - Information about channels and ability to set information in a
134 ;             running channel.
135 ; log       - Logging information.  Read-only. (Defined but not yet used.)
136 ; verbose   - Verbose information.  Read-only. (Defined but not yet used.)
137 ; agent     - Information about queues and agents and ability to add queue
138 ;             members to a queue.
139 ; user      - Permission to send and receive UserEvent.
140 ; config    - Ability to read and write configuration files.
141 ; command   - Permission to run CLI commands.  Write-only.
142 ; dtmf      - Receive DTMF events.  Read-only.
143 ; reporting - Ability to get information about the system.
144 ; cdr       - Output of cdr_manager, if loaded.  Read-only.
145 ; dialplan  - Receive NewExten and VarSet events.  Read-only.
146 ; originate - Permission to originate new calls.  Write-only.
147 ; agi       - Output AGI commands executed.  Input AGI command to execute.
148 ; cc        - Call Completion events.  Read-only.
149 ; aoc       - Permission to send Advice Of Charge messages and receive Advice
150 ;           - Of Charge events.
151 ; test      - Ability to read TestEvent notifications sent to the Asterisk Test
152 ;             Suite.  Note that this is only enabled when the TEST_FRAMEWORK
153 ;             compiler flag is defined.
154 ; security  - Security Events.  Read-only.
155 ; message   - Permissions to send out of call messages. Write-only
156 ;
157 ;read = system,call,log,verbose,agent,user,config,dtmf,reporting,cdr,dialplan
158 ;write = system,call,agent,user,config,command,reporting,originate,message