MikoPBX supports installation using many virtual machines. In this section you can find detailed instructions for them. Click on an item in the list below to go to the instruction for a specific virtual machine:

Foreword

Welcome to the MikoPBX documentation resource! Here you can find step-by-step instructions related to interacting with the MikoPBX PBX system. For your convenience, the documentation is organized into sections - just like in the web interface, making it very easy to navigate.

Thank you for choosing MikoPBX! ❤️

What is MikoPBX?

MikoPBX is a free telephony server with its own operating system and a simple, user-friendly web interface. It works with virtually any telephony technology in the world.

MikoPBX is a fully modular interface for Asterisk, written in PHP and JavaScript. This means that you can implement absolutely any additional Asterisk telephony functionality within MikoPBX. Moreover, if you develop a useful module, you can place it in the public repository and make it available to all MikoPBX users. Additionally, MikoPBX has very low hardware requirements:

Where to Start?

To get started, you should install MikoPBX using any method convenient for you. Below are installation options. By clicking on their names, you can access detailed articles:

• Installation .

• Installation .

• Installation .

• Installation in a .

After installation, you can begin exploring your PBX system. The "User Guide" documentation will help you with this, providing detailed information about specific sections:

• .

• .

• .

• .

For additional help with getting started quickly, you can refer to .

Modules

If you have familiarized yourself with the basic setup and operation of MikoPBX, you can expand its functionality using modules.

Modules allow you to add extra features to your system. You can learn more about them step by step:

1. – here you'll find a detailed description of the registration process and its specifics.

2. – this section provides a detailed explanation of how to install and manage modules.

3. – in this section, you'll find detailed descriptions of each module, as well as steps for configuring and using them.

FAQ Section

In this section, you can find answers to your questions and solutions that will help you expand the functionality of basic features. This section, like the main documentation, is divided into categories for easy navigation.

If you have a question that isn't covered here, you can seek assistance in the , where MikoPBX users help each other resolve issues and needs related to the PBX system.

MikoPBX supports installation on a standalone computer. There are two installation methods:

• Live USB — writing the image to a flash drive and then installing it onto another disk.

• Bootable USB — installing the system directly onto the USB drive itself, allowing you to boot and run the system from it.

This section provides image writing instructions for all supported operating systems (Windows, MacOS, Linux).

Follow the step-by-step instructions in the order presented for a quick and successful system setup.

Installing MikoPBX

MikoPBX is a full-fledged operating system for your hardware; it is not a standalone application. It is provided as an image file (*.iso, *.img, *.raw).

It supports various installation methods:

MikoPBX supports installation via many cloud services. In this section you can find detailed instructions for them. Click on an item in the list below to go to the instruction for a specific virtual machine:

MikoPBX can be run in Docker using two main methods. The first method involves running the container directly using a Docker command with the necessary parameters. The second method involves using Docker Compose, which simplifies managing multi-container applications and allows the entire configuration to be described in a yaml file, making the deployment and maintenance of the system more convenient.

First login to the MikoPBX system

Go to the MikoPBX installation console, remember the IP address that your PBX received.

Enter the received MikoPBX IP address in the web browser. The authorization page will be displayed. Log in using the default credentials:

After successful authorization, MikoPBX will automatically open the settings for changing the password:

After changing the password, the system will be fully operational. It is recommended to immediately configure the firewall rules. You can read about how to do this by following .

The "Call Routing" section in MikoPBX is an interface for configuring call direction rules within the telephone system. Here, administrators can determine how to handle incoming and outgoing calls by setting conditions and routes for efficient distribution of calls among employees, departments, or external lines.

Telephony providers

Telephony providers in MikoPBX is the system section where connections to external communication operators are configured via internet protocols for IP telephony. Here, administrators can add and configure SIP trunk accounts or other types of connections that allow the system to make and receive calls to and from landline and mobile numbers.

In this article, you will find detailed documentation on connecting providers to the system, their configuration, and features.

Incoming Routes (Incoming Routing)

Incoming Routing in MikoPBX are a set of rules that define how the system handles incoming calls from external telephony providers. With them, administrators can set call directions based on various conditions such as the caller's number, time of day, or the specific number the call was received on. This enables automatic distribution of incoming calls to specific employees, departments, IVR menus, or call queues. Configuring incoming routes helps optimize call handling and improve customer service quality by providing flexible and efficient management of the company's telephone communications.

In this article, you will find detailed documentation on configuring incoming routing.

Outgoing Routes (Outbound Routing)

Outgoing Routes in MikoPBX are a set of rules and settings that determine how the system handles outgoing calls from employees to external numbers. With them, administrators can manage call direction through various telephony providers or communication lines based on certain conditions such as the dialed number, prefixes, time of day, or user access rights. This helps optimize communication costs, distribute load between channels, and implement security policies by restricting or allowing certain types of calls. Configuring outgoing routes provides flexibility and control over outgoing telephone communication, contributing to the effective operation of the company's communication system.

In this article, you will find detailed documentation on configuring outgoing routing.

Off-Work Time (Night and Holiday Switch)

Off-Work Time in MikoPBX is a tool for setting up call handling rules during periods when the company is not operating, such as at night, on weekends, or on holidays. With it, administrators can define how the system will handle incoming calls during off-hours: redirect to voicemail, play special voice messages, or forward calls to the mobile numbers of on-call staff. This allows for proper interaction with clients outside of working hours and maintains a high level of service.

In this article, you will find detailed documentation on setting up off-work time for your system.

The simplest way to install MikoPBX is by deploying a ready-made image from the AWS Marketplace. If you wish to launch a custom version of MikoPBX, please refer to the detailed instructions where we describe step-by-step how to create an AMI image from any MikoPBX distribution.

Installing Docker and Docker Compose on Ubuntu 22.04

Before working with Docker, you need to install Docker and Docker Compose themselves. Here's how to do it:

# Update package list and install required dependencies
sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common

# Add the GPG key for Docker's official repository
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

# Add Docker's repository to the APT sources list
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

# Install Docker CE
sudo apt update
sudo apt install docker-ce

# Install Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

# Verify Docker Compose version
sudo docker-compose --version

Creating a user and directories on the host system

Before creating the container on the host machine, it's necessary to create a user and group with limited permissions, as well as a folder for storing configuration settings and call recordings

Useful commands

Command to connect to the PBX console:

Command to connect to the PBX console menu:

Connecting to sngrep for SIP analysis

Installing MikoPBX in Google Cloud can be done in two ways: using an image from the Google Cloud Marketplace or from an image based on a file uploaded from the MikoPBX distribution. The first method provides quick and easy deployment of the standard version of MikoPBX, while the second is suitable for intermediate releases.

SSH (Secure Shell) is a protocol used for secure remote connections and server management. It allows you to run commands, transfer files, and administer systems through an encrypted channel. SSH protects your data from interception by providing authentication and encryption between the client and the server. It is a primary tool for developers, system administrators, and DevOps engineers when working with remote machines.

Below are three different methods for connecting to MikoPBX via the SSH protocol:

• Password-based connection using third-party applications (this article uses PuTTY as an example)

• Key-based connection, demonstrated with examples on Windows, Linux (MacOS)

• Connection using Google Secure Shell Extension.

You need to set the time zone correctly to ensure accurate system time display. If the time zone is not set, notifications and call history will be recorded with incorrect timestamps.

To configure the time zone, go to the "System" section and select "Time Settings":

To manually set the time, toggle the switch "Adjust the time manually."

Uploading a sound file to the PBX

Audio files in MikoPBX are used in various call scenarios and interactive voice menus

"Off-hours" in MikoPBX is a tool for setting up call processing rules during periods when the company is not working, such as at night, on weekends or holidays. With its help, administrators can determine how the system will handle incoming calls during off-hours: forward to an answering machine, play special voice messages or forward calls to the mobile numbers of on-duty employees. This ensures correct interaction with customers outside of working hours and maintains a high level of service.

Creating a rule

To add a new rule, click on the "Add Time Interval" button.

Preparation

The "System" section in MikoPBX is the interface for managing general settings and parameters of the telephone system. Here, administrators can configure core system parameters, manage updates, date, and other functions that ensure stable and secure operation of MikoPBX. This section allows you to control and optimize the system's operation at the entire infrastructure level.

General settings

In the "General settings" section of MikoPBX, administrators can manage the main system parameters, such as call recording retention settings, notifications, log parameters, voice prompt language, and many other system options. This section provides control over general functions and behavior of MikoPBX, allowing you to optimize the system's operation according to the organization's needs.

The Maintenance section of MikoPBX is an interface for managing the technical aspects of the system and ensuring its stable operation. Here, administrators can perform tasks on data backup and recovery, software updates, system status monitoring, and event log management. This section helps maintain the functionality of the telephone system, promptly detect and eliminate possible problems.

PBX update

The "PBX update" section in MikoPBX is an interface for managing system software updates. Here, administrators can check for new versions, install updates, and view the change history. Regular use of this section ensures that MikoPBX is up-to-date, secure, and stable.

When a new is added to the PBX, a SIP account with a numeric internal number is created on the PBX. In some cases, for security reasons, it is necessary to change the name for authorization of this employee.

When configuring SIP Clients, you can often see two key parameters:

1. Username - usually equal to the account ID, in the case of MikoPBX equal to the internal number

2. Auth name - username for authorization. In the case of MikoPBX is equal to the internal number

To change the authorization name:

Generating and Linking the Key

1. First, generate an SSH key. Open a terminal and enter the following command to create it:

In this example, an "ed25519" key will be generated with the comment "" for future identification.

You can also specify a path where the key files will be saved. By default, keys are stored in ~/.ssh/id_ed25519.pub

There are several ways to transfer MikoPBX to a different host (server). Each method has its advantages and special considerations. Below is a brief overview of each option, and you can refer to the detailed guides in this section.

Option #1: Transfer Using Backup

Description:

A backup of the current MikoPBX configuration is created and then uploaded to the new server. This method is suitable for smaller amounts of data.

Pros:

Method 1

1. Go to "General Settings" -> "Delete all system settings"

The Firewall in MikoPBX is an interface for configuring the system's firewall. Here, administrators can create and manage network traffic filtering rules, controlling access to MikoPBX and protecting it from unauthorized access and network threats. Configuring the firewall ensures the security of the telephone system, preventing potential attacks and ensuring stable operation in the organization's network infrastructure.

In MikoPBX, all local subnets can be described in the "Network and Firewall" → "Firewall" section. The firewall is designed to restrict access to the station by traffic type and subnets.

To add a new rule, you need to click on the button:

General settings

You can give the rule any custom name. To the right of the subnet address, there is a field for Subnet Mask in CIDR format.

Available services

• SIP&RTP - registration of phones and voice traffic. Session Initiation Protocol is used for establishing connections between VoIP phones.

• WEB - access to the administrative interface for configuring the PBX. SSH - root access to the system.

• SSH (Secure Shell) allows accessing the MikoPBX console.

• AMI - access to Asterisk Manager API via telnet. Asterisk Manager Interface (AMI) provides access to Asterisk via TCP/IP protocol.

Advanced Options

• Each subnet has a flag 'Is it a VPN or a local network'. When this flag is set, MikoPBX will present itself as a local IP to all local subnets instead of external ones.

• The flag 'Never block addresses from this network' should be enabled only for trusted subnets. If this flag is enabled, intrusion prevention rules will not apply to this subnet

Fail2ban is enabled together with the Network Firewall switch in the "Network and Firewall" → "Firewall" section.

Fail2ban blocks IP addresses with abnormal activity. When there is a failed authentication attempt, information about the error will be logged in the PBX. Fail2ban analyzes all failed attempts and keeps track of them. When the number of failed attempts exceeds the maximum allowed authentication attempts, the IP address is banned. Fail2ban is capable of slowing down the rate of failed authentication attempts.

The Anti brute force settings can be found at the bottom of the "Network Firewall settings":

• If a certain number of failed login attempts (Number of attempts for blocking) occurs within a specific period (Within (seconds)), the IP address will be blocked for a specified duration (Block for (seconds)).

• The whitelist of addresses defines IP addresses that will not be blocked by Fail2ban. You can specify individual IP addresses like 93.188.40.10 or subnet like 93.188.40.10/32. The separator used is a 'space'.

• Please note that if you have set the 'Never block addresses from this network' option in the 'Network Firewall' section for a subnet, that subnet is automatically added to the whitelist, and you don't need to add it manually. It is not recommended to manually populate the whitelist of IP addresses. It is preferable to specify IP addresses only in exceptional cases.

The list of blocked addresses shows which IP addresses are currently blocked.

You can also unblock an address by clicking on the corresponding icon in the table.

Rebooting the station via the MikoPBX interface

The system shutdown/reboot menu can be found in MikoPBX by clicking on "Reboot" in the "Maintenance" section.

When you open the page, a list of active calls to the PBX will be displayed. The start date of the call is displayed, from whom and to whom the call.

• Restart the PBX - the command starts restarting the station.

• Turn off PBX - completes all processes and disconnects the station.

Rebooting the station via the console menu

You can restart the station via the console menu. To do this, select the section "[3] Reboot the system"

• If you want to restart the station: press "[1] Reboot MikoPBX"

• If you want to turn off the station: press "[2] Shutdown"

The system will reboot.

Reboot with disk check

In case of an emergency restart of the PBX (for example, power outage), it may be necessary to check the disk for errors.

In the PBX console menu, enter the command "[9] Console(Shell)" and press Enter.

System launch the MikoPBX console.

Enter the command reboot. Press Enter.

The system will reboot with a disk check.

In this section, you need to create rules and templates for distributing incoming calls for providers created in MikoPBX. The rules for incoming calls describe the route of a call from the moment it arrives at the PBX to the moment it is completed. You can create an unlimited number of inbound routing rules. You can create several rules for one provider.

Routing rule priority and default route

Rules are listed in order of priority. If no one answers the incoming call within the time interval specified in the rule, the call will be routed to the next priority rule. Rules can be moved up and down in the list, that is, their priority can be changed by dragging them by the arrows.

If the call is not answered according to any of the rules, the Default incoming route is used.

The following actions are available and can be specified as the default rule:

• Play busy signal - the client will play a busy signal and the incoming call will be ended;

• Hang up;

• Redirect the call - the call can be transferred to a number that you can select in the field located to the right of the action. You can select an IVR menu, call queue, conference, or employee extension number as the number for transfer.

Multiple routes for one provider

For one provider, you can describe several incoming routes.

First, the call goes along the upper route. If the client does not get through, then the call goes according to the lower rule (lower priority). If the client does not get through via the second route, then the call goes through the default route.

Create a routing rule

To add a new incoming routing rule, click the Add a new rule button.

In the Note field, describe the route you want to implement. In the future, this will help you debug the call circuit.

Select the Provider for which you are creating a new incoming call distribution template.

The additional DID number is the number the client called you on. This field is optional and should be completed if you need to route calls more accurately.

At the next step, you need to indicate to which phone number the incoming call from the client will be sent. The telephone number can be IVR menu numbers, call queues, conferences, or employee internal numbers.

Specify the time during which the call will be sent to the phone number you specified.

If after the specified time interval no one answers the incoming call, the call will be routed to the next priority rule.

Below is an example of a PBX installed on a VirtualBOX virtual machine, updated from version 2023.1.223 to version 2023.2.206. Download the iso image of the required PBX version from the repository.

In VirtualBOX, open the settings of the virtual machine where the PBX is installed. Go to the Storage section. Select the virtual optical drive. Click the icon in the Attributes group, and click Choose Disk File. Select the downloaded PBX iso image. Start the machine.

The console will display the line "The system loaded in Recovery mode".

Select Install / Repair (or press the number 8 on the keyboard) and press Enter.

You need the command "Update to version ****.*.**". Press the number 2 on the keyboard, then press Enter. The update installation will begin. When it is complete, the PBX will reboot.

After the PBX reboots, the message "The system loaded in Recovery mode" will no longer appear, indicating that the PBX has booted from the hard disk and not from the virtual optical drive. The installed update version will be displayed in green at the top.

To update the MikoPBX container to the latest version, you can follow these steps in the command line. These steps include stopping the current container, downloading the new version of the image, and running the container with the updated image.

Updating the docker

First, you need to properly stop the running container. After stopping the container, you can safely remove it

# Stop the current container
sudo docker stop mikopbx

# Remove the current container
sudo docker rm mikopbx

To launch a new container using the latest image version with the same settings as before, use the following commands:

Updating using Docker compose

First, you need to properly stop the running container. After stopping the container, you can safely remove it

The next step is to download the latest MikoPBX image:

An example of the docker-compose.yml file that can be used to update your MikoPBX container through Docker Compose:

Save the contents to a file named docker-compose.yml, make the necessary adjustments, and run the command:

Notes

• Data: Since data is stored in Docker volumes (mikopbx_cf and mikopbx_storage), it remains untouched during the update, preserving settings and user data.

• Environment Variables: Ensure that all necessary environment variables are correctly passed.

• Safety: Always create backups of your data before updating.

These steps will help ensure a smooth and safe update of your MikoPBX container.

When publishing a PBX on a public IP address, the task arises to protect the speaker from scanners, pests who are trying to pick up passwords to SIP PBX accounts. If a simple numeric password is set, it will be picked up very quickly, which will cause losses.

For basic protection against scanners, fail2ban must be enabled. Additionally, you can fine-tune the iptables rules.

1. Go to the "System file customization" section

1. Go to edit the /etc/firewall_additional file

1. Set the "Add to end of file" mode, insert the following code:

A more complete example of a set of rules:

This will protect you from most scanners that I mention User-Agent when requesting.

To receive notifications about missed calls by email, you need to configure the SMTP client. Detailed information about notifications in MikoPBX is reviewed here. As part of this instruction, an example of setting up missed call notifications for the Gmail mail service will be considered.

1. Enter the IP address of the MikoPBX PBX in the browser and go to System → Mail Settings

SMTP Client Settings for Gmail service:

• SMPT host - smtp.gmail.com

• SMPT port - 465 (Customer Service port)

• SMPT login and Sender address- the E-mail from which messages about missed calls will be sent

1. Save the entered settings and proceed to setting up your email account. A feature of the Gmail service is that access to your account is automatically denied to untrusted applications, which include MikoPBX, so you need to manually allow access to these applications (setup instructions are posted ).

2. Go back to System → Mail Settings. We will send a test letter to the e-mail of any service. In case of successful testing, a test email will be sent to the email address you specified.

You can read about how to set up a letter template to create an E-mail notification .

The "Telephony" chapter in the MikoPBX documentation contains detailed information and instructions related to setting up and using telephony in the system.

Extensions

Extensions in MikoPBX are individual users of the system who are assigned internal numbers for making and receiving calls. They have personal accounts that allow you to configure access rights, call forwarding and other personal settings in the system.

In this article, you will find detailed documentation on adding new employees to the station, setting up their rights and profiles. In addition, information about their additional parameters.

Call queues

Call queues in MikoPBX are a feature that allows you to distribute incoming calls between a group of operators, holding calls in a queue until an operator becomes available. This ensures efficient management of a large call flow and improves customer service.

In this article, you will find detailed documentation on creating and configuring such queues.

IVR Menu

IVR menu in MikoPBX is an interactive voice menu that allows callers to interact with the phone system by pressing keys or using voice commands. It automatically routes calls to the right departments or employees, improving call handling efficiency and customer service.

In this article, you will find documentation on creating and configuring an IVR menu.

Conferences

Conferences in MikoPBX are a feature that allows you to organize group phone calls with multiple participants at the same time. It allows you to hold group discussions, meetings and appointments over the phone, improving communication both within the company and with external partners.

In this article, you will find documentation on creating and configuring conference rooms.

Sound files

Sound files in MikoPBX are audio recordings that are used by the system to play various messages, such as greetings, announcements, IVR menu instructions or waiting signals. They allow you to personalize the audio content that callers hear, improving interaction with the system and providing the necessary information.

In this article, you will find detailed information about them, as well as how to add and edit them.

Call detail records (CDR)

Call detail records in MikoPBX is a log that stores information about all incoming and outgoing calls through the system. It provides detailed data about each call, including time, duration, participant numbers and status, which allows you to analyze communications and optimize the operation of the company's telephone network. In this article, you will find information about storing call records and their filters.

Generating and Linking the Key

To begin, you need to install OpenSSH on Windows. You can do this from this link.

1. After installation, verify it by entering the following command in PowerShell:

You should see the OpenSSH version displayed:

1. Next, generate an SSH key by entering the following command:

This will generate an "ed25519" key with the comment "" to identify it. You can specify a path for the keys by adding -f and a path, for example:

After this, the key pair will be created in the specified directory. One file will contain the public key, and the other the private key.

1. Run the following command to retrieve the public SSH key:

Copy the public key from the output.

1. Open the MikoPBX web interface and go to "System" → "General Settings":

1. Navigate to the SSH section and paste the public key into the "SSH Authorized Keys" field in the following format:

Click "Save settings":

Connecting via SSH

To connect via SSH, run the following command in PowerShell:

Replace the following based on your parameters:

• The path to your SSH key.

• The IP address of your MikoPBX instead of mikopbxipadress.

You will then be connected to the MikoPBX console via SSH:

In some sections of the interface (e.g., Extensions), the current version of MikoPBX is displayed in the lower right corner.

In the PBX web interface, go to Maintenance → PBX update.

If there are newer versions of the PBX available, they will be displayed in the Online updates available table, with the version number in the first field and the list of changes in the second.

There are two update options: online update and update using a downloaded img file.

Online upgrade

Updates are downloaded to the PBX and applied immediately. To update this way, click the button for the desired version.

A warning window will appear. Click Upgrade.

The PBX will download and apply the updates, and then reboot.

Update using a downloaded img file

To update using this method, click the button for the desired version.

The img file will start downloading. Wait for the download to complete.

Then click the button and select the downloaded img file.

Then click Apply the update, and in the warning window, click Upgrade.

The updates will be applied, and the PBX will reboot upon completion.

The "Modules" section in MikoPBX is an interface for managing additional functional components of the system, which includes two subsections: "Module Management" and "Dialplan Applications".

Managing these subsections allows you to configure MikoPBX as flexibly and efficiently as possible, expanding the functionality of the telephone system and adapting it to the unique requirements of the organization.

Registration in the modules marketplace

Registration in the MikoPBX Marketplace does not affect the basic functionality of the system. You can use MikoPBX to work with calls without registration and installation of additional modules. However, we recommend that you go through the registration procedure in the marketplace to get the opportunity to expand the functionality of the system.

Registration will give you access to additional modules and extensions.

Module management

Module management in MikoPBX is an interface for managing additional system components that expand its functionality. Here, administrators can install, update, enable or disable modules, adding new features or integrations with external services. This section allows you to adapt the system to the specific needs of the company, ensuring flexibility and scalability of the telephone network.

Application dialplans

MikoPBX dialplan applications are a set of tools that allow you to set up individual call processing scenarios within the system. With their help, you can define a sequence of actions that the system will perform when a call is received or made. This may include redirecting a call to a specific extension, playing special audio messages, requesting additional information from the caller, or performing other functions.

Using dialplan applications, you can flexibly customize the logic of the telephone system to the needs of your business without delving into complex programming. This makes it easier to create complex call processing scenarios, allowing you to improve the efficiency of communications and improve the level of customer service.

Such a need may arise in many cases, For example, when a client is tired of waiting on the line, you can offer him to leave a voice message, connect with an internal number known to the client.

1. Go to System → System file custmization.

1. Open the file "queues.conf" for editing

1. In the black window, find the queue section that you need to configure

1. Select the "Add to End of File" mode. Add a similar section with the prefix (+) :

Wireshark is a program for capturing and analyzing network traffic. It provides a user-friendly graphical interface for viewing and closely inspecting packets, making it useful for diagnosing and resolving network issues.

1. Download Wireshark from this link. Install it with the default settings.

2. Launch Wireshark. Select the network you will use to analyze traffic by left-clicking on it, then press the blue shark icon to start capturing traffic.

1. Reproduce the issue by making a test call.

2. To stop the capture, click on the red stop icon:

1. Download the WinSCP installer from the official website at the link

2. Install the program

3. After installation, the main menu of the program will open

1. Host Name (or IP address) — MikoPBX IP address Port — the default port for SSH connection is 22 User name — always specify root Password — SSH password of your MikoPBX

1. Before connecting, you need to allow password authorization in the MikoPBX web interface, as well as set a password for connection: to do this, go to "General Settings" -> "SSH"

1. To connect, click "Login"

1. After successful connection, the MikoPBX root folder will open for you

1. Go to System → System file custmization.

1. Open the extensions.conf configuration file for editing.

1. Set the "Add to end of file" mode and paste the following code:

The whitelist of numbers sometimes needs to be described for specific providers:

• PROVIDER-ID - the value that you can find in the address bar at the time of provider configuration

This method involves creating a backup of your current MikoPBX configuration, transferring it, and restoring it on the new server. It’s simple to implement and suitable for small systems. This approach is convenient for users with minimal technical experience.

1. First, create a backup of your previous system. You can find detailed instructions in this article.

1. Select the data you want to transfer and wait for the process to complete.

1. Download your archive by clicking the corresponding button in the "Backup Module" section:

1. On the new host (server) with your MikoPBX installation, restore from the archive by clicking "Upload backup file":

After this, your system will be restored from the archive. This method is ideal for transferring small amounts of data.

tcpdump is a Linux utility for capturing and analyzing network traffic. It allows you to monitor packets passing through a network interface in real time and save them for further analysis.

Capturing Logs with the tcpdump Application

1. Connect to your PBX via SSH (instructions here).

2. Run the following command:

1. Reproduce the issue by making a phone call. After the call, press CTRL + C in the SSH console to stop tcpdump.

1. Connect to the PBX using WinSCP (instructions ).

2. Send the log file /tmp/capturefilename.pcap to technical support.

In this guide, we will perform a step-by-step installation of MikoPBX using the DigitalOcean cloud platform.

Before beginning, you need to copy the download link for the latest .raw MikoPBX image. You can find these on .

Log in to the platform at

MikoPBX on Google Cloud Marketplace:

Let's start with the setup

General Information

Registering in the MikoPBX Module Marketplace is not required for the system’s basic functionality. You can fully utilize MikoPBX for handling calls without registration or installing additional modules. However, we recommend registering in the marketplace to expand your system’s capabilities.

Registration gives you access to additional modules and extensions. These include both free modules (moved out of the core system for easier initial setup) and paid modules from us and third-party developers. If you are a developer, you can contact us at [email protected] to get instructions on creating and adding your module to the Marketplace.

The second method involves setting up automatic scheduled backups, saving the data directly onto the target server via SFTP. This approach is particularly convenient for transferring larger amounts of data, as it eliminates the need for intermediate storage of the backup.

Configuring Scheduled Backup

First, you need to configure scheduled backups for the MikoPBX you want to transfer data from.

1. Go to the

This article discusses transferring data to a new host using rsync. This approach uses a generated SSH key for authentication, making it the most reliable and therefore the recommended method.

Schematically, the transfer process can be depicted as follows:

Creating the Script File and Adding Content

When working with telecom service providers, issues may occasionally arise. For example, the provider's server might become unresponsive or unavailable. This article provides a mechanism for notifying the system administrator via email.

1. Create a new "Dialplan Application".

In some cases, it is necessary to save call recordings on a network drive. This example shows how to connect a shared Windows folder to MikoPBX.

1. Create a directory for the script:

The "Network and Firewall" section of MikoPBX is an interface for configuring network settings and managing the system's firewall. Here, administrators can configure IP addresses, network interfaces, and create firewall rules to protect the system from unauthorized access. This section ensures the secure and stable operation of MikoPBX in the organization's network infrastructure.

Network interface

The "Network Interface" section in MikoPBX is an interface for configuring the system's network connection parameters. Here, administrators can manage IP addresses, subnet masks, gateways, and other network settings for each network interface. This allows MikoPBX to be correctly integrated into the organization's network and ensure its stable operation in accordance with the requirements of the network infrastructure.

Task: Several providers A,B, C, D are installed on the PBX… The call arrives at MikoPBX through provider A. When dialing an employee's mobile number, the call must also go through provider A. The provider must support more than one simultaneous call.

1. Go to System → System file customization

1. Open the extensions.conf configuration file for editing.

Jitter configuration is usually required when there are significant issues with RTP traffic transmission, such as delayed voice, dropped audio, or the inability to hear the other party.

It is best to investigate the root cause by analyzing call dumps on the PBX, router, or upstream router. Compare the data and observe where the jitter increases.

However, in some cases, you may not be able to influence the quality of the communication channel. If the audio stream delay becomes too large, Asterisk will discard "late" packets. Increasing the Jitter value can solve this issue.

In MikoPBX, jitter can only be configured through .

modules.conf - Add the following line:

Enabling password access

1. Go to the section

1. Proceed to editing the "modules.conf" file

Loading the MikoPBX image

1. Open the local / ISO images tab and select Download from URL

2. In the URL field, paste the link to the MikoPBX distribution file with the .iso extension

3. Click the Download button and wait for the file to finish downloading

Creating a virtual machine

1. Select Create VM

2. On the General tab, enter the name of the virtual machine, for example mikopbx-vm

1. Go to the OS tab, and in the ISO image field, select the previously downloaded image

2. Set the OS type to Linux

1. On the System tab, uncheck the Qemu Agent box, and use the default values for other fields

1. Go to the Disks tab

2. Adjust the size of the system disk to 1 GB

1. Click the Add button and add an additional disk for data storage

2. Specify a disk size of at least 50 GB

1. On the CPU and Memory tabs, specify the computing resources for the virtual machine based on the expected load on the PBX. For a test machine, you can set Cores (CPU tab) to 2 and Memory (Memory tab) to 2 GB

1. On the Network tab, uncheck the Firewall box

1. Go to the last tab, Confirm, and check the Start after created box

2. After entering the values, click the Finish button

Installing MikoPBX

1. Go to the created virtual machine mikopbx-vm

2. On the open tab, go to the Console section

3. If the boot is successful, a console menu will appear. Enter 8 from the keyboard to start the installation

1. Select the disk for the system and enter the disk name from the keyboard, for example sda. Confirm the selection by entering y from the keyboard

1. Connect the disk for storing call recordings, enter the disk name for connection from the keyboard, for example sdb

Starting MikoPBX

1. To access the MikoPBX web interface, enter your virtual machine's IP address in your browser's address bar. You can find the IP address in the console.

1. Enter the IP address in your browser’s address bar. Log in using the default credentials.

The Mail and Notifications section in MikoPBX allows you to configure sending system notifications via email. Here, administrators specify SMTP server parameters, define notification events such as voice messages or system errors, and edit email templates. This section helps to promptly inform users and administrators about important events, ensuring effective control over the system.

Connecting to the SMTP server

To receive notifications about missed calls and voicemail messages by email, you need to configure the SMTP client. SMTP (Simple Mail Transfer Protocol) is used to send e-mail over the Internet. SMTP clients interact with an SMTP server that sends email.

• SMTP host - address of the mail server

• SMTP port - the port of the mail server

• SMTP login, SMTP password - authorization parameters

• Sender's address - Emails will be sent on behalf of this address Email of the system administrator - all system notifications will be sent to this email address, for example, about the lack of disk space. When changing and saving the settings, a test email will be sent to this address

• Use TLS - activates the use of encryption when connecting to the server, to connect via SSL, you need to add a protocol description to the server address

• Validate server certificate - in some cases it is necessary to disable it when using self-signed certificates

• Use mail motifications - allows you to enable/disable all email alerts, including voice mail

Missed Notifications

It is possible to customize the address and template for notifications about missed calls:

• Email for missed notifications - by default, missed notifications are sent to the email specified in the employee card. If the call cannot be matched with an employee or email is not specified, the call will be sent to this "shared" address

• The subject, text, and footer of the letter may contain parameters in the form of PARAMETER_NAME

List of available "parameters":

• NOTIFICATION_MISSEDCAUSE - currently always takes the value "NOANSWER", i.e. a missed call

• NOTIFICATION_CALLERID - who was the call from

• NOTIFICATION_TO - who was the call to

Voice mail

It is possible to set up an address and a template for a voicemail notification:

• Voice mail will be sent to each employee who missed the call (if the email is specified in his card).

• Voicemail will always be sent to the "Email address to receive all voice mail records"

• It is possible to listen to the voicemail recording from the

The following "parameters" can be used in the subject, body and footer of the email:

• VM_DATE - date and time

• VM_CALLERID - caller's callerid, consists of name and num, example "Alex Magnet" <101>

• VM_DUR - message duration

To specify a parameter, you need to use a construction of the form PARAMETER_NAME.

Click Save to complete the setup.

Sign in to the service Amazon Web Services https://aws.amazon.com

MikoPBX in AWS Marketplace: https://aws.amazon.com/marketplace/pp/prodview-ota6fb2tftuhw

Let's get started with the setup

Creating a virtual machine

1. Open Services / Compute / EC2 and navigate to Images / AMI Catalog

2. In the open tab enter MikoPBX in the search bar

3. In the AWS Marketplace AMIs section select the image by clicking the Select button

4. On the opened tab click Subscribe now

1. Enter the virtual machine name, for example mikopbx-vm

If you have an SSH key

1. Specify the SSH key in the Key pair field

If you don't have an SSH key

1. Select Create new key pair and specify the key pair name, for example mikopbx_key

Follow the instructions further

1. If necessary, change the size of the storage disk in Configure storage, default size is 50Gb

1. Under Network settings, all required Firewall rules are configured automatically

1. For other fields use default values

2. Click Launch instance

Starting MikoPBX

1. Go to the created virtual machine mikopbx-vm

2. On the opened tab, select Connect / EC2 serial console, wait for the system to fully load until the authentication parameters are displayed

1. Copy the external address of the created virtual machine and enter it in the browser's address bar

2. Use the login and password provided in EC2 serial console for login

If your PBX is behind NAT and its public IP address changes, the PBX may not receive incoming calls until it re-registers with the provider, which by default can take 2–6 minutes.

Create the IP Check Script

1. Connect using SSH into your MikoPBX (documentation about different ways to do that - here)

2. Create a new script file with this command:

The system will wait for input; paste the following script into the terminal:

1. Press CTRL+D to finish.

2. Make the file executable:

Schedule the Script

1. Go to the MikoPBX web interface → "System" → "System file customization":

1. Open the file: /var/spool/cron/crontabs/root

1. Append the following line to the end of the file:

This schedule runs the script every minute to check for a changed public IP. If the IP has changed, it re-registers all providers.

Sngrep is a command-line tool for capturing and analyzing SIP traffic. It allows you to visualize SIP sessions, filter them, and track issues in voice connections.

To start working with the application, follow the SSH connection to the PBX guide.

To start the application, use the command:

You can view the list of interfaces using the following command:

Example of Sngrep Interface:

The application window displays a list of all SIP dialogues:

• Use the ⇑ and ⇓ arrows to navigate between dialogues.

• Press Enter to view detailed information about a dialogue.

• In the detailed view, you can examine specific SIP packets by selecting them with ⇑ and ⇓.

• Press Enter to view the contents of a SIP packet.

• Press ESC to return to the previous window.

• Use the Space key to select multiple SIP dialogues and press Enter to view them in one window.

• In the detailed view, use the Space key to select two SIP packets for comparison.

Saving a Dump

1. Use the Space key to select the SIP dialogue "Call" of interest.

1. Press F2 to open the save dump dialogue:

• Use the ⇑ and ⇓ arrows to navigate between form fields.

• Enter the path and file name.

• Select the save action and press ENTER.

• Download the file using .

Filtering

1. Press F7 to open the filter dialogue:

1. Use the ⇑ and ⇓ arrows to navigate between form fields.

2. Use the Space key to select SIP methods for analysis.

3. Select the Filter action and press ENTER.

You may encounter a situation where you have forgotten the username or password for the MikoPBX web interface. This guide explains how to reset them.

Solution

1. Go to the MikoPBX console.

1. Select the option "[7] Reset password for the web interface".

2. Type y to confirm resetting the login and password.

1. Log in to the web interface using the default credentials:

After the first login, you will be prompted to change the credentials.

Resetting the Password in a Docker Container

1. Access the container shell:

1. Launch the menu using this command:

1. Navigate to "[7] Reset password for the web interface".

2. Enter "y" to confirm resetting the username and password.

3. Log in to the web interface using the default credentials:

Change the login credentials after the first authorization:

Creating a virtual machine

1. Creating a new virtual machine.

Creating a virtual machine

1. Select Action / New / Virtual Machine

2. On the Specify Name and Location tab, enter the name of the virtual machine, for example

Creating a Virtual Machine

1. Start by creating a new virtual machine.

2. Enter the Name, Type, and Version

To execute the following commands, you will need to .

Additional modules allow you to expand the functionality of the main system. In this guide, you will find information on managing modules and installing applications using the built-in Marketplace.

Detailed instructions for configuring and operating each module can be found .

You can find the Module Management section under "Modules" -> "Marketplace of modules".

There are cases when a customer can be heard very quietly during a phone call and there is no way to increase the volume level on the telephone /softphone. Let's describe a way that can help in solving the problem:

1. Go to "System" -> "System file customization"

1. Open modules.conf for editing

1. Download the program to connect via SSH. This can be done on the official website at the

2. Run the downloaded program. The main menu will open for you.

Network Channel Requirement

An example of calculating the required channel bandwidth for different codecs for 30 simultaneous calls. PBX supports the most popular codecs:

• G.711 - 4.67 Mbps