aboutsummaryrefslogtreecommitdiffstats
path: root/doc/00README.1st
blob: a530922e63c0689ac160c8202a3b8bdddc021d1c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
Files in the /doc directory:
----------------------------
In addition to these files, there is a lot of documentation of various
configuration options in the sample configuration files, in the /configs
directory of your source code

Start here
----------
README.security		IMPORTANT INFORMATION ABOUT ASTERISK SECURITY
README.hardware		Hardware supported by Asterisk

Configuration
-------------
README.configuration	Features in the configuration parser
README.extensions	Basics about the dialplan
README.extconfig	How to use databases for configuration of Asterisk (ARA)
README.realtime		The Asterisk Realtime Architecture - database support
README.tds		Information about the FreeTDS support
README.ael		Information about the Asterisk Extension Language

Misc
----
PEERING			The General Peering Agreement for Dundi
README.app_sms		How to configure the SMS application
README.asterisk.conf	Documentation of various options in asterisk.conf
README.callingpres	Settings for Caller ID presentation
README.cdr		Call Data Record information
README.cliprompt	How to change the Asterisk CLI prompt
README.dundi		Dundi - a discovery protocol
README.enum		Enum support in Asterisk
README.ices		Integrating ICEcast streaming in Asterisk
README.jitterbuffer	About the IAX2 jitterbuffer implementation
README.math		About the math() application
README.mp3		About MP3 support in Asterisk
README.musiconhold-fpm	Free Music On Hold music
README.mysql		About MYSQL support in Asterisk
README.odbcstorage	Voicemail storage of messages in UnixODBC
README.privacy		Privacy enhancements in Asterisk
README.queuelog		Agent and queue logging
README.variables	Channel variables
cdr.txt			About CDR storage in various databases (needs update)

Channel drivers
---------------
README.misdn
README.h323		How to compile and configure the H.323 channel
README.iax		About the IAX2 protocol support in Asterisk
README.localchannel	The local channel is a "gosub" in the dialplan

Portability
-----------
README.cygwin		Compiling Asterisk on CygWin platforms (Windows)

For developers
--------------
See http://www.asterisk.org/developers for more information

README.manager		About the AMI - Asterisk Manager Interface
			for third party call control and PBX management
README.backtrace	How to produce a backtrace when Asterisk crashes
CODING-GUIDELINES	Guidelines for developers
README.channels		What is a channel?
README.externalivr	Documentation of the protocol used in externalivr()
README.linkedlists	How to develop linked lists in Asterisk (old)
iax.txt			About the IAX protocol
apps.txt		About application development
model.txt		About the call model in Asterisk (old)
modules.txt		How Asterisk modules work