INSTALLATION

Install ModRealtime Modules

Install mod_realtime_ai or mod_audio_stream for FreeSWITCH using the official ModRealtime package repository or direct package downloads.

Debian 12 · Debian 13 · Enterprise Linux 9
01
REQUIREMENTS

Before You Install

A working FreeSWITCH installation is required. On Debian systems, FreeSWITCH must be installed from the official SignalWire FreeSWITCH APT repository.

Important: Debian packages are built and tested against FreeSWITCH packages provided by the official SignalWire APT repository. Custom, third-party or self-compiled FreeSWITCH installations are not supported by these packages.
Supported packages: Debian 12 (Bookworm), Debian 13 (Trixie) and Enterprise Linux 9 on x86_64/amd64 systems.
02
DEBIAN — RECOMMENDED

Add the Official APT Repository

On Debian 12 and Debian 13, the recommended installation method is the official ModRealtime APT repository. Add the repository signing key:

$ curl -fsSL https://packages.modrealtime.ai/modrealtime-archive-keyring.gpg \
  | sudo tee /usr/share/keyrings/modrealtime-archive-keyring.gpg >/dev/null

Then add the repository for your installed Debian release:

$ . /etc/os-release
$ echo "deb [signed-by=/usr/share/keyrings/modrealtime-archive-keyring.gpg] https://packages.modrealtime.ai ${VERSION_CODENAME} main" \
  | sudo tee /etc/apt/sources.list.d/modrealtime.list
$ sudo apt update
The repository automatically selects the correct packages for Debian 12 (Bookworm) or Debian 13 (Trixie).
03
INSTALL

Install a Module

Install mod_realtime_ai:

$ sudo apt install mod-realtime-ai

Or install mod_audio_stream:

$ sudo apt install mod-audio-stream
The public APT repository provides the Free Edition packages. Trial and Commercial builds are distributed separately.
04
MANUAL INSTALLATION

Install a Debian Package Directly

If you prefer not to use the APT repository, download the appropriate .deb package and install it with APT.

$ sudo apt install ./package-name.deb
Direct Free Edition and Trial packages are available on the Downloads page →
05
ENTERPRISE LINUX 9

Rocky Linux 9 and AlmaLinux 9

RPM packages are available for Enterprise Linux 9 systems with a compatible FreeSWITCH installation.

Download the appropriate RPM package and install it using DNF:

$ sudo dnf install ./package-name.rpm
See the Downloads page → for the currently available EL9 packages.
06
FREESWITCH

Load the Module

After installation, load the module from the FreeSWITCH CLI.

For mod_realtime_ai:

$ load mod_realtime_ai

For mod_audio_stream:

$ load mod_audio_stream
Add the module to conf/autoload_configs/modules.conf.xml if you want FreeSWITCH to load it automatically at startup.
07
30-DAY TRIAL

Activate a Trial License

After installing and loading a Trial build of mod_realtime_ai, generate the server ID:

$ uuid_realtime_ai license request

Send the generated server ID through the contact page to receive your 30-day Trial license.

08
UPDATES

Keep Your Installation Updated

Systems using the official APT repository receive new package versions through the standard Debian package manager.

$ sudo apt update
$ sudo apt upgrade
NEXT STEPS

Configure mod_realtime_ai

Create your first provider profile and connect a FreeSWITCH call to realtime AI.

Getting Started