add some basic documentation about asterisk.conf (bug #4758, rewritten)

git-svn-id: http://svn.digium.com/svn/asterisk/trunk@6211 f38db490-d61c-443f-a65b-d21fe96a405b

1 files changed, 35 insertions, 0 deletions

diff --git a/doc/README.asterisk.conf b/doc/README.asterisk.conf
new file mode 100755
index 000000000..48da24b91
--- /dev/null
+++ b/doc/README.asterisk.conf
@@ -0,0 +1,35 @@
+Asterisk Main Configuration File
+-----------------------------------------------------
+Below is a sample of the main Asterisk configuration file,
+asterisk.conf. Note that this file is _not_ provided in
+sample form, because the Makefile creates it when needed
+and does not touch it when it already exists.
+
+---------------
+
+[directories]
+; Make sure these directoriess have the right permissions if not
+; running Asterisk as root 
+
+; Where the configuration files (except for this one) are located
+astetcdir => /etc/asterisk
+
+; Where the Asterisk loadable modules are located
+astmoddir => /usr/lib/asterisk/modules
+
+; Where additional 'library' elements (scripts, etc.) are located
+astvarlibdir => /var/lib/asterisk
+
+; Where AGI scripts/programs are located
+astagidir => /var/lib/asterisk/agi-bin
+
+; Where spool directories are located
+; Voicemail, monitor, dictation and other apps will create files here
+; and outgoing call files (used with pbx_spool) must be placed here
+astspooldir => /var/spool/asterisk
+
+; Where the Asterisk process ID (pid) file should be created
+astrundir => /var/run/asterisk
+
+; Where the Asterisk log files should be created
+astlogdir => /var/log/asterisk