Include new README files in index
[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 security.txt            IMPORTANT INFORMATION ABOUT ASTERISK SECURITY
10 hardware.txt            Hardware supported by Asterisk
11
12 Configuration
13 -------------
14 configuration.txt       Features in the configuration parser
15 extensions.txt          Basics about the dialplan
16 extconfig.txt           How to use databases for configuration of Asterisk (ARA)
17 ip-tos.txt              About the IP Type Of Service settings
18 realtime.txt            The Asterisk Realtime Architecture - database support
19 freetds.txt             Information about the FreeTDS support
20 ael.txt                 Information about the Asterisk Extension Language
21
22 Misc
23 ----
24 PEERING                 The General Peering Agreement for Dundi
25 ajam.txt                About the HTTP-based manager interface
26 app_sms.txt             How to configure the SMS application
27 asterisk.conf.txt       Documentation of various options in asterisk.conf
28 callingpres.txt         Settings for Caller ID presentation
29 billing.txt             Call Data Record information
30 cliprompt.txt           How to change the Asterisk CLI prompt
31 dundi.txt               Dundi - a discovery protocol
32 enum.txt                Enum support in Asterisk
33 ices.txt                Integrating ICEcast streaming in Asterisk
34 jitterbuffer.txt        About the IAX2 jitterbuffer implementation
35 math.txt                About the math() application
36 mp3.txt                 About MP3 support in Asterisk
37 musiconhold-fpm.txt     Free Music On Hold music
38 mysql.txt               About MYSQL support in Asterisk
39 odbcstorage.txt         Voicemail storage of messages in UnixODBC
40 privacy.txt             Privacy enhancements in Asterisk
41 queuelog.txt            Agent and queue logging
42 channelvariables.txt    Channel variables
43 cdrdrivers.txt          About CDR storage in various databases (needs update)
44 asterisk-mib.txt        SNMP mib for Asterisk (net-snmp)
45 digium-mib.txt          SNMP mib for Asterisk (net-snmp)
46
47 Channel drivers
48 ---------------
49 misdn.txt               The mISDN channel driver for ISDN BRI cards
50 h323.txt                How to compile and configure the H.323 channel
51 chaniax.txt             About the IAX2 protocol support in Asterisk
52 localchannel.txt        The local channel is a "gosub" in the dialplan
53
54 Portability
55 -----------
56 cygwin.txt              Compiling Asterisk on CygWin platforms (Windows)
57
58 For developers
59 --------------
60 See http://www.asterisk.org/developers for more information
61
62 manager.txt             About the AMI - Asterisk Manager Interface
63                         for third party call control and PBX management
64 backtrace.txt           How to produce a backtrace when Asterisk crashes
65 CODING-GUIDELINES       Guidelines for developers
66 channels.txt            What is a channel?
67 externalivr.txt         Documentation of the protocol used in externalivr()
68 linkedlists.txt         How to develop linked lists in Asterisk (old)
69 iax.txt                 About the IAX protocol
70 apps.txt                About application development
71 model.txt               About the call model in Asterisk (old)
72 modules.txt             How Asterisk modules work