Fix escaping and some of the formattting (closes issue #10285)
[asterisk/asterisk.git] / doc / tex / asterisk-conf.tex
1 \subsubsection{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 \begin{verbatim}
9 [directories]
10 ; Make sure these directories have the right permissions if not
11 ; running Asterisk as root 
12
13 ; Where the configuration files (except for this one) are located
14 astetcdir => /etc/asterisk
15
16 ; Where the Asterisk loadable modules are located
17 astmoddir => /usr/lib/asterisk/modules
18
19 ; Where additional 'library' elements (scripts, etc.) are located
20 astvarlibdir => /var/lib/asterisk
21
22 ; Where AGI scripts/programs are located
23 astagidir => /var/lib/asterisk/agi-bin
24
25 ; Where spool directories are located
26 ; Voicemail, monitor, dictation and other apps will create files here
27 ; and outgoing call files (used with pbx_spool) must be placed here
28 astspooldir => /var/spool/asterisk
29
30 ; Where the Asterisk process ID (pid) file should be created
31 astrundir => /var/run/asterisk
32
33 ; Where the Asterisk log files should be created
34 astlogdir => /var/log/asterisk
35
36
37 [options]
38 ;Under "options" you can enter configuration options
39 ;that you also can set with command line options
40
41 ; Verbosity level for logging (-v)
42 verbose = 0
43
44 ; Debug: "No" or value (1-4)
45 debug = 3                                       
46
47 ; Background execution disabled (-f)
48 nofork=yes | no                                 
49
50 ; Always background, even with -v or -d (-F)
51 alwaysfork=yes | no
52
53 ; Console mode (-c)
54 console= yes | no
55
56 ; Execute with high priority (-p)
57 highpriority = yes | no
58
59 ; Initialize crypto at startup (-i)
60 initcrypto = yes | no
61
62 ; Disable ANSI colors (-n)
63 nocolor = yes | no
64
65 ; Dump core on failure (-g)
66 dumpcore = yes | no
67
68 ; Run quietly (-q)
69 quiet = yes | no
70
71 ; Force timestamping in CLI verbose output (-T)
72 timestamp = yes | no
73
74 ; User to run asterisk as (-U) NOTE: will require changes to
75 ; directory and device permissions
76 runuser = asterisk                              
77
78 ; Group to run asterisk as (-G)
79 rungroup = asterisk
80
81 ; Enable internal timing support (-I)
82 internal_timing = yes | no
83
84 ; These options have no command line equivalent
85
86 ; Cache record() files in another directory until completion
87 cache_record_files = yes | no                   
88 record_cache_dir = <dir>
89
90 ; Build transcode paths via SLINEAR
91 transcode_via_sln = yes | no                    
92
93 ; send SLINEAR silence while channel is being recorded
94 transmit_silence_during_record = yes | no
95
96 ; The maximum load average we accept calls for
97 maxload = 1.0
98
99 ; The maximum number of concurrent calls you want to allow
100 maxcalls = 255 
101
102 ; Stop accepting calls when free memory falls below this amount specified in MB
103 minmemfree = 256
104
105 ; Allow #exec entries in configuration files
106 execincludes = yes | no
107
108 ; Don't over-inform the Asterisk sysadm, he's a guru
109 dontwarn = yes | no
110
111 ; System name. Used to prefix CDR uniqueid and to fill \${SYSTEMNAME}
112 systemname = <a_string>
113
114 ; Should language code be last component of sound file name or first?
115 ; when off, sound files are searched as <path>/<lang>/<file>
116 ; when on, sound files are search as <lang>/<path>/<file>
117 ; (only affects relative paths for sound files)
118 languageprefix = yes | no                       
119
120
121 [files]
122 ; Changing the following lines may compromise your security
123 ; Asterisk.ctl is the pipe that is used to connect the remote CLI
124 ; (asterisk -r) to Asterisk. Changing these settings change the
125 ; permissions and ownership of this file. 
126 ; The file is created when Asterisk starts, in the "astrundir" above.
127
128 ;astctlpermissions = 0660
129 ;astctlowner = root
130 ;astctlgroup = asterisk
131 ;astctl = asterisk.ctl
132
133 \end{verbatim}