Description of MikoPBX and the sections you can find in the documentation. Introduction to the documentation.
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:
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:
– here you'll find a detailed description of the registration process and its specifics.
– this section provides a detailed explanation of how to install and manage modules.
– 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.
5 - 10
1 GHz x86-64, 512 MB RAM
Up to 25
3 GHz x86-64, 1 GB RAM
Over 25
2 CPUs 3 GHz x86-64, 2 GB RAM or more
Discription of system requirements for the MikoPBX system
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
We recommend using two hard drives for PBX deployment.
800 Mb hard disk for the main system
A 50+ Gb hard drive for recording conversations
1 (2 cores) x86-64 processor
A PC with such parameters, in our tests, holds 38 simultaneous incoming calls under the conditions:
10 agents are connected to the queue (all online)
Every second a new call comes in
Approximately, 1 hour of conversation takes up 14MB of disk space. The recommended size for the disk storing call recordings is at least 50 gigabytes.
Description of the first login to the MikoPBX web-interface
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:
Use the following default credentials for the first login to the MikoPBX web interface:
Username: admin
Password: admin
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 .
This guide provides detailed steps to get started with MikoPBX and helps you quickly configure the system.
Follow the step-by-step instructions in the order presented for a quick and successful system setup.
MikoPBX is a full-fledged operating system for your hardware; it is not a standalone application. It is provided as an image file (*.iso, *.img, *.raw).
It supports various installation methods:
Network Adapter
Music (MOH) is played to the client while waiting
Modules on the PBX is not installed
Installation on a standalone computer.
Installation in a virtual machine.
Installation using cloud services.
Installation in a Docker container.
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:
If the logs do not provide a username and password, use the default credentials:
Username: admin
Password: admin
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 here.
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 here.
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 here.
After completing the initial PBX setup, you can proceed to create accounts for your employees. This instruction will assist you.
After adding employees, you need to connect providers to your PBX. Instructions for this section can be found here. Instructions with examples of configuring real providers can be found here.
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 this article.
Information on registering in the MikoPBX Marketplace can be found here.
