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 .

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

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

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

MikoPBX supports installation using many virtual machines. In this section you can find detailed instructions for them. Click on an item in the list below to go to the instruction for a specific virtual machine:

MikoPBX supports installation via many cloud services. In this section you can find detailed instructions for them. Click on an item in the list below to go to the instruction for a specific virtual machine:

MikoPBX can be run in Docker using two main methods. The first method involves running the container directly using a Docker command with the necessary parameters. The second method involves using Docker Compose, which simplifies managing multi-container applications and allows the entire configuration to be described in a yaml file, making the deployment and maintenance of the system more convenient.

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

Extensions

Extensions in MikoPBX are individual users of the system who are assigned internal numbers for making and receiving calls. They have personal accounts that allow you to configure access rights, call forwarding and other personal settings in the system.

In this article, you will find detailed documentation on adding new employees to the station, setting up their rights and profiles. In addition, information about their additional parameters.

Call queues

Call queues in MikoPBX are a feature that allows you to distribute incoming calls between a group of operators, holding calls in a queue until an operator becomes available. This ensures efficient management of a large call flow and improves customer service.

In this article, you will find detailed documentation on creating and configuring such queues.

IVR Menu

IVR menu in MikoPBX is an interactive voice menu that allows callers to interact with the phone system by pressing keys or using voice commands. It automatically routes calls to the right departments or employees, improving call handling efficiency and customer service.

In this article, you will find documentation on creating and configuring an IVR menu.

Conferences

Conferences in MikoPBX are a feature that allows you to organize group phone calls with multiple participants at the same time. It allows you to hold group discussions, meetings and appointments over the phone, improving communication both within the company and with external partners.

In this article, you will find documentation on creating and configuring conference rooms.

Sound files

Sound files in MikoPBX are audio recordings that are used by the system to play various messages, such as greetings, announcements, IVR menu instructions or waiting signals. They allow you to personalize the audio content that callers hear, improving interaction with the system and providing the necessary information.

In this article, you will find detailed information about them, as well as how to add and edit them.

Call detail records (CDR)

Call detail records in MikoPBX is a log that stores information about all incoming and outgoing calls through the system. It provides detailed data about each call, including time, duration, participant numbers and status, which allows you to analyze communications and optimize the operation of the company's telephone network. In this article, you will find information about storing call records and their filters.

The "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 (Outbound 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 (Night and Holiday Switch)

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.

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

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.

SSH (Secure Shell) is a protocol used for secure remote connections and server management. It allows you to run commands, transfer files, and administer systems through an encrypted channel. SSH protects your data from interception by providing authentication and encryption between the client and the server. It is a primary tool for developers, system administrators, and DevOps engineers when working with remote machines.

Below are three different methods for connecting to MikoPBX via the SSH protocol:

• Password-based connection using third-party applications (this article uses PuTTY as an example)

• Key-based connection, demonstrated with examples on Windows, Linux (MacOS)

• Connection using Google Secure Shell Extension.

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

Uploading a sound file to the PBX

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:

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

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.

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.

General settings

In the "General settings" section of MikoPBX, administrators can manage the main system parameters, such as call recording retention settings, notifications, log parameters, voice prompt language, and many other system options. This section provides control over general functions and behavior of MikoPBX, allowing you to optimize the system's operation according to the organization's needs.

The Maintenance section of MikoPBX is an interface for managing the technical aspects of the system and ensuring its stable operation. Here, administrators can perform tasks on data backup and recovery, software updates, system status monitoring, and event log management. This section helps maintain the functionality of the telephone system, promptly detect and eliminate possible problems.

PBX update

The "PBX update" section in MikoPBX is an interface for managing system software updates. Here, administrators can check for new versions, install updates, and view the change history. Regular use of this section ensures that MikoPBX is up-to-date, secure, and stable.

The "Network and Firewall" section of MikoPBX is an interface for configuring network settings and managing the system's firewall. Here, administrators can configure IP addresses, network interfaces, and create firewall rules to protect the system from unauthorized access. This section ensures the secure and stable operation of MikoPBX in the organization's network infrastructure.

Network interface

The "Network Interface" section in MikoPBX is an interface for configuring the system's network connection parameters. Here, administrators can manage IP addresses, subnet masks, gateways, and other network settings for each network interface. This allows MikoPBX to be correctly integrated into the organization's network and ensure its stable operation in accordance with the requirements of the network infrastructure.

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.

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.

Preparation

Installing Docker and Docker Compose on Ubuntu 22.04

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

The "Modules" section in MikoPBX is an interface for managing additional functional components of the system, which includes two subsections: "Module Management" and "Dialplan Applications".

Managing these subsections allows you to configure MikoPBX as flexibly and efficiently as possible, expanding the functionality of the telephone system and adapting it to the unique requirements of the organization.

Registration in the modules marketplace

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

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.

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

Installing the system on a USB drive

Windows

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

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

• File system - FAT32

• Allocation unit size - 8192 bytes

1. Open balenaEtcher. Click "Flash from file" and select the previously downloaded .raw file.

1. Click "Select target".

1. From the list, select your USB drive. Then click "Select 1".

1. Next, click "Flash!"

Wait for the process to complete. Then proceed to the section .

MacOS

1. Connect your USB drive and open the Terminal.

1. Run the following command:

This command displays all connected disks. Look for the disk labeled (external, physical). In our case, it is disk4 (the number may differ on your system). Use this number in the following steps.

1. Next, format the USB drive using this command:

Enter your administrator password when prompted and wait for the formatting to complete.

1. Unmount (disconnect) the disk using the following command:

1. Write the image to the USB drive using this command:

Wait for the writing process to complete. Then proceed to the section .

Linux

In this example, the image writing process will be demonstrated on Ubuntu 24.04.

1. Connect your USB drive and open the Terminal.

1. Run the following command:

This command displays information about all connected disks. Find your USB drive in the list and note its name. In our case, it is sdb.

1. Next, format the USB drive using this command:

Enter your administrator password when prompted and wait for the formatting to complete.

1. Unmount (disconnect) the disk using this command:

1. Write the image to the USB drive using this command:

Wait for the process to complete. Then proceed to the section .

Booting from USB drive

1. Boot from the USB drive. If errors occur (black screen), make sure that:

• Secure Boot - Disabled

• CSM (Compatibility Support Module) - Enabled

1. The system has successfully booted, but no drive is connected for storing call recordings. To connect it, use the arrow keys to navigate to "[6] Data storage" and press Enter.

1. Then select "Mount drive as data storage" to connect the disk.

1. Select the disk that will be used to store call recordings. Enter its ID (name), for example sdc in our case, and press Enter.

1. After this, the system will reboot and will be ready for use and for the first login to the Web interface.

To open the Web interface, enter your MikoPBX IP address in your browser’s address bar. Use the default login credentials.

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.

Advanced Options

• 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

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

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

Updating using Docker compose

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

The next step is to download the latest MikoPBX image:

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

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

Notes

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

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.

Update using a downloaded img file

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.

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.

Connecting in MikoPBX

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:

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:

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.

Generating and Linking the Key

To begin, you need to install OpenSSH on Windows. You can do this from this link.

1. After installation, verify it by entering the following command in PowerShell:

You should see the OpenSSH version displayed:

1. Next, generate an SSH key by entering the following command:

This will generate an "ed25519" key with the comment "" to identify it. You can specify a path for the keys by adding -f and a path, for example:

After this, the key pair will be created in the specified directory. One file will contain the public key, and the other the private key.

1. Run the following command to retrieve the public SSH key:

Copy the public key from the output.

1. Open the MikoPBX web interface and go to "System" → "General Settings":

1. Navigate to the SSH section and paste the public key into the "SSH Authorized Keys" field in the following format:

Click "Save settings":

Connecting via SSH

To connect via SSH, run the following command in PowerShell:

Replace the following based on your parameters:

• The path to your SSH key.

• The IP address of your MikoPBX instead of mikopbxipadress.

You will then be connected to the MikoPBX console via SSH:

To receive notifications about missed calls by email, you need to configure the SMTP client. Detailed information about notifications in MikoPBX is reviewed here. As part of this instruction, an example of setting up missed call notifications for the Gmail mail service will be considered.

1. Enter the IP address of the MikoPBX PBX in the browser and go to System → Mail Settings

SMTP Client Settings for Gmail service:

• SMPT host - smtp.gmail.com

• SMPT port - 465 (Customer Service port)

• SMPT login and Sender address- the E-mail from which messages about missed calls will be sent

1. Save the entered settings and proceed to setting up your email account. A feature of the Gmail service is that access to your account is automatically denied to untrusted applications, which include MikoPBX, so you need to manually allow access to these applications (setup instructions are posted ).

2. Go back to System → Mail Settings. We will send a test letter to the e-mail of any service. In case of successful testing, a test email will be sent to the email address you specified.

You can read about how to set up a letter template to create an E-mail notification .

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.

Resetting the Password in a Docker Container

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:

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.

Create the IP Check Script

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

2. Create a new script file with this command:

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

1. Press CTRL+D to finish.

2. Make the file executable:

Schedule the Script

1. Go to the MikoPBX web interface → "System" → "System file customization":

1. Open the file: /var/spool/cron/crontabs/root

1. Append the following line to the end of the file:

This schedule runs the script every minute to check for a changed public IP. If the IP has changed, it re-registers all providers.

Writing the image to a USB drive

Windows

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

Creating a Virtual Machine

1. Start by creating a new virtual machine.

2. Enter the

Creating a virtual machine

1. Select Action / New / Virtual Machine

Loading the MikoPBX image

1. Open the local / ISO images tab and select Download from URL

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 .

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 .

Sign in to the service Amazon Web Services

MikoPBX in AWS Marketplace:

Let's get started with the setup

Creating a Bucket and Access Keys

1. Go to the DigitalOcean console ().

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

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