Foreword

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

Thank you for choosing MikoPBX! ❤️

What is MikoPBX?

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

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

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

• Installation .

• Installation .

• Installation .

• Installation in a

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

• .

• .

• .

• .

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

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

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

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

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

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

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

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

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 .

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

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.

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:

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.

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

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.

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

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

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.

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.

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

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

2. Boot the machine in.

3. Connect to the machine via .

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.

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 .

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

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

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.

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.

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

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

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

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

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

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

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

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

Online upgrade

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

A warning window will appear. Click Upgrade.

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

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

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

Then click the button and select the downloaded img file.

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

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

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.

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

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

Benefits

The Call History feature in MikoPBX enables users to:

• Display all calls;

• Filter calls based on criteria;

• Visually identify missed calls from the call log;

• Download or listen to call recordings.

Each entry in the call log contains information about:

• The caller’s phone number (Who);

• The recipient’s phone number (To Whom);

• The date and time of the call (Call Date);

Calls marked in red are missed calls. Their duration is logged as zero, and these calls cannot be played back:

For answered calls, users can listen to or download the recording. When downloading a recording, you can choose WebM (Opus), MP3, WAV, or OGG (Opus) format.

Each call log entry provides detailed information about the participants involved.

The search bar in the Call History page supports the following filters:

1. Phone Number Filter

You can search using either an internal staff number or an external client number.

1. Specific Field Filter

You can add a prefix to search only in a specific field:

• src:74952293042 - search by caller number;

• dst:302 - search by destination number;

• did:74952293042 - search by DID number;

If no prefix is specified, MikoPBX performs a general search by caller number, destination number, DID, and employee name.

1. Date Filter

When opening the Call History, MikoPBX selects a date range based on the latest call records. To filter for a specific period, select the date range and click Apply.

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

Click "Save".

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

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.

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

Solution

1. Go to the MikoPBX console.

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

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

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

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

1. Access the container shell:

1. Launch the menu using this command:

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

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

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

Change the login credentials after the first authorization:

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.

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:

mkdir /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script

1. Create the script file:

/cat > /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script/mount-shared-folder.sh

1. Insert the script content:

1. Press "CTRL+D" twice to finish creating the file.

2. Grant execution permissions:

1. In the script variables "HOST, USER, PASS", specify the connection parameters to the shared folder.

2. Add the script to cron for automatic connection of the shared folder.

3. Go to the System → Customizing System Files section.

Test the PBX operation to ensure that call recordings are being saved to the network drive.

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.

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

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

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.

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

Updating the docker

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

# Stop the current container
sudo docker stop mikopbx

# Remove the current container
sudo docker rm mikopbx

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

# Downloading the latest container image version
sudo docker pull ghcr.io/mikopbx/mikopbx-x86-64:latest

# Starting the container in unprivileged mode
sudo docker run --cap-add=NET_ADMIN --net=host --name mikopbx --hostname mikopbx \
           -v data_volume:/cf \
           -v data_volume:/storage \
           -e SSH_PORT=23 \
           -it -d --restart always ghcr.io/mikopbx/mikopbx-x86-64:latest

Updating using Docker compose

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

# Stop the current container
sudo docker stop mikopbx

# Remove the current container
sudo docker rm mikopbx

The next step is to download the latest MikoPBX image:

# Downloading the latest container image
sudo docker pull ghcr.io/mikopbx/mikopbx-x86-64:latest

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

services:
  mikopbx:
    container_name: "mikopbx"
    image: "ghcr.io/mikopbx/mikopbx-x86-64:latest"
    network_mode: "host"
    cap_add:
      - NET_ADMIN
    entrypoint: "/sbin/docker-entrypoint"
    hostname:  "mikopbx-in-a-docker"
    volumes:
      - data_volume:/cf
      - data_volume:/storage
    tty: true
    environment:
      # Change the station name through environment variables
      - PBX_NAME=MikoPBX-in-Docker
      # Change the default SSH port to 23
      - SSH_PORT=23
      # Change the default WEB port to 8080
      - WEB_PORT=8080
      # Change the default WEB HTTPS port to 8443
      - WEB_HTTPS_PORT=8443
      
volumes:
  data_volume:

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

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

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

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

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

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.

Passkeys are a modern passwordless authentication standard based on WebAuthn technology. They allow you to log in using biometrics or hardware security keys instead of a traditional password.

What are Passkeys?

Passkeys are cryptographic keys stored on your device that replace traditional passwords with a more secure technology. The private key never leaves your device — the server only stores the public key, which is useless to attackers.

Supported authentication methods:

• 📱 Biometrics — Face ID, Touch ID, Windows Hello

• 🔑 Hardware keys — YubiKey, Titan Key

• 💻 Built-in methods — Device PIN code

Advantages:

• Protection against phishing and data interception

• Fast authentication in 1–2 seconds

• No need to memorize passwords

• Unique keys for each site

1. Go to "System" → "General Settings" → "WEB interface password" tab.

1. In the Passkeys block, click "(+) Add Passkey".

1. Follow the browser instructions to register. For example:

• Setting up a Passkey on a MacBook with TouchID in Safari: you can click "More options" and choose between a fingerprint, a keychain in an authenticator app, and a physical key:

After successful registration, the Passkey will appear in the list. On your next login, you can use it instead of a password.

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.

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

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:

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

1. Go to the DigitalOcean console ().

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

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

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:

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

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

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

2. Create a new script file with this command:

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

Creating a virtual machine

1. Select Action / New / Virtual Machine

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

1. Proceed to the Specify Generation tab, and select Generation 1

1. On the Assign Memory tab, allocate the required amount of RAM based on the expected load on the PBX. For a test machine, you can specify 2 GB

1. Proceed to the Configure Networking tab, and select a pre-configured network connection

1. On the Connect Virtual Hard Disk tab, adjust the system disk size to 1 GB

1. On the Installation Options tab, check the Install an operating system from a bootable CD/DVD-ROM option

2. Select Image file (.iso) and provide the link to the MikoPBX distribution file with the .iso extension

1. After entering all values, click the Finish button

1. Go to the settings of the created virtual machine

2. Select the IDE controller to which the system disk is connected

3. On the opened tab, select Hard Drive and click the Add button

4. Click the

1. On the Choose disk type tab, select Fixed size

1. On the Specify name and location tab, specify the name (e.g., storage.vhd) and the location of the disk

1. On the Configure Disk tab, set the disk size for data storage to at least 50 GB

1. Use the default values for other fields

2. Complete the setup by clicking the Finish button

1. To start the virtual machine, click Connect... -> Start

1. Go to the Connect tab of the created virtual machine mikopbx-vm

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

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

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

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

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

Creating a Virtual Machine

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.

2. Allocate 1024 MB of memory to the virtual machine and create a new virtual hard disk for the system with a size of 1024 MB.

1. Choose the SCSI controller type and adapter type, as shown in the image below.

1. Select BIOS as the Firmware option.

1. Review and save the changes.

1. Open the settings of the created virtual machine. Create a new hard disk for storing call recordings.

1. Go to the CD/DVD Drive tab. Upload the ISO image for installation, and check the box next to "Connect at power on."

1. Start the virtual machine.

2. The MikoPBX command-line interface will open as the PBX starts loading from the optical disk containing the ISO image. You will see the message: "The system is loaded in recovery mode (Live CD)".

1. Install MikoPBX:

Go to [8] Install:

1. Information about all available disks will appear (in this example: sdb, sdc).

1. Enter the name of the disk you intended as the "system" disk, in this case, sdb, and press Enter (or simply press Enter if it’s already selected).

2. The system will prompt for confirmation. Type y and press Enter:

1. Once installation is complete, you will be prompted to select a disk for storing call recordings.

Enter the disk name (in this example, the only available disk is sdc) and press Enter.

1. After installation, the system will reboot.

MikoPBX will now boot from sdb, the system disk, and the line "The system is loaded in Recovery mode" will no longer appear—indicating a successful installation.

This completes the MikoPBX installation.

To access the control panel, enter the virtual machine's IP address in your browser's address bar.

The default login credentials are admin for both username and password.

This completes the MikoPBX installation.

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.

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 section is located in "Network and Firewall" -> "Network Interface":

General parameters

The hostname is the name of the machine. If no value is specified, the default hostname used is 'mikopbx.local'.

Network interfaces

There are two ways to configure the IP address:

1. DHCP (Dynamic Host Configuration Protocol) can be used for automatic IP address configuration. Enable the 'Use DHCP to obtain network settings' switch. This is recommended for most users. To not rely on DHCP server settings (to provide a specific address), you can disable the switch.

2. If you do not want to use settings obtained from a DHCP server, you can configure the network manually. This requires some knowledge about the network topology. To the right of the IP address, there is a field for Subnet Mask in CIDR format. You should use the alternative format: /8 corresponds to the subnet mask 255.0.0.0, /16 corresponds to 255.255.0.0, and /24 corresponds to 255.255.255.0.

"VLAN ID" - MikoPBX supports virtual network interfaces. This is relevant only for physical PCs. Sometimes a PC may have only one network interface, and it may not be possible to connect a second one physically. Using VLAN, you can create a virtual interface that works 'on top' of the physical one. One of the advantages of using VLAN is that all phone calls can be routed through it, while the network equipment can 'tag' all VLAN traffic and guarantee a stable connection.

The number of network interfaces in MikoPBX is not limited.

The 'Network interface with internet access' is the primary network interface through which access to external addresses (non-local) will be established.

If no DNS server address is specified, the default server 8.8.8.8 will be used.

Depending on your network topology, you need to perform the following steps to configure MikoPBX. The PBX can be behind a network router, which is the most common scenario, or it can have a public IP.

• If the PBX is behind a router, you need to check the 'This station is located behind a NAT router' option.

• If you know the external address of the station (IP or domain name) and have forwarded the ports of the PBX to the external world, it is recommended to fill in the fields 'External IP address of your router' or 'External hostname of your router'.

For all addresses that are not local to the PBX, the station will be represented by the external address:

If 'External IP address of your router' is empty and 'External hostname of your router' is filled, the PBX will be represented by the hostname (External hostname) field.

1. Go to the 'System' → 'System file customization' section.

1. Open the file '/etc/static-routes' for editing.

1. Select the 'To replace all' mode and insert the rule. For example, 'route add -net 54.246.198.136 netmask 255.255.255.255 gw 172.16.32.15 dev eth0'

We specify to the operating system that the specified IP address 54.246.198.136 can be found through the network interface 'eth0' and the request should be directed to the gateway (172.16.32.15).

The netmask '255.255.255.255' indicates that the rule will only be applicable to the address 54.246.198.136. If you need to create a rule for a group of addresses, for example, the entire subnet 54.246.198.0: In fact, it is the range of addresses from 54.246.198.1 to 54.246.198.254.

Click "Save settings".

General Information

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

Registration gives you access to additional modules and extensions. These include both free modules (moved out of the core system for easier initial setup) and paid modules from us and third-party developers. If you are a developer, you can contact us at 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:

To start the registration process, click the Register in Marketplace button:

The license key stores all your licenses for MikoPBX products. If you already have a key, you can enter it in the corresponding field. If you've forgotten your key, search your email inbox for messages from lic@miko.ru

If you don’t have a key, you can generate a new one by completing the registration form:

• Organization Name – Enter your company/organization name.

• Contact Email – Enter your organization’s email address.

• Contact Person – Enter the name of the contact person.

Click Register.

Upon successful registration, you will see the following screen:

• A notification confirming the system's registration.

• The license key field will display a blurred value by default. Hover over it to view or copy the key.

To manage your license, go to Marketplace -> License Management and click the corresponding option:

You will be redirected to the :

Enter your license key in the Enter your license key or activated coupon field and click Login:

You will access a system with nine sections:

Go to the Session monitor section:

In the Info column, click the i button for each binding to view detailed host information.

In the Action column, use the Drop button to unbind the license from the current host.

If you encounter issues during registration, check for internet access to the MikoPBX server. Ensure connectivity to lic.miko.ru and lic.mikopbx.com over port 443 (HTTPS). Verify firewall settings and network permissions.

MikoPBX periodically connects to licensing servers to verify installed modules. If a module license becomes unavailable, the module will be disabled, and a strikethrough key icon will appear next to its name.

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.

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

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.

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.

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

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

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

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 files. After uploading, the module will appear in the list under the "Installed Modules" tab.

You can also access the settings of any module for further configuration:

Additionally, you can enable or disable a module.

From the interface of an installed module, you can quickly access its documentation by clicking on the question mark to the right of the module's short description:

You can add any module to the sidebar menu for quick access, which can be useful if you need constant access to the module's settings to change parameters or its status.

To do this, follow these instructions:

1. Go to the settings of the module you want to add to the sidebar menu by clicking on the edit icon to the right of the module's version:

1. Click on the settings icon to the right of the module's status to access the display settings for the module in the sidebar menu:

1. In this section, you can:

• Toggle the display of the module in the sidebar menu—"Show module in sidebar menu".

• Choose the section where it will be displayed—in the example, the "Modules" section is selected.

• Specify a custom name for the module if desired.

After completing the settings, click "Save".

In this section, you can install modules from MIKO as well as from partner developers.

Each module has a button for downloading and installing it. Basic information about the module with a short description is also displayed here.