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

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

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:

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

The simplest way to install MikoPBX is by deploying a ready-made image from the AWS Marketplace. If you wish to launch a custom version of MikoPBX, please refer to the detailed instructions where we describe step-by-step how to create an AMI image from any MikoPBX distribution.

Installing MikoPBX in Google Cloud can be done in two ways: using an image from the Google Cloud Marketplace or from an image based on a file uploaded from the MikoPBX distribution. The first method provides quick and easy deployment of the standard version of MikoPBX, while the second is suitable for intermediate releases.

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

Generating an SMTP Token

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

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:

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 .

• Installation .

• Installation .

• Installation in a .

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

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:

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

Settings Within the Web Interface:

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 .

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 .

Adding and Configuring Employee Accounts

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

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 .

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:

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 .

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.

Configuring the Virtual Machine

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

Installing MikoPBX

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.

First Login to MikoPBX

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.

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

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

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 8 on the keyboard) and press Enter.

You need the command "Update to version ****.*.**". Press the number 2 on the keyboard, then press Enter. The update installation will begin. When it is complete, the PBX will reboot.

After the PBX reboots, the message "The system loaded in Recovery mode" will no longer appear, indicating that the PBX has booted from the hard disk and not from the virtual optical drive. The installed update version will be displayed in green at the top.

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.

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:

# Update package list and install required dependencies
sudo apt update
sudo apt install apt-transport-https ca-certificates curl software-properties-common

# Add the GPG key for Docker's official repository
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

# Add Docker's repository to the APT sources list
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

# Install Docker CE
sudo apt update
sudo apt install docker-ce

# Install Docker Compose
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

# Verify Docker Compose version
sudo docker-compose --version

Creating a user and directories on the host system

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

Useful commands

Command to connect to the PBX console:

Command to connect to the PBX console menu:

Connecting to sngrep for SIP analysis

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

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

Registration in the modules marketplace

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

Module management in MikoPBX is an interface for managing additional system components that expand its functionality. Here, administrators can install, update, enable or disable modules, adding new features or integrations with external services. This section allows you to adapt the system to the specific needs of the company, ensuring flexibility and scalability of the telephone network.

Application dialplans

MikoPBX dialplan applications are a set of tools that allow you to set up individual call processing scenarios within the system. With their help, you can define a sequence of actions that the system will perform when a call is received or made. This may include redirecting a call to a specific extension, playing special audio messages, requesting additional information from the caller, or performing other functions.

Using dialplan applications, you can flexibly customize the logic of the telephone system to the needs of your business without delving into complex programming. This makes it easier to create complex call processing scenarios, allowing you to improve the efficiency of communications and improve the level of customer service.

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.

Firewall

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.

Anti brute force (Fail2Ban)

The "Anti brute force (Fail2Ban)" section in MikoPBX is a tool for ensuring system security from unauthorized access and network attacks. Fail2Ban monitors event logs and automatically blocks IP addresses that make suspicious or repeated failed login attempts. Setting up this section helps prevent system hacking and protect the organization's confidential data.

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

Uploading a sound file to the PBX

Audio files in MikoPBX are used in various call scenarios and interactive voice menus (In IVR menu, during non-working hours, in call queues, for various system notifications, and in hold music.) to play voice greetings or notify customers.

The list of available sound files is displayed in the "Telephony" -> "Sound files".

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

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.

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.

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.

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:

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

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.

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

1. Add the roles Cloud Infrastructure Manager Agent, Compute Admin, Compute Network Admin, Service Account User

1. Click the DONE button

Creating a virtual machine

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

Starting MikoPBX

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

Sign in to the service Amazon Web Services https://aws.amazon.com

Let's get started with the setup

Creating a virtual machine

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

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

3. In the AWS Marketplace AMIs section select the image (x86 or ARM version) by clicking the Select button

4. On the opened tab click Subscribe now

5. Click the Launch an instance from AMI button to create a virtual machine

1. Enter the virtual machine name, for example mikopbx-vm

If you have an SSH key

1. Specify the SSH key in the Key pair field

If you don't have an SSH key

1. Select Create new key pair and specify the key pair name, for example mikopbx_key

Follow the instructions further

1. If necessary, change the size of the storage disk in Configure storage, default size is 50Gb

1. Under Network settings, all required Firewall rules are configured automatically

1. For other fields use default values

2. Click Launch instance

Starting MikoPBX

1. Go to the created virtual machine mikopbx-vm

2. On the opened tab, select Connect / EC2 serial console, wait for the system to fully load until the authentication parameters are displayed

1. Copy the external address of the created virtual machine and enter it in the browser's address bar

2. Use the login and password provided in EC2 serial console for login

The "Storage" section in MikoPBX allows you to monitor disk space usage and manage data storage settings. It provides a detailed breakdown of occupied space by category: call recordings, system logs, backups, and other files. In addition to local storage monitoring, the section allows you to configure automatic upload of recordings to an S3 cloud storage.

Section location: "Maintenance" -> "Storage".

Storage information

The "Storage information" tab provides an overview of disk space usage.

At the top of the page there is a block with a horizontal chart that visually shows what share of the total disk volume each data category occupies. In the example, 56.0 GB out of 100.0 GB is used. Each segment of the chart is color-coded according to the legend:

• 🟠 Call recordings

• 🟣 Call history

• 🔵 System logs

• 🟢 Additional modules

At the bottom of the page there is a list of data categories and the amount of storage each one occupies.

Local Storage

The "Local Storage" tab allows you to set the retention period for call recordings on the station. Use the slider to select the desired period:

• 30 days (1 month) — minimum retention period.

• 90 days (3 months) — recommended for small businesses.

• 1 year — for compliance with legal requirements.

Click "Save" to save the settings.

S3 Cloud Storage

This tab is used to configure automatic upload of call recordings to an external S3-compatible storage (e.g.: Amazon S3, MinIO, Wasabi).

At the top of the tab there is a toggle "Automatic recording upload to cloud storage" — it enables or disables the upload feature.

To connect to a bucket, fill in the following fields:

• S3 endpoint URL — the address of the storage service (e.g., https://storage.yandexcloud.net for Yandex Cloud S3).

• S3 region — the region where the bucket is located (e.g., ru-central1 in our case).

• S3 bucket name — the name of the bucket where recordings will be uploaded.

Click "Save" to save the settings.

Next, click the "Test Connection" button — the system will perform a test connection and display the result at the top of the page. Upon successful connection, the message "S3 connection successful" will appear and synchronization of call recordings will begin.

At the bottom of the tab there is a "Local storage period (S3 mode)" slider — it determines how long recordings will be stored locally on the station after being uploaded to the cloud before being automatically deleted. The local retention period cannot exceed the total retention period.

Instructions for connecting cloud storage

Creating a Bucket and Access Keys

1. Go to the DigitalOcean console (link).

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

1. On the bucket creation page, under Choose a datacenter region, select the region closest to your MikoPBX server. Choose Standard Storage.

1. In the Choose a unique Spaces Bucket name field, enter a name of your choice for the bucket.

Click Subscribe & Create Bucket.

1. Open the page of the newly created bucket by clicking its name in the Buckets section.

1. Go to the Settings tab.

1. Scroll down to the Access Keys section. Click Create Access Key to generate a new key pair.

1. Fill in the required parameters for the new key:

• Select access scope — Limited Access.

• Buckets — select the bucket you created earlier.

• Permissions — Read/Write/Delete.

Click Create Access Key.

Your key pair values (Access Key ID and Secret Key) will be displayed. Save these values — you will need them when configuring MikoPBX.

Connecting to MikoPBX

1. Go to the Maintenance → Storage tab.

1. Open the S3 Cloud Storage tab and fill in the following fields:

• Automatically upload recordings to cloud storage — enable the toggle.

• S3 Endpoint URL — enter https://sgp1.digitaloceanspaces.com, replacing sgp1 with your region.

• S3 Region — enter the region of your DigitalOcean bucket (e.g. sgp1

Use the Local Storage (S3 mode) slider to configure how long recordings are kept locally before being deleted after upload to the cloud.

Click Save.

After saving the settings, click Test Connection. If the connection is successful, you will see the message "S3 connection successful" and synchronization of call recordings will begin.

Settings in Microsoft Entra

Application Registration

1. Sign in to the

1. Go to "Entra ID" -> "App registrations". Then click "New registration" to register a new application.

1. Select the following parameters for your application:

• Name - enter a name for your application.

• Supported account types - select "Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)".

1. Specify the Redirect URL:

• Select a platform — select "Web".

• URL:

Replace 192.168.100.71 with your MikoPBX address.

Then click "Register".

1. The application will be created. Save the Client ID — you will need it in the future for configuration inside the MikoPBX web interface.

Granting Permissions and Creating a Client Secret

1. From the application's main page, go to "Manage" -> "API permissions".

1. Click "Add a permission".

1. In the "Microsoft Graph" section, select "Delegated Permissions". Enter "SMTP" in the search bar. Check the box next to "SMTP.Send".

1. Also enter "offline" in the search bar. Check the box next to "offline_access".

Click "Add permissions".

1. Next, go to "Certificates & secrets" -> "Client secrets". Click "New client secret".

1. Set the required parameters:

• Description - an arbitrary description.

• Expires - the duration for which you are issuing this client secret. It will be needed for application authentication in MikoPBX.

Click "Add".

1. Copy the "Value" (not the Secret ID!). It will be needed for configuration in the MikoPBX web interface.

Granting Permissions to a User

For the application to work correctly, you need to grant permission to use the SMTP protocol for the user whose mailbox you are authorizing during this setup. To do this, follow these steps:

1. Go to the organization's admin center ().

1. Go to "Users" -> "Active Users". Click on the name of the user account under which the application is being created.

1. In the account, go to the "Mail" section and select "Manage email apps".

1. Make sure that "Authenticated SMTP" is allowed. Save the changes by clicking "Save changes".

Settings in MikoPBX

1. Go to the MikoPBX web interface. Then "System" -> "Mail and Notifications" -> "SMTP Settings".

Fill in all the required fields:

• Sender address, Sender name — your email and the name from which the emails will be sent.

• Authentication type — OAuth2.

• SMTP login — your email.

Leave all other settings at their default values. A more detailed description can be found in the main article about mail parameters ().

After that, click "Save"!

1. Click "Connect via OAuth2". Sign in to your Microsoft account. Then confirm granting all requested permissions.

Upon successful authorization, you will see the corresponding window.

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

Behaviour in Docker containers

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.

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. Select Action / New / Virtual Machine

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 .

Creating a virtual machine

1. Go to UTM. Click "Create a New Virtual Machine" to create a new virtual machine.

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 .

Uploading the Image to DigitalOcean

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"

Loading the MikoPBX image

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

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 [email protected] to get instructions on creating and adding your module to the Marketplace.

Additional modules allow you to expand the functionality of the main system. In this guide, you will find information on managing modules and installing applications using the built-in Marketplace.

Detailed instructions for configuring and operating each module can be found .

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

REST API MikoPBX allows you to automate station management and integrate it with external systems - CRM, helpdesk, corporate portals, and custom services. API keys are used to access the API.

Authorization

All REST API requests are authorized via the Authorization: Bearer <token> header. MikoPBX supports two token types:

Preparation

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

2. Boot the machine in.

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.

This method involves creating a backup of your current MikoPBX configuration, transferring it, and restoring it on the new server. It’s simple to implement and suitable for small systems. This approach is convenient for users with minimal technical experience.

1. First, create a backup of your previous system. You can find detailed instructions in .

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

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

Configuring Scheduled Backup

First, you need to configure scheduled backups for the MikoPBX you want to transfer data from.

Method 1

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