- Adding a doc/00README.1st with an INDEX over README files
[asterisk/asterisk.git] / doc / 00README.1st
1 Files in the /doc directory:
2 ----------------------------
3 In addition to these files, there is a lot of documentation of various
4 configuration options in the sample configuration files, in the /configs
5 directory of your source code
6
7 Start here
8 ----------
9 README.security         IMPORTANT INFORMATION ABOUT ASTERISK SECURITY
10 README.hardware         Hardware supported by Asterisk
11
12 Configuration
13 -------------
14 README.configuration    Features in the configuration parser
15 README.extensions       Basics about the dialplan
16 README.extconfig        How to use databases for configuration of Asterisk (ARA)
17 README.realtime         The Asterisk Realtime Architecture - database support
18 README.tds              Information about the FreeTDS support
19 README.ael              Information about the Asterisk Extension Language
20
21 Misc
22 ----
23 PEERING                 The General Peering Agreement for Dundi
24 README.app_sms          How to configure the SMS application
25 README.asterisk.conf    Documentation of various options in asterisk.conf
26 README.callingpres      Settings for Caller ID presentation
27 README.cdr              Call Data Record information
28 README.cliprompt        How to change the Asterisk CLI prompt
29 README.dundi            Dundi - a discovery protocol
30 README.enum             Enum support in Asterisk
31 README.ices             Integrating ICEcast streaming in Asterisk
32 README.jitterbuffer     About the IAX2 jitterbuffer implementation
33 README.math             About the math() application
34 README.mp3              About MP3 support in Asterisk
35 README.musiconhold-fpm  Free Music On Hold music
36 README.mysql            About MYSQL support in Asterisk
37 README.odbcstorage      Voicemail storage of messages in UnixODBC
38 README.privacy          Privacy enhancements in Asterisk
39 README.queuelog         Agent and queue logging
40 README.variables        Channel variables
41 cdr.txt                 About CDR storage in various databases (needs update)
42
43 Channel drivers
44 ---------------
45 README.misdn
46 README.h323             How to compile and configure the H.323 channel
47 README.iax              About the IAX2 protocol support in Asterisk
48 README.localchannel     The local channel is a "gosub" in the dialplan
49
50 Portability
51 -----------
52 README.cygwin           Compiling Asterisk on CygWin platforms (Windows)
53
54 For developers
55 --------------
56 See http://www.asterisk.org/developers for more information
57
58 README.manager          About the AMI - Asterisk Manager Interface
59                         for third party call control and PBX management
60 README.backtrace        How to produce a backtrace when Asterisk crashes
61 CODING-GUIDELINES       Guidelines for developers
62 README.channels         What is a channel?
63 README.externalivr      Documentation of the protocol used in externalivr()
64 README.linkedlists      How to develop linked lists in Asterisk (old)
65 iax.txt                 About the IAX protocol
66 apps.txt                About application development
67 model.txt               About the call model in Asterisk (old)
68 modules.txt             How Asterisk modules work