Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

I've been playing with the idea of rewriting our config files, while they contain along of useful information, it is overwhelming for new users. Additionally, we do not have a standard to format them. Below is some example formats I am playing with.

No Format
; Value: <parameter>
; Section: <name>
; Description: <insert up to 60 chars description>
;  <insert long description, indented with spaces>
; Since: <version>
; Default: <setting>
<value> = <parameter>
No Format
; File: manager.conf
; Description:

[general]
; Value: enabled
; Section: general
; Description:
; Since: 1.0
; Default: no
enabled = no

; Value: webenabled
; Section: general
; Description:
; Since: 1.0
; Default: no
webenabled = no

; Value: port
; Section: general
; Description:
; Since: 1.0
; Default: 5038
port = 5038

; Value: bindaddr
; Section: general
; Since: 1.0
; Description:
; Default: 0.0.0.0
bindaddr = 0.0.0.0

; Value: tlsenable
; Section: general
; Since: 1.0
; Description:
; Default: no
tlsenable = no

; Value: tlsbindport
; Section: general
; Since: 1.0
; Description: TCP port to bind to
; Default: 5039
tlsbindport = 5039

; Value: tlsbindaddr
; Section: general
; Since: 1.0
; Description: IP address to bind to
; Default: 0.0.0.0
tlsbindaddr = 0.0.0.0

; Value: tlscertfile
; Section: general
; Since: 1.0
; Description:
; Default: /tmp/asterisk.pem
;tlscertfile = /tmp/asterisk.pem

; Value: tlsprivatekey
; Section: general
; Since: 1.0
; Description:
; Default: /tmp/private.pem
;tlsprivatekey = /tmp/private.pem

; Value: tlscipher
; Section: general
; Since: 1.0
; Description:
; Default: 
;tlscipher =

; Value: allowmultiplelogin
; Section: general
; Since: 1.0
; Description: Multiple logins for accounts
;  When disabled, the manager rejects logins that are already
;  in use.
; Default: yes
allowmultiplelogin = yes

; Value: displayconnects
; Section: general
; Since: 1.0
; Description: Show when remote connections are established
; Default: yes
displayconnects = yes

; Value: timestampevents
; Section: general
; Since: 1.0
; Description: Add a Unix epoch to events
;  This does not affect action responses.
; Default: yes
timestampevents = yes

; Value: brokeneventsaction
; Section: general
; Since: 1.0
; Description: 
; Default: no
brokeneventsaction = no

; Value: channelvars
; Section: general
; Since: 1.0
; Description: 
; Default: 
;channelvars = var1,var2,var3

; Value: debug
; Section: general
; Since: 1.0
; Description: Enable AMI debugging
;  Also accessible through the 'manager debug' CLI command.
; Default: off
debug = off

; Value: authtimeout
; Section: general
; Since: 1.0
; Description: Number of seconds a client has to authenticate
;  If the client does not authenticate before this timeout expires,
;  the client will be disconnected.
; Default: 30
authtimeout = 30

; Value: authlimit
; Section: general
; Since: 1.0
; Description: Max number of unauthenticated sessions allowed
;  After the limit is reached, no more connections can be established.
; Default: 50
authlimit = 50

; Value: httptimeout
; Section: general
; Since: 1.0
; Description: 
; Default: 60
httptimeout = 60

See also