aavaz/pbx repository overview

⁠About Aavaz PBX – Free Edition

Aavaz PBX is powerful, yet approachable.

PBX systems are inherently technical and do require system administration knowledge. However, we strongly believe they should not be unnecessarily complicated.

This system is built to:

• work reliably in real-world environments
• be usable without deep telecom expertise
• provide enough features to run most organizations comfortably

We will continue to add features — but never at the cost of usability.

⁠🟢 Support

If you need help - send us an email at [email protected]⁠

• We will help with everything - including:
  • setup issues
  • deployment questions
  • initial configuration

⁠Before You Begin

For your own server (Methods 2 and 3), make sure your system meets the following. The cloud one-click install (Method 1) sets all of this up for you.

⁠System Requirements

• OS: Ubuntu 24.04 LTS (tested and recommended). Other Linux distributions may work but are not tested.
• RAM: 4 GB recommended. 2 GB works for a small office.
• CPU: 64-bit Intel/AMD (x86-64); typical $300 PC configs work well. ARM (e.g. Raspberry Pi, AWS Graviton) is not supported.
• Network: Public IP (recommended for real deployments)

⁠Run the Container

⁠Method 1 - One-Click in the Cloud (AWS or Google Cloud)

No server? Launch a ready-to-use PBX in your own AWS or Google Cloud account. It creates one Ubuntu 24.04 server with a fixed public IP, installs Docker and Aavaz PBX, and opens only the ports a PBX needs. It's ready about 3 minutes after launch. You don't need anything from Before You Begin.

👉 Pick a region closest to you: Call quality depends on being closest to where your phones are. The examples below are for US East Coast, the full list is available here -> github.com/aavaz-biz/pbx-deploy⁠

AWS, US East (N. Virginia):

Leave the defaults (an SSH key pair is optional) and click Create stack. Your PBX's address is under Outputs → PublicIp.

Google Cloud, us-east1:

Follow the step-by-step guide on the right-hand side of Cloud Shell. It prints your PBX's public IP at the end.

🎥 Video walkthroughs: Install on AWS⁠ · Install on Google Cloud⁠

💲 You pay your cloud provider directly: about US$36/month on AWS (t3.medium, us-east-1) or US$31/month on Google Cloud (e2-medium, us-east1), including the fixed IP and disk.

Then continue with Access the PBX below.

⁠Method 2 - Automated Script (your own Linux server)

Easiest way to get started on your own server, as it will check dependencies and guide you in fixing issues it encounters.

In your Terminal copy and paste the following:

curl -fsSL https://resources.aavaz.biz/install/aavaz-pbx-install.sh | bash

⁠Method 3 - docker run (your own Linux server)

sudo docker run -d \
  --name aavaz-pbx \
  --restart always \
  --network host \
  --cap-add NET_ADMIN \
  -v /mnt/aavazHost:/aavaz/data \
  aavaz/pbx:latest

⁠Access the PBX

Once the container is running:

Open your browser:

https://<your-server-ip> (on a cloud server, use its public IP)

http:// also works; it automatically redirects to https://.

⁠Default login credentials:

• 👉 Username: admin
• 👉 Password: admin

It will get you to change your password on your first login.

⁠Notes:

1. HTTPS uses a self-signed certificate initially
2. You can configure proper certificates later
3. You can also map a domain (recommended for production)

⁠Aavaz Data

The docker run command part -v /mnt/aavazHost:/aavaz/data translates to:

• /mnt/aavazHost → folder on your server
• /aavaz/data → folder inside the container

⁠The /mnt/aavazHost folder contains

• configuration
• database files
• call recordings
• logs
• TLS certificates
• credentials

👉 If you care about your data — back up this folder

Your system can be restored, if you delete the container but keep this folder.

⁠Understanding the docker run Command

This is the only command you really need to understand to run Aavaz PBX correctly.

Let’s break it down clearly:

⁠What the flags mean

• -d (Detached Mode)
  • Runs the PBX in the background so your terminal is free.
• --restart always
  • restarts automatically on server reboot
  • recovers if it crashes
  • 👉 This is important for production stability.
• --network host
  • This is a key design choice.
  • Instead of using Docker’s internal networking, the PBX:
  • uses your server’s real network directly
  • binds directly to ports like 80, 443, 5060
  • Why this matters:
    • VoIP systems (SIP/RTP) behave poorly with NAT and port mapping.
    • avoids complex NAT issues and other networking issues
    • simplifies troubleshooting
• --cap-add NET_ADMIN 👉 This is intentional and part of the security model.
  • Gives the container permission to manage network rules on the host.
  • control firewall access for SIP
  • Aavaz blocks all SIP traffic by default
• -v /mnt/aavazHost:/aavaz/data
  • This is the most important part for your data.

⁠Useful Commands

• Stop PBX
  • docker stop aavaz-pbx
• Start PBX
  • docker start aavaz-pbx
• Check running container
  • docker ps
• View logs
  • docker logs -f aavaz-pbx

Developed and maintained by: Aavaz PBX⁠
A product of Aavaz Contact Center Solutions⁠