Asterisk currently contains two SIP stacks: the original chan_sip SIP channel driver which is a complete standalone implementation, has been present in all previous releases of Asterisk and no longer receives core support, and the newer chan_pjsip SIP stack that is based on Teluu's "pjproject" SIP stack. While the pjproject stack allows us to move a significant amount of code out of Asterisk, it is a separate, actively maintained, library that we integrate very tightly to. This presents challenges in making sure that the versions of Asterisk and pjproject currently installed on a system are compatible. For this reason, we've elected to "bundle" a stable, tested version of pjproject with the Asterisk distribution and integrate it into the Asterisk build process. This does not prevent you from using an external pjproject installation but it will not be supported by the Asterisk team. See PJSIP-pjproject below for more info.
Using the Bundled Version of pjproject
Beginning with Asterisk 13.8.0, a stable version of pjproject is included in Asterisk's ./third-party directory and is enabled with the
--with-pjproject-bundled option to
./configure. Beginning with Asterisk 15.0.0, it is enabled by default but can be disabled with the
--without-pjproject-bundled option to
The actual pjproject source code is NOT distributed with Asterisk. Instead the Asterisk build process downloads the official pjproject tarball then patches, configures and builds pjproject when you build Asterisk.
Why use the bundled version?
- Predictability: When built with the bundled pjproject, you're always certain of the version you're running against, no matter where it's installed.
- Scalability: The default pjproject configuration is optimized for client applications. The bundled version's configuration is optimized for server use.
- Usability: Several feature patches, which have been submitted upstream to pjproject but not yet released, are usually included in the bundled version.
Safety: If a security or critical issue is identified in pjproject, it can be patched and made available with a new release of Asterisk instead of having to waiting for a new release of pjproject.
Maintainability: You don't need to build and install separate packages.
Supportability: When asking others for help, there's no question about which version of pjproject you're using and what options it was compiled with.
- Debugability: The Asterisk
MALLOC_DEBUGcompile flags, which are essential for troubleshooting crashes and deadlocks, are automatically passed to the pjproject build process.
- Compatibility: This is especially important from a development perspective because it means we can be sure that new pjproject APIs that have been introduced or old ones that have been deprecated, are handled and tested appropriately in Asterisk.
- Reliability: You can be sure that Asterisk was tested against the bundled version.
./contrib/scripts/install_prereq. Building the bundled pjproject requires the python development libraries which install_prereq installs. All you have to do now is add the
--with-pjproject-bundled option to your Asterisk
./configure command line and remove any other
--with-pjproject option you may have specified.
The configure and make processes will download the correct version of pjproject, patch it, configure it, build it, and finally link Asterisk to it statically. No changes in runtime configuration are required. You can leave your system-installed version of pjproject in place if needed. Once compiled with the
--with-pjproject-bundled option, Asterisk will ignore any other installed versions of pjproject.
Using the bundled version of pjproject doesn't necessarily mean you need internet access to download the pjproject tarball every time you build. There are 2 ways to specify an alternate location from which to retrieve it. First, assuming version 2.6 of pjproject is needed and
/tmp/downloads is the directory you're going to save to, download the following files to the local directory:
It's important that both files be named
Now perform either of the following 2 steps:
- Run ./configure with the
--with-externals-cache=/tmp/downloadsoption. ./configure will check there first and only download if the files aren't already there or the tarball checksum doesn't match what's in the md5 file. This is similar to the
--with-sounds-cacheoption. BTW, the
--with-externals-cachemechanism works for the precompiled codecs and the Digium Phone Module for Asterisk as well. As of Asterisk 13.18, 14.7 and 15.0, the
--with-download-cacheoption can be used to specify both the externals and sounds cache directory.
- Set the
PJPROJECT_URLenvironment variable to any valid URL (including file:// URLs) where
./configurecan find the tarball and checksum files. The variable can be set in your environment and exported or specified directly on the
./configurecommand line. As of Asterisk 13.18, 14.7 and 15.0, the
AST_DOWNLOAD_CACHEenvironment variable can be used to specify both the externals and sounds cache directory.
- Run ./configure with the
Building and Installing pjproject from Source
Installing pjproject from source or from packages is no longer a supported configuration for Asterisk versions that contain the bundled version of pjproject. Reports of pjproject-related Asterisk issues may only be made against the bundled version. The bundled version inherits flags like DONT_OPTIMIZE and MALLOC_DEBUG from Asterisk which allows us to accurately diagnose issues across both Asterisk and pjproject.
Despite efforts to maintain backwards compatibility, some changes to Asterisk require a particular version of pjproject (or above) to be installed. For instance, earlier releases of pjproject cannot build shared object libraries, so some changes were required in order to use it with Asterisk 12. As such, Asterisk requires a pjproject version that is the same version of pjproject that is bundled with Asterisk, or no more than 4 versions behind. Alternatively, you may be able to find an Asterisk compatible version of pjproject available on github , or - depending on your Linux distribution - available as a package.
Earlier versions of pjproject downloaded from www.pjsip.org will not work with Asterisk 12 or greater.
If you have previously installed a version of pjproject, you must remove that version of pjproject prior to building and installing the Asterisk 12+ compatible version of pjproject. See Uninstalling pjproject for more information.
Obtaining pjproject from Teluu:
wget to pull the latest version (currently 2.6) from
www.pjsip.org. Note that the instructions assume that this is 2.6; for the latest version, refer to
Obtaining the latest pjproject from the svn repo:
svn to install the latest version from www.pjsip.org.
Obtaining (old asterisk) pjproject from the github repo:
If you do not have git, install git on your local machine.
Downloading and installing
git is beyond the scope of these instructions, but for Debian/Ubuntu systems, it should be as simple as:
And for RedHat/CentOS systems:
Checkout the Asterisk 12-compatible pjproject from the Asterisk github repo:
And that's it!
Building and Installing pjproject
The first step in building and installing pjproject is configuring it using configure. For Asterisk, this is arguably the most important step in this process. pjproject embeds a number of third party libraries which can conflict with versions of those libraries that may already be installed on your system. Asterisk will not use the embedded third party libraries within pjproject. As an example, if you are going to build the res_srtp module in Asterisk, then you must specify "--with-external-srtp" when configuring pjproject to point to an external srtp library.
Additionally, Asterisk REQUIRES two or three options to be passed to configure:
--enable-shared- Instruct pjproject to build shared object libraries. Asterisk will only use shared objects from pjproject.
--prefix- Specify root install directory for pjproject. This will be dependent on your distribution of Linux; typically this is
/usrfor most systems. The default is
--libdir- Specify the installation location for object code libraries. This may need to be set to
/usr/lib64for some 64-bit systems such as CentOS.
Failure to build Asterisk with shared pjproject object libraries WILL result in seemingly random crashes. For Asterisk to work properly with pjproject, pjproject MUST be built with shared object libraries.
Users who expect to deal with Contact URIs longer than 256 characters or hostnames longer than 128 characters should set
- IPv6 support in pjproject is, by default, disabled. To enable it, set
- The default configuration of pjproject enables "assert" functions which can cause Asterisk to crash unexpectedly. To disable the asserts, set
- The default number of TCP/TLS incoming connections allowed is 64. If you plan on having more than that you'll need to set
PJ_IOQUEUE_MAX_HANDLESto the new limit.
With the exception of
PJ_IOQUEUE_MAX_HANDLES, the options can be set in
CFLAGS and passed to configure as follows: '.
/configure CFLAGS="-DNDEBUG=1 -DPJ_HAS_IPV6=1"', etc. A better way is to create or edit the
pjlib/include/pj/config_site.h file and set them all there. You should use the bundled version of the
config_site.h file in
third-party/pjproject/patches as a starting point. Below is a copy of the file at the time of this writing.
Other common configure options needed for pjproject are listed below:
|libspeex shared objects||Make sure that the library development headers are accessible from pjproject. The CFLAGS and LDFLAGS environment variables may be used to set the include/lib paths.|
|libsrtp shared objects||Make sure that the library development headers are accessible from pjproject. The CFLAGS and LDFLAGS environment variables may be used to set the include/lib paths.|
|GSM codec||Make sure that the library development headers are accessible from pjproject. The CFLAGS and LDFLAGS environment variables may be used to set the include/lib paths.|
|Disable sound||Let Asterisk perform sound manipulations.|
Let Asterisk perform resample operations.
|Disable video||Disable video support in pjproject's media libraries. This is not used by Asterisk.|
|Disable AMR||--disable-opencore-amr||Disable AMR codec support. This is not used by Asterisk|
These are some of the more common options used to disable third party libraries in pjproject. However, other options may be needed depending on your system - see
Now that you understand the pjproject configure options available, change directories to the pjproject source directory:
In the pjproject source directory, run the configure script with the options needed for your system:
A few recommended options are shown. That includes setting a couple important CFLAGS, -O2 for common optimizations and -DNDEBUG to disable debugging code and assertions.
Update shared library links.
Verify that pjproject has been installed in the target location by looking for, and finding the various pjproject modules:
Finally, verify that Asterisk detects the pjproject libraries. In your Asterisk source directory:
- Browse to the Resource Modules category and verify that the
res_pjsipmodules are enabled:
- You're all done! Now, build and install Asterisk as your normally would.
If you need pjsua (for the testsuite, for example), then you may also need to take a look at Installing the Asterisk Test Suite#pjsua_installationPJSUAInstallation to set that up externally as well.
First, if you're using Asterisk 13.8.0 or greater, consider switching to the Bundled Version of pjproject
Asterisk fails to detect pjproject libraries
After building and installing pjproject, Asterisk fails to detect any of the libraries - the various res_pjsip components cannot be selected in Asterisk's menuselect
Verify that Asterisk's config.log shows the following:
- Make sure you have
pkg-configinstalled on your system.
- pjproject will install the package config file in
/usr/lib/pkgconfig. Some distributions, notably Fedora, will instead look for the library in
/usr/lib64. Update your
PKG_CONFIG_PATHenvironment variable with
/usr/lib/pkgconfigand re-run Asterisk's
- Make sure you have
pjproject fails to build: errors related to opencore_amr
When building pjproject, errors about opencore_amr are displayed, e.g.:
You already have the AMR codec installed. Run
configure with the
--disable-opencore-amr option specified.
pjproject fails to build: video linker errors
When building pjproject, linker errors referring to various video methods are displayed, e.g.:
configure with either or both
ldconfig fails to display pjproject libraries
After building pjproject, the dump provided by
ldconfig -p doesn't display any libraries.
ldconfig to re-configure dynamic linker run-time bindings. This will need to be run with super user permissions.
pjproject fails to build on Raspberry Pi
pjproject/Asterisk fails to compile on your Raspberry Pi (raspbian) due to pjproject configure scripts not detecting endianness:
/usr/include/pj/config.h(using the editor of your choice)
- Replace this code:
Then recompile. This workaround was taken from issue ASTERISK-23315.
Uninstalling a Previous Version of pjproject
Typically, other versions of pjproject will be installed as static libraries. These libraries are not compatible with Asterisk and can confuse the build process for Asterisk 12. As such, any static libraries must be removed prior to installing the compatible version of pjproject.
pjproject provides an
uninstall make target that will remove previous installations. It can be called from the pjproject source directory like:
If you don't have an "uninstall" make target, you may need to fetch and merge the latest pjproject from https://github.com/asterisk/pjproject
Alternatively, the following should also remove all previously installed static libraries:
Finally, you will need to update shared library links:
If you want to run a sanity check, you can verify that pjproject has been uninstalled by ensuring no pjproject modules remain on the system:
If running the above command yields no results, that's it! You have successfully uninstalled pjproject from your system. If there are results, you may need to remove other pjproject-related items from /usr/lib as well.