arrow-left

All pages
gitbookPowered by GitBook
1 of 4

Loading...

Loading...

Loading...

Loading...

MikoPBX Manual

Description of MikoPBX and the sections you can find in the documentation. Introduction to the documentation.

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

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

Simultaneous Calls
Minimally Recommended Configuration

hashtag
Where to Start?

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

  • Installation .

  • Installation .

  • Installation .

  • Installation in a

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

  • .

  • .

  • .

  • .

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

hashtag
Modules

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

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

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

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

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

hashtag
FAQ Section

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

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

.

.

  • .

  • 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

    on a standalone computer
    in a virtual machine
    using cloud services
    Docker container
    Telephony
    Call Routing
    Modules
    Maintenance
    this article
    Registration in the MikoPBX Marketplace
    Module Management
    Documentation on Specific Modules
    Telegram Communityarrow-up-right
    MikoPBX Interface
    Network and Firewall
    System

    Quick start

    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.

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

    • Installation .

    • Installation .

    • Installation in a .

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

    hashtag
    First Login to the Web Interface

    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:

    circle-check

    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.

    hashtag
    Settings Within the Web Interface:

    hashtag
    Network and Firewall Settings

    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 .


    hashtag
    Configuring Protection Against Hacking (Fail2Ban)

    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 .


    hashtag
    Adding and Configuring Employee Accounts

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


    hashtag
    Connecting Providers

    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 .


    hashtag
    Setting Up Incoming and Outgoing Routing

    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:


    hashtag
    Marketplace and Modules

    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 .

    circle-info

    This completes the basic setup of MikoPBX! For a deeper exploration of MikoPBX's capabilities, we recommend referring to the comprehensive documentation.

    on a standalone computer
    in a virtual machine
    using cloud services
    Docker container
    here
    here
    here
    instruction
    here
    herearrow-up-right
    Incoming Call Routing
    Outbound Call Routing
    Call Queues
    IVR Menu
    Conferences
    this article
    here
    Example of MikoPBX Console
    MikoPBX login window

    Getting to know MikoPBX

    Description of the first login to the MikoPBX web-interface

    hashtag
    First login to the MikoPBX system

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

    MikoPBX IP address for connecting to the WEB interface

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

    circle-check

    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:

    circle-info

    For more information about the General Settings, see the section.

    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 .

    General Settings
    the link
    Authorization page in the web interface
    First authorization in the MikoPBX WEB interface

    System requirements

    Discription of system requirements for the MikoPBX system

    hashtag
    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

    circle-info

    The calculation is approximate, when using the same codec on all devices connected to the PBX. Read more .

    hashtag
    Minimum system requirements

    circle-exclamation

    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

    circle-check

    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)

    circle-exclamation

    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.

    2 GB of RAM

  • Network Adapter

  • Every second a new call comes in
  • Music (MOH) is played to the client while waiting

  • Modules on the PBX is not installed

  • herearrow-up-right