39585c1de7114c00bd883316f5d0d617aa0b5567
[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 port = 5038
27
28 ;httptimeout = 60
29 ; a) httptimeout sets the Max-Age of the http cookie
30 ; b) httptimeout is the amount of time the webserver waits 
31 ;    on a action=waitevent request (actually its httptimeout-10)
32 ; c) httptimeout is also the amount of time the webserver keeps 
33 ;    a http session alive after completing a successful action
34
35 bindaddr = 0.0.0.0
36
37 ; Parameters that control AMI over TLS. ("enabled" must be set too).
38 ; You can open a connection to this socket with e.g.
39 ;
40 ;       openssl s_client -connect my_host:5039
41 ;
42 ;   sslenable=no                ; set to YES to enable it
43 ;   sslbindport=5039            ; the port to bind to
44 ;   sslbindaddr=0.0.0.0         ; address to bind to, default to bindaddr
45 ;   sslcert=/tmp/asterisk.pem   ; path to the certificate.
46 ;   sslprivatekey=/tmp/private.pem ; path to the private key, if no private given,
47                                    ; if no sslprivatekey is given, default is to search
48                                                                    ; sslcert for private key.
49 ;   sslcipher=<cipher string>   ; string specifying which SSL ciphers to use or not use
50
51 ;
52 ;allowmultiplelogin = yes               ; IF set to no, rejects manager logins that are already in use.
53 ;                               ; The default is yes.
54 ;
55 ;displayconnects = yes
56 ;
57 ; Add a Unix epoch timestamp to events (not action responses)
58 ;
59 ;timestampevents = yes
60
61 ; debug = on    ; enable some debugging info in AMI messages (default off).
62                 ; Also accessible through the "manager debug" CLI command.
63 ;[mark]
64 ;secret = mysecret
65 ;deny=0.0.0.0/0.0.0.0
66 ;permit=209.16.236.73/255.255.255.0
67 ;
68 ; If the device connected via this user accepts input slowly,
69 ; the timeout for writes to it can be increased to keep it
70 ; from being disconnected (value is in milliseconds)
71 ;
72 ; writetimeout = 100
73 ;
74 ;displayconnects = yes  ; Display on CLI user login/logoff
75 ;
76 ; Authorization for various classes 
77 ;
78 ; Read authorization permits you to receive asynchronous events, in general.
79 ; Write authorization permits you to send commands and get back responses.  The
80 ; following classes exist:
81 ;
82 ; system    - General information about the system and ability to run system
83 ;             management commands, such as Shutdown, Restart, and Reload.
84 ; call      - Information about channels and ability to set information in a
85 ;             running channel.
86 ; log       - Logging information.  Read-only.
87 ; verbose   - Verbose information.  Read-only.
88 ; agent     - Information about queues and agents and ability to add queue
89 ;             members to a queue.
90 ; user      - Permission to send and receive UserEvent.
91 ; config    - Ability to read and write configuration files.
92 ; command   - Permission to run CLI commands.  Write-only.
93 ; dtmf      - Receive DTMF events.  Read-only.
94 ; reporting - Ability to get information about the system.
95 ; cdr       - Output of cdr_manager, if loaded.  Read-only.
96 ; dialplan  - Receive NewExten and VarSet events.  Read-only.
97 ; originate - Permission to originate new calls.  Write-only.
98 ;
99 ;read = system,call,log,verbose,agent,user,config,dtmf,reporting,cdr,dialplan
100 ;write = system,call,agent,user,config,command,reporting,originate
101