Named ACLs: Introduces a system for creating and sharing ACLs
[asterisk/asterisk.git] / configs / manager.conf.sample
1 ;
2 ; AMI - The Asterisk Manager Interface
3 ;
4 ; Third party application call management support and PBX event supervision
5 ;
6 ; This configuration file is read every time someone logs in
7 ;
8 ; Use the "manager show commands" at the CLI to list available manager commands
9 ; and their authorization levels.
10 ;
11 ; "manager show command <command>" will show a help text.
12 ;
13 ; ---------------------------- SECURITY NOTE -------------------------------
14 ; Note that you should not enable the AMI on a public IP address. If needed,
15 ; block this TCP port with iptables (or another FW software) and reach it
16 ; with IPsec, SSH, or SSL vpn tunnel.  You can also make the manager
17 ; interface available over http/https if Asterisk's http server is enabled in
18 ; http.conf and if both "enabled" and "webenabled" are set to yes in
19 ; this file.  Both default to no.  httptimeout provides the maximum
20 ; timeout in seconds before a web based session is discarded.  The
21 ; default is 60 seconds.
22 ;
23 [general]
24 enabled = no
25 ;webenabled = yes
26
27 port = 5038
28 bindaddr = 0.0.0.0
29
30 ; Parameters that control AMI over TLS. ("enabled" must be set too).
31 ; You can open a connection to this socket with e.g.
32 ;
33 ;       openssl s_client -connect my_host:5039
34 ;
35 ;tlsenable=no           ; set to YES to enable it
36 ;tlsbindaddr=0.0.0.0:5039               ; address and port to bind to, default to bindaddr and port 5039
37 ;tlscertfile=/tmp/asterisk.pem  ; path to the certificate.
38 ;tlsprivatekey=/tmp/private.pem ; path to the private key, if no private given,
39                                 ; if no tlsprivatekey is given, default is to search
40                                                                 ; tlscertfile for private key.
41 ;tlscipher=<cipher string>      ; string specifying which SSL ciphers to use or not use
42 ;
43 ;allowmultiplelogin = yes               ; IF set to no, rejects manager logins that are already in use.
44 ;                               ; The default is yes.
45 ;
46 ;displayconnects = yes
47 ;
48 ; Add a Unix epoch timestamp to events (not action responses)
49 ;
50 ;timestampevents = yes
51
52 ;brokeneventsaction = yes   ; Restore previous behavior that caused the events
53                             ; action to not return a response in certain
54                             ; circumstances.  Defaults to 'no'.
55
56 ;
57 ; Display certain channel variables every time a channel-oriented
58 ; event is emitted:
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 ;eventfilter=Event: Newchannel
91 ;eventfilter=!Channel: DAHDI*
92 ; The eventfilter option is used to whitelist or blacklist events per user to be
93 ; reported with regular expressions and are allowed if both the regex matches
94 ; and the user has read access set below. Filters are assumed to be for whitelisting
95 ; unless preceeded by an exclamation point, which marks it as being black.
96 ; Evaluation of the filters is as follows:
97 ; - If no filters are configured all events are reported as normal.
98 ; - If there are white filters only: implied black all filter processed first,
99 ; then white filters.
100 ; - If there are black filters only: implied white all filter processed first,
101 ; then black filters.
102 ; - If there are both white and black filters: implied black all filter processed
103 ; first, then white filters, and lastly black filters.
104
105 ;
106 ; If the device connected via this user accepts input slowly,
107 ; the timeout for writes to it can be increased to keep it
108 ; from being disconnected (value is in milliseconds)
109 ;
110 ; writetimeout = 100
111 ;
112 ;displayconnects = yes  ; Display on CLI user login/logoff
113 ;
114 ; Authorization for various classes
115 ;
116 ; Read authorization permits you to receive asynchronous events, in general.
117 ; Write authorization permits you to send commands and get back responses.  The
118 ; following classes exist:
119 ;
120 ; all       - All event classes below (including any we may have missed).
121 ; system    - General information about the system and ability to run system
122 ;             management commands, such as Shutdown, Restart, and Reload.
123 ; call      - Information about channels and ability to set information in a
124 ;             running channel.
125 ; log       - Logging information.  Read-only. (Defined but not yet used.)
126 ; verbose   - Verbose information.  Read-only. (Defined but not yet used.)
127 ; agent     - Information about queues and agents and ability to add queue
128 ;             members to a queue.
129 ; user      - Permission to send and receive UserEvent.
130 ; config    - Ability to read and write configuration files.
131 ; command   - Permission to run CLI commands.  Write-only.
132 ; dtmf      - Receive DTMF events.  Read-only.
133 ; reporting - Ability to get information about the system.
134 ; cdr       - Output of cdr_manager, if loaded.  Read-only.
135 ; dialplan  - Receive NewExten and VarSet events.  Read-only.
136 ; originate - Permission to originate new calls.  Write-only.
137 ; agi       - Output AGI commands executed.  Input AGI command to execute.
138 ; cc        - Call Completion events.  Read-only.
139 ; aoc       - Permission to send Advice Of Charge messages and receive Advice
140 ;           - Of Charge events.
141 ; test      - Ability to read TestEvent notifications sent to the Asterisk Test
142 ;             Suite.  Note that this is only enabled when the TEST_FRAMEWORK
143 ;             compiler flag is defined.
144 ; message   - Permissions to send out of call messages. Write-only
145 ;
146 ;read = system,call,log,verbose,agent,user,config,dtmf,reporting,cdr,dialplan
147 ;write = system,call,agent,user,config,command,reporting,originate,message
148