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 .

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:

• Installation on a standalone computer.

• Installation in a virtual machine.

• Installation .

• Installation in a .

Follow the link for your preferred installation method and proceed according to the provided instructions.

After installation, you need to access the MikoPBX web interface for further system configuration. To do this, find the PBX's IP address in the MikoPBX console:

In this example, the IP address is 192.168.0.203. To access the web interface, enter this IP address into your browser's address bar:

After the first login, the system will prompt you to change your password.

For stable PBX operation, you need to configure the network through the Network and Firewall → Network Interface section. Detailed instructions for these settings can be found .

In MikoPBX, all local subnets can be defined in the Network and Firewall → Firewall section. The firewall is intended to restrict access to the PBX based on traffic type and subnets. Follow the setup instructions .

Fail2Ban blocks IP addresses exhibiting unusual activity; it can reduce the rate of failed authentication attempts and helps protect your PBX from hacking. Instructions to help with the setup can be found .

After completing the initial PBX setup, you can proceed to create accounts for your employees. This will assist you.

After adding employees, you need to connect providers to your PBX. Instructions for this section can be found . Instructions with examples of configuring real providers can be found .

At this stage, you need to set routing rules for incoming and outgoing calls: how calls passing through a specific provider will be handled:

To create routing rules, you may also need the following features:

The Marketplace allows you to extend the system's standard functionality using modules:

• You can read more about Modules in MikoPBX in .

• Information on registering in the MikoPBX Marketplace can be found .

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

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

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

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.

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.

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;

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

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

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

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

Command to connect to the PBX console:

Command to connect to the PBX console menu:

Connecting to sngrep for SIP analysis

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

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.

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

The "Mail settings"

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.

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.

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 "

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

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 .

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

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.

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.

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.

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.

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:

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.

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.

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.

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.

Generating an SMTP Token

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

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

1. Scroll down to the "SMTP submission" section. Click "Generate token".

1. Enter an arbitrary name in the "Token name" field — MikoPBX in our case — and select the Email address for which you are creating the token.

A token will be created. Its parameters will be shown only once and will become unavailable once you close the window. Save them, as we will use them for further configuration.

1. Go to the "System" -> "Mail and Notifications" section.

1. Go to "SMTP Settings". Fill in all the required parameters:

• Sender Address - your email address that you used to generate the token.

• Sender Name - the name from which the mail is sent.

• Authentication Type - "Username and password".

• SMTP Username - SMTP Username from the token data window.

Click "Save".

Click "Test connection". You will see the following window confirming that the entered data is correct:

Uploading a sound file to the PBX

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.

Correct the file name if necessary.

Save settings

Custom sound files are stored on the PBX along the path /storage/usbdisk1/mikopbx/media/custom. Music on hold files are stored in /storage/usbdisk1/mikopbx/media/moh.

If a client gets into a queue during a call or is waiting for redirection, the PBX plays a melody for him. It is possible to download your own tunes for listening while waiting.

You can do this on the "Music on Hold" tab as described above.

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.

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

A form for creating a new rule will open.

In the form, you will find the following fields:

• Period: The calendar period when employees are absent from the office, such as during New Year's or May holidays.

• Weekdays: Specific weekdays for which the rule will be applied.

• Time Range: The time period during the day when employees are absent.

• Incoming Call Action: You can choose to play a sound file or perform a call transfer. Call transfer options include transferring the call to a conference, IVR menu, queue, internal employee extension, or specific termination numbers.

In the Note field, you can add a note with a description of the created rule, so that you can quickly navigate through the essence of this rule using this description. With the eraser button, you can clear the fields opposite which this button is located.

By activating this function, a new menu "Route restrictions" will appear on top of you

Here you can choose which specific routes the rule you are creating will apply to.

This rule is used for calls during non-working hours from Monday to Friday, specifically from 7:00 PM to 9:00 AM:

This rule is used to handle calls on Saturdays and Sundays:

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.

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.

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.

Create conference rooms

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 "Conference Pin" field. Only digits can be entered in this field, with a minimum requirement of at least one digit.

In this case, to join the conference, employees will need to enter the PIN code after dialing the conference PIN.

• Communication is conducted solely through voice (no other means of information transmission besides speech are provided).

• All participants can speak and hear each other simultaneously, ensuring duplex communication.

• Participants use telephones (hardware or software) for communication.

• Each participant dials the conference number. The first participant hears hold music until at least one more participant joins the conference. An employee can transfer their caller into the conference by using specific key combinations on their phone. Transfers can be made to both internal and external numbers. The key combination for transfers is set in the System -> General Settings -> Call Transfers section.

• Example: An employee dials the combination **1111 (the combination for unconditional transfer), and their caller joins the conference as its first participant. The call is completed for the transferring employee, and to join the conference, they dial the conference number 1111.

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

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.

Log in to the platform at

MikoPBX on Google Cloud Marketplace:

Let's start with the setup

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

Sign in to the service Amazon Web Services

Let's get started with the setup

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

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

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

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

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.

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:

This guide is intended for a dedicated computer or server running MikoPBX.

The primary method is updating through the web interface. If the PBX does not boot normally or the web interface is unavailable, use an ISO image written to a separate USB drive.

Preparation

1. Make sure you have physical access to the server or a working console. Create a backup of the MikoPBX settings and call recordings.

2. Make sure at least 400 MB is free on the Storage.

3. End active calls and schedule a maintenance window for the telephony system.

1. In the web interface, open "Maintenance" → "PBX update".

1. Select the desired version in the list. Review the list of changes and start the update process.

1. Once the download is complete, enter the phrase Yes, I have a backup. Click Update.

1. Download the .img file of the required version from the page.

1. Open Maintenance → PBX update.

1. Select the downloaded .img file.

1. Click Apply update.

1. Enter the phrase Yes, I have a backup and confirm the operation.

Wait for the PBX to reboot automatically after the update.

This method is suitable for restoring and updating the PBX from the local console.

1. Download the ISO of the required version from the page.

1. Connect a separate USB drive with a capacity of at least 1 GB.

2. Write the ISO in disk image mode using Rufus, balenaEtcher, or dd. Instructions for writing an ISO image can be found .

1. Connect the prepared USB drive to the server. In the BIOS/UEFI or Boot Menu, select booting from USB.

2. Wait for MikoPBX to start in Recovery mode.

1. Press any key to open the console menu. Then open "[4] Install or recover".

1. Select "2) Update to version..."

1. Wait for the writing to finish and the reboot. Remove the USB drive or restore the system disk as the first boot device.

This guide is intended for MikoPBX installed as a full-fledged virtual machine in VMware, VirtualBox, Hyper-V, KVM, Proxmox VE, and other hypervisors.

Two update methods are available for this type of installation:

• through the web interface — the primary and most convenient method;

• from an ISO image — a fallback method if the web interface is unavailable or the system needs to be recovered.

Preparation

1. Make sure you have access to the web interface and the virtual machine console. Create a backup of the MikoPBX settings and call recordings.

2. Create a virtual machine snapshot. If the hypervisor allows, take it with the virtual machine powered off.

3. Make sure at least 400 MB is free on the system disk.

4. Schedule a maintenance window: during the update, MikoPBX will reboot, and current calls will be dropped.

1. Open the MikoPBX web interface.

2. Go to Maintenance → PBX update.

1. In the "Online updates available" table, find the version you need. Review the list of changes and click the update button next to the selected version.

1. Wait for the image to download. Do not close the page until the confirmation dialog appears. Enter the phrase "Yes, I have a backup". Click Update.

MikoPBX will prepare the update and reboot the virtual machine automatically.

This method is suitable if the required version is not in the list of online updates or the file has already been downloaded in advance.

1. Download the .img file of the required version from the page.

1. In the web interface, open Maintenance → PBX update.

1. In the file selection field, specify the downloaded .img.

1. Click Apply update.

1. Enter the phrase "Yes, I have a backup". Confirm the update and wait for the reboot.

Use this option if the PBX does not boot normally, the web interface is unavailable, or you need to perform the update from Recovery mode.

1. Download the ISO image of the required version from the page.

1. Power off the virtual machine. In the hypervisor settings, connect the ISO to the virtual CD/DVD drive and set booting from the virtual CD/DVD before the system disk.

1. Start the virtual machine and open its console.

2. Wait for the message about booting in recovery mode — System booted in recovery mode (Live CD).

1. Press any key to open the console menu. Then open "[4] Install or recover".

1. Select "Update to version..."

After the operation is complete:

1. Power off the virtual machine if the ISO was not disconnected automatically.

2. Disconnect the ISO from the virtual drive.

3. Restore booting from the system disk as the first boot device.

4. Start the virtual machine.

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.

• Give this access key a name — enter an arbitrary name to identify this key pair.

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 in this guide).

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.

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 MikoPBX's GitHub releases.

Uploading the Image to DigitalOcean

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

1. Go to "Custom Images" → "Import via URL":

1. Paste the link to the .raw disk image file you copied earlier.

2. Enter a name for the image, select the region where it will be uploaded (this should match the region of your future virtual machine), and choose "Unknown" as the operating system type.

   Click "Upload image".

Wait for the image upload to complete.

1. Go to DigitalOcean’s main page:

1. To create a new virtual machine (Droplet), go to "Create" → "Droplets":

1. Select a region and datacenter for your virtual machine:

1. Next, choose the previously uploaded image and configuration for your virtual machine:

1. Go to the "Additional Storage" tab. Here, you can add a second disk that will be used for call recordings. To do this, click "Add volume" and specify the parameters for the new disk.

1. Go to "Choose authentication method." Here, you need to select "SSH Key" and add the key pair for SSH authentication. For more information on generating SSH keys, see:

1. Click "Create Droplet."

1. Go to the page of the newly created Droplet. Wait for it to start. Then connect via the built-in DigitalOcean console (shown in the screenshot).

1. After the system boots, open the web interface using the external IP address shown in the console (external).

1. Paste the machine’s IP address into your browser’s address bar. When you reach the MikoPBX login page, use the following credentials:

• Username: admin

• Password: The Droplet ID, which you can find in the browser’s address bar:

1. To connect via SSH, follow . This example uses PowerShell (Windows).

1. Open PowerShell and run the following command:

After pressing Enter, you will be authenticated via SSH and arrive at the MikoPBX console menu.

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.

Pre-configuration

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

Creating an IVR menu

Go to "Telephony" → "IVR menu" section.

Click "Add new IVR nenu."

Set the name, number, and, if necessary, a comment for the IVR menu. Select the audio file that you uploaded in the previous step.

Configure Actions when you extend. In the first column, specify the extension number, and in the second column, set the addressing rule.

Set the number of retries before transferring to the default number.

Set the timeout for entering an extension number (value in seconds) after which the voice greeting will be repeated.

The Default extension is required in case the client does not enter an extension number (for example, due to technical limitations).

Enable the "Allow Dialing of any extension" toggle switch if needed.

Enter the IVR menu number that can be dialed to reach that specific IVR menu.

Press "Save settings."

The principle of operation of an IVR (Interactive Voice Response) is as follows:

1. When calling the IVR menu number, the Voice Greeting audio file starts playing.

2. During the playback of the voice menu, the caller can select menu options or dial an employee's internal extension. The "Allow Dialing Any Internal Number" flag allows callers to dial internal employee numbers with SIP accounts. Routing to queues, IVRs, conferences, and other destinations is configured separately in the IVR action table.

3. After the voice menu is played, there is a waiting period of the "Input Extension Timeout" for entering an extension number.

This guide is intended for MikoPBX running as a full-fledged cloud virtual machine: from a Marketplace or from an imported RAW, VHD, or other disk image.

The primary method for updating a cloud PBX is through the web interface using an .img image. The ability to boot from an ISO depends on the particular cloud provider and is not universal.

Before you start

1. Make sure you have access to the cloud management panel and the MikoPBX web interface. Save a backup of the MikoPBX settings and call recordings outside the virtual machine being updated.

2. Create a snapshot of the system disk. If there is a separate disk with recordings, create a snapshot for it as well or use storage backup.

3. Write down the current external and internal IP addresses, Security Group rules, attached disks, and network settings.

4. Make sure at least 400 MB is free on the system disk with MikoPBX.

5. Schedule a maintenance window: active calls will be dropped.

1. Log in to the MikoPBX web interface.

2. Open "Maintenance" → "PBX update".

1. Find the version you need in the "Online updates available" table. Review the list of changes and start the download.

1. Once the download is complete, enter the phrase "Yes, I have a backup". Click Update.

1. Do not perform Restart or Stop from the cloud panel: MikoPBX will prepare the update and reboot on its own. During the reboot, the connection to the web interface will be interrupted. It is safer to monitor the process via the cloud provider's serial console or web console.

Use a local file if the version is not in the list or the cloud VM does not have direct access to the update server.

1. Download the .img of the required version from the page.

1. Verify that the image architecture matches the VM architecture.

2. Open Maintenance → PBX update.

1. Select the downloaded .img and click Apply update.

1. Enter the phrase "Yes, I have a backup" and confirm the operation.

1. Wait for the automatic reboot and the services to start again.

Updating via ISO is possible only when the cloud platform simultaneously allows you to:

• upload or attach a custom ISO;

• change the VM boot order;

• open an interactive console;

• after the update, disconnect the ISO and boot from the system disk again.

If all the conditions are met (for example, as ), the procedure is the same as for a regular virtual machine:

1. Download and attach the ISO image of the required version from the page.

1. Start the machine and open its console. Wait for the message about booting in recovery mode - System booted in recovery mode (Live CD).

1. Press any key to open the console menu. Then open "[4] Install or recover".

1. Select "Update to version..."

1. When finished, disconnect the ISO and boot from the system disk.

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.

General Settings

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

• Send missed call notifications - enables/disables missed call notifications.

• Common Email for Missed Call Notifications - a shared email address for sending notifications about missed external calls (if an employee has no email specified, this shared address is used).

• Send voicemail notifications - enables/disables voicemail notifications.

• Common Email for Voicemail Messages - a shared email address for sending voicemail notifications (priority: 1. Employee's personal email; 2. The email specified in this field).

• Send login notifications - enables/disables system login notifications.

• Send system notifications - enables/disables sending of system notifications.

• System Administrator Email - the address to which system notifications will be sent.

• Sender Address, Sender Name - emails will be sent on behalf of this address and name.

• Authentication Type:

  • Username and Password - classic authentication method when connecting to an SMTP server, using a mailbox address (login) and password. All parameters (server, port, encryption, login, and password) are entered and stored manually.

• SMTP Username, SMTP password - authorization credentials.

• SMTP Host - mail server address.

• SMTP Port - mail server port.

• Encryption type:

• SMTP Username - authorization credentials.

• OAuth2 Provider - the mail service through which OAuth authentication is performed (e.g., Microsoft/Outlook, Google/Gmail).

• Application ID (Client ID) - the unique identifier of the application created in the control panel of the selected OAuth provider. Used so the provider knows which application is requesting access to the mailbox.

Our documentation includes several connection examples for each authentication type. Below you can find links to these instructions.

• Login and password authentication:

• OAuth2 authentication:

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.

• Unlimited — store all recordings without restrictions.

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.

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.

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.

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.

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.

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.

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.

• AJAM - access to Asterisk Manager API via HTTP or HTTPS.

• ICMP - communication check using the 'ping' command.

• CTICLIENT - connection of the telephony panel 2 for 1C.

• 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

In Docker bridge mode the MikoPBX built-in firewall and fail2ban do not protect the web interface: the container cannot manage host iptables, and HTTP clients arrive from the docker0 gateway. SIP protection continues to work (UDP DNAT preserves the source IP).

To protect the web interface in Docker, choose one of:

• network_mode: host for the container (when the host is dedicated to the PBX);

• An external CrowdSec-compatible bouncer in front of the MikoPBX API — see .

Before starting the process, format your USB drive with the following parameters:

• File system - FAT32

• Allocation unit size - 8192 bytes

The image will be written using the Rufus utility. You can download it .

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. In the setup interface, select the virtual machine type: "Typical (recommended)". Then, click "Next >".

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

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.

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 with releases and copy the download link for the template file with the "lxc.tar.gz" extension.

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

3. Enter the group name, for example

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:

You can upload your own module using the "Upload New Module" button. You need to upload .zip

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 "Network and Firewall" → "

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 a datastore for the virtual machine.

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