* 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
list of new features in this version of Asterisk, see the [CHANGES] file.
<!-- END-CHANGELOGS -->
### NEW INSTALLATIONS
### NEW INSTALLATIONS
@ -79,127 +72,76 @@ libraries are being looked for, see `./configure --help`, or run
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
want to check the configuration files that contain examples and reference
guides in the [configs] directory.
2. Run `./configure`
1. Read the documentation.<br>
The [Asterisk Documentation](https://docs.asterisk.org) website has full
information for building, installing, configuring and running Asterisk.
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:
7. Finally, you can launch Asterisk in the foreground mode (not a daemon) with
```
`asterisk -vvvc`<br>
# asterisk -vvvc
```
You'll see a bunch of verbose messages fly by your screen as Asterisk
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
`man asterisk` at the Unix/Linux command prompt will give you detailed
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
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
* ntpd/ntpsec
versions of NTP. Beware of some time synchronization methods that get
* chronyd
the correct real time periodically and then manually set the system
* systemd-timesyncd
clock.
Be sure to install and configure one (and only one) of them.
Apparent time changes due to daylight savings time are just that,
apparent. The use of daylight savings time in a Linux system is
purely a user interface issue and does not affect the operation of the
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
channels, and is known to at least affect SIP registrations.
### FILE DESCRIPTORS
### FILE DESCRIPTORS
@ -222,6 +164,7 @@ follow the instructions for your system below:
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
@ -240,14 +183,16 @@ 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
George Joseph
2 months ago