Add missing documentation
[asterisk/asterisk.git] / doc / README.asterisk.conf
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 directoriess 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 console= yes | no       ; Console mode (-c)
46 highpriority = yes | no ; Execute with high priority (-p)
47 initcrypto = yes | no   ; Initialize crypto at startup (-i)
48 nocolor = yes | no      ; Disable ANSI colors (-n)
49 dumpcore = yes | no     ; Dump core on failure (-g)
50 quiet = yes | no        ; Run quietly (-q)
51 timestamp = yes | no    ; Force timestamping on log entries to console (-T)
52 execincludes = yes | no ; Allow #exec entries in configuration files
53 dontwarn = yes | no     ; Don't over-inform the Asterisk sysadm, he's a guru
54 transcode_via_sln = yes | no ; Build transcode paths via SLINEAR
55 maxcalls = 255          ; The maximum number of concurrent calls you want to allow 
56 maxload = 1.0           ; The maximum load average we accept calls for
57                 
58 ;This option has no command line equivalent
59 cache_record_files = yes | no   ; Cache record() files in another directory until                               completion record_cache_dir = <dir>
60
61 [files]
62 ; Changing the following lines may compromise your security
63 ; Asterisk.ctl is the pipe that is used to connect the remote CLI
64 ; (asterisk -r) to Asterisk. Changing these settings change the
65 ; permissions and ownership of this file. 
66 ; The file is created when Asterisk starts, in the "astrundir" above.
67
68 ;astctlpermissions = 0660
69 ;astctlowner = root
70 ;astctlgroup = asterisk
71 ;astctl = asterisk.ctl