Document new configuration option.
[asterisk/asterisk.git] / doc / asterisk-conf.txt
1 Asterisk Main Configuration File
2 -----------------------------------------------------
3 Below is a sample of the main Asterisk configuration file,
4 asterisk.conf. Note that this file is _not_ provided in
5 sample form, because the Makefile creates it when needed
6 and does not touch it when it already exists.
7
8 ---------------
9
10 [directories]
11 ; Make sure these directories have the right permissions if not
12 ; running Asterisk as root 
13
14 ; Where the configuration files (except for this one) are located
15 astetcdir => /etc/asterisk
16
17 ; Where the Asterisk loadable modules are located
18 astmoddir => /usr/lib/asterisk/modules
19
20 ; Where additional 'library' elements (scripts, etc.) are located
21 astvarlibdir => /var/lib/asterisk
22
23 ; Where AGI scripts/programs are located
24 astagidir => /var/lib/asterisk/agi-bin
25
26 ; Where spool directories are located
27 ; Voicemail, monitor, dictation and other apps will create files here
28 ; and outgoing call files (used with pbx_spool) must be placed here
29 astspooldir => /var/spool/asterisk
30
31 ; Where the Asterisk process ID (pid) file should be created
32 astrundir => /var/run/asterisk
33
34 ; Where the Asterisk log files should be created
35 astlogdir => /var/log/asterisk
36
37
38 [options]
39 ;Under "options" you can enter configuration options
40 ;that you also can set with command line options
41
42 verbose = 0                                     ; Verbosity level for logging (-v)
43 debug = 3                                       ; Debug: "No" or value (1-4)
44 nofork=yes | no                                 ; Background execution disabled (-f)
45 alwaysfork=yes | no                             ; Always background, even with -v or -d (-F)
46 console= yes | no                               ; Console mode (-c)
47 highpriority = yes | no                         ; Execute with high priority (-p)
48 initcrypto = yes | no                           ; Initialize crypto at startup (-i)
49 nocolor = yes | no                              ; Disable ANSI colors (-n)
50 dumpcore = yes | no                             ; Dump core on failure (-g)
51 quiet = yes | no                                ; Run quietly (-q)
52 timestamp = yes | no                            ; Force timestamping in CLI verbose output (-T)
53 runuser = asterisk                              ; User to run asterisk as (-U) NOTE: will require changes to
54                                                 ; directory and device permissions
55 rungroup = asterisk                             ; Group to run asterisk as (-G)
56 internal_timing = yes | no                      ; Enable internal timing support (-I)
57
58 ;These options have no command line equivalent
59 cache_record_files = yes | no                   ; Cache record() files in another directory until completion
60 record_cache_dir = <dir>
61 transcode_via_sln = yes | no                    ; Build transcode paths via SLINEAR
62 transmit_silence_during_record = yes | no       ; send SLINEAR silence while channel is being recorded
63 maxload = 1.0                                   ; The maximum load average we accept calls for
64 maxcalls = 255                                  ; The maximum number of concurrent calls you want to allow 
65 execincludes = yes | no                         ; Allow #exec entries in configuration files
66 dontwarn = yes | no                             ; Don't over-inform the Asterisk sysadm, he's a guru
67 systemname = <a_string>                         ; System name. Used to prefix CDR uniqueid and to fill ${SYSTEMNAME}
68 languageprefix = yes | no                       ; Should language code be last component of sound file name or first?
69                                                 ; when off, sound files are searched as <path>/<lang>/<file>
70                                                 ; when on, sound files are search as <lang>/<path>/<file>
71                                                 ; (only affects relative paths for sound files)
72 maxlimit = <value>                              ; Maximum number open files for the Asterisk process
73
74 [files]
75 ; Changing the following lines may compromise your security
76 ; Asterisk.ctl is the pipe that is used to connect the remote CLI
77 ; (asterisk -r) to Asterisk. Changing these settings change the
78 ; permissions and ownership of this file. 
79 ; The file is created when Asterisk starts, in the "astrundir" above.
80
81 ;astctlpermissions = 0660
82 ;astctlowner = root
83 ;astctlgroup = asterisk
84 ;astctl = asterisk.ctl