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

• GSM - 1.68 Mbps

• G.722 - 4.67 Mbps

• G.729 - 1.38 Mbps

• 800 Mb hard disk for the main system

• A 50+ Gb hard drive for recording conversations

• 1 (2 cores) x86-64 processor

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 link.

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.

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:

• Installation .

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! ❤️

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:

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:

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:

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 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.

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:

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:

sudo docker exec -it mikopbx sh

Command to connect to the PBX console menu:

Connecting to sngrep for SIP analysis

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.

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 in MikoPBX is an interactive voice menu that allows callers to interact with the phone system by pressing keys (DTMF). 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 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 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 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.

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.

System log entries

The "System log entries" section in MikoPBX is a tool for monitoring and analyzing the status of the telephone system. Here, administrators can view event logs, check the status of various services and system components, and test connections and calls. Using this section helps to promptly detect and eliminate technical problems, ensuring stable and efficient operation of MikoPBX.

Reboot

The "Reboot" section in MikoPBX is an interface for securely managing the state of the telephone system via the web interface. Here, administrators can reboot the system to apply new settings or shut it down gracefully for maintenance. Using this section prevents possible errors and ensures stable operation of MikoPBX. In addition, the possibility of rebooting via the console will be discussed.

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.

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.

Firewall

The "Firewall" section of 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.

The "Anti brute force (Fail2Ban)" section in MikoPBX is a tool for ensuring system security from unauthorized access and network attacks. Fail2Ban monitors event logs and automatically blocks IP addresses that make suspicious or repeated failed login attempts. Setting up this section helps prevent system hacking and protect the organization's confidential data.

Conference calling is used for conducting group discussions, meetings, or negotiations in cases where participants are unable to meet in person. It is also used when a particular matter needs to be discussed with multiple participants simultaneously.

The list of conference rooms is located in the "Telephony" -> "Conferences section".

To create a new conference room, click the "Add conference".

You must specify the name of the conference and its internal number, by calling which you can enter this conference

To prevent unauthorized access to the conference by employees for whom the discussion is not intended, you can secure the conference room with a password. To do this, fill in the "

Audio files in MikoPBX are used in various call scenarios and interactive voice menus (In IVR menu, during non-working hours, in call queues, for various system notifications, and in hold music.) to play voice greetings or notify customers.

The list of available sound files is displayed in the "Telephony" -> "Sound files".

To add a new sound file, click "Add a new sound file".

Click "Upload a new file" and select a sound file.

Call History provides a log of all incoming, outgoing, and internal calls. It is located under "Telephony" -> "Call History".

The Call History feature in MikoPBX enables users to:

• Display all calls;

• Filter calls based on criteria

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.

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:

"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.

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

A form for creating a new rule will open.

In the form, you will find the following fields:

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.

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.

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

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

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

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

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.

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."

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

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 (x86 or ARM version) by clicking the Select button

4. On the opened tab click Subscribe now

5. Click the Launch an instance from AMI button to create a virtual machine

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

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

Log in to the platform at https://console.cloud.google.com/

MikoPBX on Google Cloud Marketplace: https://console.cloud.google.com/marketplace/product/mikopbx-public/mikopbx

Let's start with the setup

Adding roles to a Service account

If you have a service account, check if it has the necessary roles, and add them if needed

If you do not have a service account, create one and add the necessary roles

1. Open the Navigation menu / Products & solutions / Management / IAM & Admin

2. Go to the Service accounts tab and click on CREATE SERVICE ACCOUNT

3. Enter a name for the service account, for example mikopbx-service-account

4. Click the CREATE AND CONTINUE button

1. Add the roles Cloud Infrastructure Manager Agent, Compute Admin, Compute Network Admin, Service Account User

1. Click the DONE button

1. Open the Marketplace and enter MikoPBX in the search bar

2. Select the image

3. On the opened tab select LAUNCH

1. In the Deployment name field, enter a name, for example mikopbx-vm

2. In the Deployment Service Account section, check the Existing account option and select the previously created service account

1. If necessary, change the size of the data storage disk in the Data Storage section. By default, its size is 50 GB

1. Under Networking, all required Firewall rules are configured automatically

1. For other fields, use the default values

2. After entering the values, click the DEPLOY button

1. Open the Compute Engine tab and go to the Virtual machines / VM Instance section

2. Go to the created virtual machine mikopbx-vm-mikopbx-vm

3. On the opened tab, go to Logs / Serial port 1 (console)

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

2. Use the login and password provided in Serial port 1 (console) to log in

Creating a Bucket and Access Keys

1. Go to the DigitalOcean console (link).

2. Navigate to Manage → Spaces Object Storage. Click Create a Spaces Bucket to create a new bucket.

1. On the bucket creation page, under Choose a datacenter region, select the region closest to your MikoPBX server. Choose Standard Storage.

1. In the Choose a unique Spaces Bucket name field, enter a name of your choice for the bucket.

Click Subscribe & Create Bucket.

1. Open the page of the newly created bucket by clicking its name in the Buckets section.

1. Go to the Settings tab.

1. Scroll down to the Access Keys section. Click Create Access Key to generate a new key pair.

1. Fill in the required parameters for the new key:

• Select access scope — Limited Access.

• Buckets — select the bucket you created earlier.

• Permissions — Read/Write/Delete.

Click Create Access Key.

Your key pair values (Access Key ID and Secret Key) will be displayed. Save these values — you will need them when configuring MikoPBX.

1. Go to the Maintenance → Storage tab.

1. Open the S3 Cloud Storage tab and fill in the following fields:

• Automatically upload recordings to cloud storage — enable the toggle.

• S3 Endpoint URL — enter https://sgp1.digitaloceanspaces.com, replacing sgp1 with your region.

• S3 Region — enter the region of your DigitalOcean bucket (e.g. sgp1

Use the Local Storage (S3 mode) slider to configure how long recordings are kept locally before being deleted after upload to the cloud.

Click Save.

After saving the settings, click Test Connection. If the connection is successful, you will see the message "S3 connection successful" and synchronization of call recordings will begin.

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 "Backup" module. Navigate to the "Backup Schedule" tab:

1. Next, set the scheduled backup parameters:

• Server Address: Enter the address of your new MikoPBX server.

• Mode: SFTP mode

• Port: 22

For information on SSH connection, refer to the related documentation. To start the backup immediately after saving the settings, choose the option "Start backup immediately after saving settings". You can also select the specific data you want to transfer in the corresponding section.

Wait for the backup to complete, and then shut down the old machine.

If the data transfer is successful, your backup will appear in the backup module section on the new host:

To restore from the backup on your new host, do the following:

1. Go to the backup settings by clicking on the respective element:

1. Select the data you need to transfer and click "Restore from a backup":

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 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 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.

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:

• Easy to set up.

• Allows you to preserve the current configuration.

Considerations:

• May be less reliable for large amounts of data.

• Requires intermediate storage for the backup (e.g., local disk or cloud).

Description:

A backup is automatically created and saved directly to the target server via the SFTP protocol. This method is especially effective for large amounts of data.

Pros:

• Suitable for large amounts of data.

• Minimizes manual actions.

• Provides direct data transfer between servers.

Considerations:

• Requires SFTP configuration on both servers.

• Needs correct SSH user settings for proper operation.

Description:

The rsync command is used to directly synchronize data between the old and new servers. This method is convenient for experienced users.

Pros:

• Fast synchronization, even for large data volumes.

• Preserves access rights and directory structure.

• Does not require creating intermediate backups.

Considerations:

• Requires basic command-line knowledge.

• Possible errors if configurations (e.g., paths) are incorrect.

• Both servers must be accessible on the network at the same time.

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.

Time Settings

The "Time Settings" section in MikoPBX is an interface for configuring system date and time parameters. Here, administrators can set the current date and time, choose a time zone, and configure synchronization with Network Time Protocol (NTP) servers. Correct date and time settings are important for accurate event logging, call logs, and the operation of schedule-dependent functions, ensuring system synchronization with other network devices and services.

Mail settings

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

The "Asterisk Manager Inteface (AMI)" section in MikoPBX is an interface for configuring access to the Asterisk Manager Interface (AMI). Here, administrators can manage AMI connection parameters, such as enabling or disabling access, specifying login credentials for authentication. Configuring AMI access allows external applications or scripts to interact with the MikoPBX system for monitoring and managing calls, expanding the telephone system's functional capabilities.

The "System files customization" section in MikoPBX provides administrators with the ability to directly modify or supplement the system's standard configuration files. Here, you can make individual settings that are not available through the standard web interface and adapt the system's behavior to the specific requirements of your organization.

This section is intended for advanced users who have a deep understanding of the structure and operation of MikoPBX. With its help, you can:

• Edit configuration files: Make changes to existing files or add new parameters.

• Override standard settings: Change default values for certain functions or modules.

• Add your own scripts or modules: Expand the system's functionality by integrating custom solutions.

It is important to note that incorrect modification of system files can lead to unstable operation or system failures. Therefore, it is recommended to create backups before making changes and to carefully check the correctness of the settings.

Method 1

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

1. In the input field, paste the text "delete everything", click "Save settings"

Method 2

1. Open the MikoPBX console menu. Use the keyboard to enter 9 to go to the PBX console.

1. Enter two commands sequentially:

1. After executing these commands, MikoPBX will reboot. The login to the web interface takes place with the login (admin) and password (admin) by default.

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.

When a new Employee 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:

1. Open the employee's account for editing

1. Go to "Advanced Settings" → "Advanced SIP Settings"

1. Add the following lines:

Instead of MIKO204, specify a name for authorization, it is advisable to use both letters and numbers

Preparation

1. Prepare a PC with two disks of the same size.

2. Boot the machine in LiveCD or LiveUSB mode.

3. Connect to the machine via SSH.

RAID 1 Assembly

1. Run the following command in the console to display disk names:

1. The disk names will be displayed. In this example, the disk names are:

1. Clear the superblocks on the disks:

1. Clean the old metadata:

1. Create the RAID1 array:

1. When prompted with "Continue creating array?", confirm by entering "y".

2. You can now proceed with the installation as per the . When selecting the disk during installation, choose md0.

TODO: You may need to modify the grub.cfg file. Otherwise, there is no guarantee that the system will boot if one of the disks fails.

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.

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.

Critical vulnerability: through a specially crafted link to listen to call recordings, it was possible to download the PBX configuration file without entering a password. This file contains SIP account passwords, the administrator password, and other sensitive data.

Patch fixes:

• Protection against SQL injection attacks on the database

• Protection against remote code execution via file uploads

• Fixed IP address authenticity check during authorization

• Updated HTTPS encryption protocols (removed outdated SSLv3 and RC4)

• Added web server security headers

To install the patch, connect to your PBX using SSH (instructions are available ). Open the console and run the following command:

To revert the security patch, run the following command:

1. Start by creating a new virtual machine.

2. Enter the Name, Type, and Version of the virtual machine, as shown in the image below.

1. Select Action / New / Virtual Machine

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

1. Proceed to the Specify Generation tab, and select

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 .

1. Go to "Manage" → "Backups & Snapshots":

An IVR menu includes options for routing incoming calls using an interactive voice menu. It allows callers to navigate through a series of menu prompts using their telephone keypad (DTMF). Each option in the menu can be associated with a specific action or routing destination, such as transferring the call to a particular department, providing self-service options, or connecting the caller to a specific extension or queue. The IVR menu enhances the caller's experience by offering a self-service mechanism and streamlining call routing based on their selections.

Before creating an IVR menu, it is necessary to upload audio files that will be played to callers when they contact your company. The audio files can be added in the "Telephony" -> "Sound files"

Choose your music file using "Upload a new file"

Additionally, there is the option to record a file using a microphone if you connect to the MikoPBX over

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 developers@mikopbx.com to get instructions on creating and adding your module to the Marketplace.

To begin the registration process, navigate to "Modules" -> "Marketplace of modules":

If you are not registered in the Marketplace, the section will look as follows:

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".

This section allows you to manage modules: connecting them, configuring them, and uploading your own custom modules. Documentation on developing your own modules can be found .

All installed modules are listed under the tab of the same name:

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:

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.

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":

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:

1. Create the script file:

1. First, go to your Proton account settings ().

1. Then go to the "Proton Mail" -> "IMAP/SMTP" section.

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

Proxmox LXC is a lightweight container solution within the Proxmox VE virtualization platform, based on LXC (Linux Containers) technology. They allow running isolated Linux systems with minimal resource consumption compared to full virtual machines.

Downloading the Container Template

1. Go to the "local" storage, then "CT Templates". Click "Download from URL" to open the template download dialog from a URL.

1. Go to MikoPBX GitHub with releases and copy the download link for the template file with the "lxc.tar.gz" extension.

1. Paste the link into the "URL" field and click "Query URL". If you copied the correct link, the "File name" field will be populated with the filename having the "lxc.tar.gz" extension.

Click "Download" to start the download.

After the download is complete, you will see the "TASK OK" message.

1. Click "Create CT" in the upper right part of the interface to create a new container.

1. Fill in all the basic container parameters:

• Hostname — enter a name for the service.

• Password — enter the password for logging into the MikoPBX web interface.

• SSH public keys — generate and paste your SSH key. You will then be able to use it to connect to the station via SSH. More details about key generation and SSH connection can be found .

Click "Next".

1. Select the previously downloaded template in the "Template" section.

Click "Next".

1. Next, specify the system disk size. The recommended value is 1 GB.

Click "Add" to add a new disk.

1. Specify the size of the second disk — this is where call recordings will be stored. The recommended size is at least 50 GB. Also specify the disk path — "/storage".

Click "Add" to add a new disk.

1. Specify the size of the third disk for storing configuration. The recommended size is 0.5 GB. Also specify the disk path — "/cf".

Click "Next".

1. On the next tab, specify the number of CPU cores to be used. For a small company, 1–2 cores is sufficient (see for more details).

Click "Next".

1. Next, specify the amount of RAM and Swap memory for the container.

Click "Next".

1. In the next section, configure your network settings. In our case, DHCP is used to obtain an IPv4 address. The Firewall does not need to be enabled here, but it must be configured later in MikoPBX (see for more details).

Click "Next".

1. In the DNS settings section, click "Next".

You will see the final container configuration. Click "Finish".

1. Go to the management window of the created container by clicking on its name. Click the "Start" button to launch it.

1. Then go to the "Console" tab. Wait for the system to load and find the web interface IP address.

Enter it in your browser's address bar. Then perform the first login to MikoPBX.

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".

1. Enter a name (e.g., Blacklist), a short number for the application (e.g., 99), and select "Code Type" - "PHP AGI Script".

1. Go to the "Program Code" tab:

1. Insert the following code:

1. Save the changes and copy the dialplan application identifier from the browser's address bar. It will look like "DIALPLAN-APP-CF967EE0".

1. Go to System → Customizing System Files and open the file /var/spool/cron/crontabs/root for editing.

1. Select the mode "Append to the end of the file", and in the black editing field at the bottom, insert the following code:

Save the changes.

You're done!

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

1. First, establish an SSH connection to your new MikoPBX. You can find instructions on how to do this in this article.

1. Once connected, switch to the console ([9] Console). First, you need to create a directory to store the script file. Use the following command:

1. Navigate to the created directory:

1. Create the file "transfer-rsync.sh" to store the script:

1. Next, you need to fill the file with the script content. You can find the script .

Use the following command to download the script:

1. Make the file executable:

1. Run the script:

1. You will be prompted to enter necessary information about your old MikoPBX:

• IP address of your old station

• Username for SSH authentication

• Port for SSH authentication

1. Next, you’ll be asked whether to generate a new key. If you haven’t done this before, type "y" to confirm. If you previously generated a key for accessing the second MikoPBX, type "n":

1. A new SSH key will be created. You must copy this key and insert it into the web interface of your old MikoPBX at General Settings → SSH → SSH Authorized keys field.

1. After saving the key on the old MikoPBX, wait a few seconds, then press any key to continue the script.

The transfer of all data to the new host will begin. This may take some time.

The "Storage" section in MikoPBX allows you to monitor disk space usage and manage data storage settings. It provides a detailed breakdown of occupied space by category: call recordings, system logs, backups, and other files. In addition to local storage monitoring, the section allows you to configure automatic upload of recordings to an S3 cloud storage.

Section location: "Maintenance" -> "Storage".

Storage information

The "Storage information" tab provides an overview of disk space usage.

At the top of the page there is a block with a horizontal chart that visually shows what share of the total disk volume each data category occupies. In the example, 56.0 GB out of 100.0 GB is used. Each segment of the chart is color-coded according to the legend:

• 🟠 Call recordings

• 🟣 Call history

• 🔵 System logs

• 🟢 Additional modules

• 🩵 Backups

• 🔴 System caches

• ⚫ Other files

At the bottom of the page there is a list of data categories and the amount of storage each one occupies.

The "Local Storage" tab allows you to set the retention period for call recordings on the station. Use the slider to select the desired period:

• 30 days (1 month) — minimum retention period.

• 90 days (3 months) — recommended for small businesses.

• 1 year — for compliance with legal requirements.

Click "Save" to save the settings.

This tab is used to configure automatic upload of call recordings to an external S3-compatible storage (e.g.: Amazon S3, MinIO, Wasabi).

At the top of the tab there is a toggle "Automatic recording upload to cloud storage" — it enables or disables the upload feature.

To connect to a bucket, fill in the following fields:

• S3 endpoint URL — the address of the storage service (e.g., https://storage.yandexcloud.net for Yandex Cloud S3).

• S3 region — the region where the bucket is located (e.g., ru-central1 in our case).

• S3 bucket name — the name of the bucket where recordings will be uploaded.

Click "Save" to save the settings.

Next, click the "Test Connection" button — the system will perform a test connection and display the result at the top of the page. Upon successful connection, the message "S3 connection successful" will appear and synchronization of call recordings will begin.

At the bottom of the tab there is a "Local storage period (S3 mode)" slider — it determines how long recordings will be stored locally on the station after being uploaded to the cloud before being automatically deleted. The local retention period cannot exceed the total retention period.

Before starting, download the disk image file with the .raw extension. You can do this .

This guide uses the balenaEtcher utility. You can download it .

1. First, format your USB drive with the following parameters:

• File system

1. Creating a new virtual machine.

1. After downloading the latest version of the image (), specify the ISO file with the installation distribution.

Click "Continue"

This guide covers creating and configuring a virtual machine in VMware Workstation Pro and installing MikoPBX on it.

You can download the VMware Workstation Pro installer from .

1. Open VMware Workstation Pro and click "Create a New Virtual Machine" to start creating a new virtual machine.

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

First, log in to the Microsoft Azure portal

Let's proceed with the setup.

1. Open Menu / All services / General / Resource groups

2. In the Resource groups tab, select Create

Queues allow you to:

1. Distribute phone calls among a group of employees (agents): You can create a call queue and add multiple employees to it. When a call comes in, the system automatically routes it to an available employee in the queue, ensuring a more even distribution of workload and increasing call handling efficiency.

2. Hold the customer on the line when all employees are busy: If all employees in the queue are occupied with other calls, the customer will be placed on hold until one of the employees becomes available. This helps avoid call abandonment and ensures better customer service.

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 their help, administrators can control the direction of calls through different telephony providers or communication lines depending on certain conditions, such as the dialed number, prefixes, time of day or user access rights. This allows you to optimize communication costs, distribute the load between channels and apply security policies by restricting or allowing certain types of calls. Setting up outgoing routes provides flexibility and control over outgoing telephone communications, contributing to the efficient operation of the company's communication system.

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

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

The name of the rule can be set arbitrarily.

In this manual, the installation will be performed on UTM. Before it starts, download the disk image file with the ".iso" extension. You can do this by .

1. Go to UTM. Click "Create a New Virtual Machine" to create a new virtual machine.

1. Select "Virtualize" as the VM type.

The "Mail and Notifications" section in MikoPBX allows you to configure sending system notifications via email. Here, administrators specify SMTP server parameters, define events for notifications such as voicemail or system errors, and edit email templates. This section helps keep users and administrators informed about important events in a timely manner, ensuring effective system monitoring.

• Enable Notifications - enables/disables all email notifications, including voicemail.

Asterisk Manager Interface (AMI) is a powerful and convenient Asterisk programming interface (API) for managing the system from external programs. Thanks to the AMI, external programs can connect to Asterisk via the TCP protocol, initiate the execution of commands, read the result of their execution, as well as receive notifications about events in real time.

AMI is often used for integration with business processes and systems, CRM software (Customer Relationship Management - customer interaction management). Asterisk is often managed from the CLI console, but using AMI does not require direct access to the server running Asterisk. AMI is the simplest tool, which in the hands of a developer can be a very powerful and flexible tool for integration with other software products. It enables developers to use the information generated by Asterisk in real time.

The first thing to do is to enable the AMI and create a user with which the client program will authenticate. "System" -> "Asterisk Manager Interface(AMI)":

To add a new account, you must specify a Username and Password. In addition, it is necessary to set a Network filter, i.e. from which subnet the connection to the AMI user is allowed. You can allow connections from any addresses, or specify a specific network that you have configured in the "

REST API MikoPBX allows you to automate station management and integrate it with external systems - CRM, helpdesk, corporate portals, and custom services. API keys are used to access the API.

All REST API requests are authorized via the Authorization: Bearer <token> header. MikoPBX supports two token types: