kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-02 19:16:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

README.md: Updates and Fixes

Browse Source 
* Outdated information has been removed.
* New links added.
* Placeholder added for link to change logs.

Going forward, the release process will create HTML versions of the README
and change log and will update the link in the README to the current
change log for the branch...

* In the development branches, the link will always point to the current
  release on GitHub.
* In the "releases/*" branches and the tarballs, the link will point to the
  ChangeLogs/ChangeLog-<version>.html file in the source directory.
* On the downloads website, the link will point to the
  ChangeLog-<version>.html file in the same directory.

Resolves: #1131
This commit is contained in:
George Joseph
2025-03-05 12:21:45 -07:00
parent 25aff1a887
commit dc5c545175
1 changed files with 88 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

234
README.md
View File

@@ -1,209 +1,151 @@
# The Asterisk(R) Open Source PBX # The Asterisk(R) Open Source PBX
```text
By Mark Spencer <markster@digium.com> and the Asterisk.org developer community.
Copyright (C) 2001-2025 Sangoma Technologies Corporation and other copyright holders.
``` ```
By Mark Spencer <markster@digium.com> and the Asterisk.org developer community.
Copyright (C) 2001-2025 Sangoma Technologies Corporation and other copyright holders.
```
## SECURITY ## SECURITY
It is imperative that you read and fully understand the contents of It is imperative that you read and fully understand the contents of
the security information document before you attempt to configure and run the security information document before you attempt to configure and run
an Asterisk server. an Asterisk server.
See [Important Security Considerations] for more information. See [Important Security Considerations](https://docs.asterisk.org/Deployment/Important-Security-Considerations) for more information.
## WHAT IS ASTERISK ? ## WHAT IS ASTERISK ?
Asterisk is an Open Source PBX and telephony toolkit. It is, in a Asterisk is an Open Source PBX and telephony toolkit. It is, in a
sense, middleware between Internet and telephony channels on the bottom, sense, middleware between Internet and telephony channels on the bottom,
and Internet and telephony applications at the top. However, Asterisk supports and Internet and telephony applications at the top. However, Asterisk supports
more telephony interfaces than just Internet telephony. Asterisk also has a more telephony interfaces than just Internet telephony. Asterisk also has a
vast amount of support for traditional PSTN telephony, as well. vast amount of support for traditional PSTN telephony, as well.
For more information on the project itself, please visit the Asterisk For more information on the project itself, please visit the [Asterisk
[home page] and the official [documentation]. In addition you'll find lots Home Page](https://www.asterisk.org) and the official
of information compiled by the Asterisk community at [voip-info.org]. [Asterisk Documentation](https://docs.asterisk.org).
There is a book on Asterisk published by O'Reilly under the Creative Commons
License. It is available in book stores as well as in a downloadable version on
the [asteriskdocs.org] web site.
## SUPPORTED OPERATING SYSTEMS ## SUPPORTED OPERATING SYSTEMS
### Linux ### Linux
The Asterisk Open Source PBX is developed and tested primarily on the The Asterisk Open Source PBX is developed and tested primarily on the
GNU/Linux operating system, and is supported on every major GNU/Linux GNU/Linux operating system, and is supported on every major GNU/Linux
distribution. distribution.
### Others ### Others
Asterisk has also been 'ported' and reportedly runs properly on other Asterisk has also been 'ported' and reportedly runs properly on other
operating systems as well, including Sun Solaris, Apple's Mac OS X, Cygwin, operating systems as well, Apple's Mac OS X, and the BSD variants.
and the BSD variants.
## GETTING STARTED ## GETTING STARTED
First, be sure you've got supported hardware (but note that you don't need Most users are using VoIP/SIP exclusively these days but if you need to
ANY special hardware, not even a sound card) to install and run Asterisk. interface to TDM or analog services or devices, be sure you've got supported
hardware.
Supported telephony hardware includes: Supported telephony hardware includes:
* All Analog and Digital Interface cards from [Sangoma] * All Analog and Digital Interface cards from Sangoma
* QuickNet Internet PhoneJack and LineJack * Any full duplex sound card supported by PortAudio
* any full duplex sound card supported by ALSA, OSS, or PortAudio
* any ISDN card supported by mISDN on Linux
* The Xorcom Astribank channel bank * The Xorcom Astribank channel bank
* VoiceTronix OpenLine products
### UPGRADING FROM AN EARLIER VERSION ### UPGRADING FROM AN EARLIER VERSION
If you are updating from a previous version of Asterisk, make sure you If you are updating from a previous version of Asterisk, make sure you
read the [UPGRADE.txt] file in the source directory. There are some files read the Change Logs.
and configuration options that you will have to change, even though we
made every effort possible to maintain backwards compatibility.
In order to discover new features to use, please check the configuration <!-- CHANGELOGS (the URL will change based on the location of this README) -->
examples in the [configs] directory of the source code distribution. For a [Change Logs](https://downloads.asterisk.org/pub/telephony/asterisk)
list of new features in this version of Asterisk, see the [CHANGES] file. <!-- END-CHANGELOGS -->
### NEW INSTALLATIONS ### NEW INSTALLATIONS
Ensure that your system contains a compatible compiler and development Ensure that your system contains a compatible compiler and development
libraries. Asterisk requires either the GNU Compiler Collection (GCC) version libraries. Asterisk requires either the GNU Compiler Collection (GCC) version
4.1 or higher, or a compiler that supports the C99 specification and some of 4.1 or higher, or a compiler that supports the C99 specification and some of
the gcc language extensions. In addition, your system needs to have the C the gcc language extensions. In addition, your system needs to have the C
library headers available, and the headers and libraries for ncurses. library headers available, and the headers and libraries for ncurses.
There are many modules that have additional dependencies. To see what There are many modules that have additional dependencies. To see what
libraries are being looked for, see `./configure --help`, or run libraries are being looked for, see `./configure --help`, or run
`make menuselect` to view the dependencies for specific modules. `make menuselect` to view the dependencies for specific modules.
On many distributions, these dependencies are installed by packages with names On many distributions, these dependencies are installed by packages with names
like 'glibc-devel', 'ncurses-devel', 'openssl-devel' and 'zlib-devel' like 'glibc-devel', 'ncurses-devel', 'openssl-devel' and 'zlib-devel'
or similar. or similar. The `contrib/scripts/install_prereq` script can be used to install
the dependencies for most Debian and Redhat based Linux distributions.
The script also handles SUSE, Arch, Gentoo, FreeBSD, NetBSD and OpenBSD but
those distributions mightnoit have complete support or they might be out of date.
So, let's proceed: So, let's proceed:
1. Read this file.
There are more documents than this one in the [doc] directory. You may also 1. Read the documentation.<br>
want to check the configuration files that contain examples and reference The [Asterisk Documentation](https://docs.asterisk.org) website has full
guides in the [configs] directory. information for building, installing, configuring and running Asterisk.
2. Run `./configure` 2. Run `./configure`<br>
Execute the configure script to guess values for system-dependent
Execute the configure script to guess values for system-dependent
variables used during compilation. If the script indicates that some required variables used during compilation. If the script indicates that some required
components are missing, you can run `./contrib/scripts/install_prereq install` components are missing, you can run `./contrib/scripts/install_prereq install`
to install the necessary components. Note that this will install all dependencies for every functionality of Asterisk. After running the script, you will need to install the necessary components. Note that this will install all dependencies
for every functionality of Asterisk. After running the script, you will need
to rerun `./configure`. to rerun `./configure`.
3. Run `make menuselect` _\[optional]_ 3. Run `make menuselect`<br>
This is needed if you want to select the modules that will be compiled and to
This is needed if you want to select the modules that will be compiled and to
check dependencies for various optional modules. check dependencies for various optional modules.
4. Run `make` 4. Run `make`<br>
Assuming the build completes successfully: Assuming the build completes successfully:
5. Run `make install` 5. Run `make install`<br>
If this is your first time working with Asterisk, you may wish to install
If this is your first time working with Asterisk, you may wish to install
the sample PBX, with demonstration extensions, etc. If so, run: the sample PBX, with demonstration extensions, etc. If so, run:
6. Run `make samples` 6. Run `make samples`<br>
Doing so will overwrite any existing configuration files you have installed.
Doing so will overwrite any existing configuration files you have installed. 7. Finally, you can launch Asterisk in the foreground mode (not a daemon) with
`asterisk -vvvc`<br>
7. Finally, you can launch Asterisk in the foreground mode (not a daemon) with: You'll see a bunch of verbose messages fly by your screen as Asterisk
```
# asterisk -vvvc
```
You'll see a bunch of verbose messages fly by your screen as Asterisk
initializes (that's the "very very verbose" mode). When it's ready, if initializes (that's the "very very verbose" mode). When it's ready, if
you specified the "c" then you'll get a command line console, that looks you specified the "c" then you'll get a command line console, that looks
like this: like this:<br>
``` `*CLI>`<br>
*CLI> You can type `core show help` at any time to get help with the system. For help
``` with a specific command, type `core show help <command>`.
You can type "core show help" at any time to get help with the system. For help
with a specific command, type "core show help <command>". To start the PBX using
your sound card, you can type "console dial" to dial the PBX. Then you can use
"console answer", "console hangup", and "console dial" to simulate the actions
of a telephone. Remember that if you don't have a full duplex sound card
(and Asterisk will tell you somewhere in its verbose messages if you do/don't)
then it won't work right (not yet).
"man asterisk" at the Unix/Linux command prompt will give you detailed `man asterisk` at the Unix/Linux command prompt will give you detailed
information on how to start and stop Asterisk, as well as all the command information on how to start and stop Asterisk, as well as all the command
line options for starting Asterisk. line options for starting Asterisk.
Feel free to look over the configuration files in `/etc/asterisk`, where you
will find a lot of information about what you can do with Asterisk.
### ABOUT CONFIGURATION FILES ### ABOUT CONFIGURATION FILES
All Asterisk configuration files share a common format. Comments are All Asterisk configuration files share a common format. Comments are
delimited by ';' (since '#' of course, being a DTMF digit, may occur in delimited by `;` (since `#` of course, being a DTMF digit, may occur in
many places). A configuration file is divided into sections whose names many places). A configuration file is divided into sections whose names
appear in []'s. Each section typically contains two types of statements, appear in `[]`'s. Each section typically contains statements in the form
those of the form 'variable = value', and those of the form 'object => `variable = value` although you may see `variable => value` in older samples.
parameters'. Internally the use of '=' and '=>' is exactly the same, so
they're used only to help make the configuration file easier to
understand, and do not affect how it is actually parsed.
Entries of the form 'variable=value' set the value of some parameter in
asterisk. For example, in [chan_dahdi.conf], one might specify:
```
switchtype=national
```
In order to indicate to Asterisk that the switch they are connecting to is
of the type "national". In general, the parameter will apply to
instantiations which occur below its specification. For example, if the
configuration file read:
```
switchtype = national
channel => 1-4
channel => 10-12
switchtype = dms100
channel => 25-47
```
The "national" switchtype would be applied to channels one through
four and channels 10 through 12, whereas the "dms100" switchtype would
apply to channels 25 through 47.
The "object => parameters" instantiates an object with the given
parameters. For example, the line "channel => 25-47" creates objects for
the channels 25 through 47 of the card, obtaining the settings
from the variables specified above.
### SPECIAL NOTE ON TIME ### SPECIAL NOTE ON TIME
Those using SIP phones should be aware that Asterisk is sensitive to Those using SIP phones should be aware that Asterisk is sensitive to
large jumps in time. Manually changing the system time using date(1) large jumps in time. Manually changing the system time using date(1)
(or other similar commands) may cause SIP registrations and other (or other similar commands) may cause SIP registrations and other
internal processes to fail. If your system cannot keep accurate time internal processes to fail. For this reason, you should always use
by itself use [NTP] to keep the system clock a time synchronization package to keep your system time accurate.
synchronized to "real time". NTP is designed to keep the system clock All OS/distributions make one or more of the following packages
synchronized by speeding up or slowing down the system clock until it available:
is synchronized to "real time" rather than by jumping the time and
causing discontinuities. Most Linux distributions include precompiled
versions of NTP. Beware of some time synchronization methods that get
the correct real time periodically and then manually set the system
clock.
Apparent time changes due to daylight savings time are just that, * ntpd/ntpsec
apparent. The use of daylight savings time in a Linux system is * chronyd
purely a user interface issue and does not affect the operation of the * systemd-timesyncd
Linux kernel or Asterisk. The system clock on Linux kernels operates
on UTC. UTC does not use daylight savings time.
Also note that this issue is separate from the clocking of TDM Be sure to install and configure one (and only one) of them.
channels, and is known to at least affect SIP registrations.
### FILE DESCRIPTORS ### FILE DESCRIPTORS
Depending on the size of your system and your configuration, Depending on the size of your system and your configuration,
Asterisk can consume a large number of file descriptors. In UNIX, Asterisk can consume a large number of file descriptors. In UNIX,
file descriptors are used for more than just files on disk. File file descriptors are used for more than just files on disk. File
descriptors are also used for handling network communication descriptors are also used for handling network communication
@@ -211,7 +153,7 @@ descriptors are also used for handling network communication
digital trunk hardware). Asterisk accesses many on-disk files for digital trunk hardware). Asterisk accesses many on-disk files for
everything from configuration information to voicemail storage. everything from configuration information to voicemail storage.
Most systems limit the number of file descriptors that Asterisk can Most systems limit the number of file descriptors that Asterisk can
have open at one time. This can limit the number of simultaneous have open at one time. This can limit the number of simultaneous
calls that your system can handle. For example, if the limit is set calls that your system can handle. For example, if the limit is set
at 1024 (a common default value) Asterisk can handle approximately 150 at 1024 (a common default value) Asterisk can handle approximately 150
@@ -220,8 +162,9 @@ follow the instructions for your system below:
#### PAM-BASED LINUX SYSTEM #### PAM-BASED LINUX SYSTEM
If your system uses PAM (Pluggable Authentication Modules) edit If your system uses PAM (Pluggable Authentication Modules) edit
`/etc/security/limits.conf`. Add these lines to the bottom of the file: `/etc/security/limits.conf`. Add these lines to the bottom of the file:
```text ```text
root soft nofile 4096 root soft nofile 4096
root hard nofile 8196 root hard nofile 8196
@@ -234,20 +177,22 @@ these changes to take effect.
#### GENERIC UNIX SYSTEM #### GENERIC UNIX SYSTEM
If there are no instructions specifically adapted to your system If there are no instructions specifically adapted to your system
above you can try adding the command `ulimit -n 8192` to the script above you can try adding the command `ulimit -n 8192` to the script
that starts Asterisk. that starts Asterisk.
## MORE INFORMATION ## MORE INFORMATION
See the [doc] directory for more documentation on various features. Visit the [Asterisk Documentation](https://docs.asterisk.org) website
Again, please read all the configuration samples that include documentation for more documentation on various features and please read all the
on the configuration options. configuration samples that include documentation on the configuration options.
Finally, you may wish to join the
[Asterisk Community Forums](https://community.asterisk.org)
Finally, you may wish to visit the [support] site and join the [mailing
list] if you're interested in getting more information.
Welcome to the growing worldwide community of Asterisk users! Welcome to the growing worldwide community of Asterisk users!
``` ```
Mark Spencer, and the Asterisk.org development community Mark Spencer, and the Asterisk.org development community
``` ```
@@ -256,17 +201,12 @@ Welcome to the growing worldwide community of Asterisk users!
Asterisk is a trademark of Sangoma Technologies Corporation Asterisk is a trademark of Sangoma Technologies Corporation
[home page]: https://www.asterisk.org \[[Sangoma](https://www.sangoma.com/)\]
[support]: https://www.asterisk.org/support \[[Home Page](https://www.asterisk.org)\]
[documentation]: https://docs.asterisk.org/ \[[Support](https://www.asterisk.org/support)\]
[mailing list]: http://lists.digium.com/mailman/listinfo/asterisk-users \[[Documentation](https://docs.asterisk.org)\]
[chan_dahdi.conf]: configs/samples/chan_dahdi.conf.sample \[[Community Forums](https://community.asterisk.org)\]
[voip-info.org]: http://www.voip-info.org/wiki-Asterisk \[[Release Notes](https://github.com/asterisk/asterisk/releases)\]
[asteriskdocs.org]: http://www.asteriskdocs.org \[[Security](https://docs.asterisk.org/Deployment/Important-Security-Considerations/)\]
[NTP]: http://www.ntp.org/ \[[Mailing List Archive](https://lists.digium.com)\]
[Sangoma]: https://www.sangoma.com/
[UPGRADE.txt]: UPGRADE.txt
[CHANGES]: CHANGES
[configs]: configs
[doc]: doc
[Important Security Considerations]: https://docs.asterisk.org/Deployment/Important-Security-Considerations/