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.

After successful authorization, MikoPBX will automatically open the settings for changing the password

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

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:

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 on a standalone computer.

• Installation in a virtual machine.

• Installation using cloud services.

• Installation in a Docker container.

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

• Telephony.

• Call Routing.

• Modules.

• Maintenance.

• Network and Firewall.

• System.

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

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. Registration in the MikoPBX Marketplace – here you'll find a detailed description of the registration process and its specifics.

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

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

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 Telegram Community, 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 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.

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

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

Adding and Configuring Employee Accounts

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

Connecting Providers

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.

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:

• Incoming Call Routing

• Outbound Call Routing

To create routing rules, you may also need the following features:

• Call Queues

• IVR Menu

• Conferences

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

• Information on registering in the MikoPBX Marketplace can be found here.

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.

Create a virtual machine

1. Download Virtual Box from the link and install it.

2. Create a new virtual machine.

1. Specify the Machine Name and Folder.

Type - Linux.

Version - Other Linux (64Bit).

Click Next.

1. Specify the size of the base memory - 1024 MB, as well as the number of processors - 2

Press Next.

1. Select Create a new virtual hard disk. Enter a disk size of 700 MB, and also check the box "Pre-allocate Full Size"

Click Create.

1. Confirm the creation of the virtual machine: click Finish.

Setting up a virtual machine

1. Go to the settings of the created virtual machine.

To do this, click Settings.

1. Click the Storage tab. Add a new hard drive to store call records.

1. In the window that appears, click Create.

1. Select the hard disk format - VDI (VirtualBox Disk Image).

Click Next.

1. The hard disk must be of a fixed size.

Check the box next to "Pre-allocate Full Size"

Click Next.

1. Specify the Name of the created disk.

Set the Disk Size to about 50 GB.

Click Finish.

1. Choose the newly created drive and click Select.

1. The created drive will appear in the media list.

1. Please mount the MikoPBX image onto an optical disc. To do this, select the optical disc in the 'Media' section and click on the image file selection button in the 'Attributes' section.

1. In the appeared menu, click on 'Choose a disk file...'

1. Select the downloaded ISO disk image.

1. "Go to the 'Network' tab.

Set the Connection Type to 'Bridged Adapter'. Click 'OK' to save all the settings you have made.

Installantion MikoPBX

1. Start the created virtual machine.

1. The command interface of the PBX will open. The PBX will start booting.

At this stage, MikoPBX is booting from the optical disc containing the ISO image. This is indicated by the message: 'The system is loaded in Recovery mode'.

1. Install MikoPBX.

Click Install.

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

1. Enter the name of the disk you referred to as the 'system disk' from the keyboard, in this case sdb, and press Enter. (If it is selected by default, you can simply press Enter).

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

1. After completing the installation, you will be prompted to select a disk for storing call records.

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

1. After the installation is complete, the system will reboot.

MikoPBX will now run from the sdb drive where you installed it.

We will see that the line "The system is loaded in Recovery mode" is missing.

The first login to MikoPBX

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

The default login and password are "admin" for MikoPBX.

The installation of MikoPBX is now complete.

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

Data storage disk

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 New button

5. On the Choose disk format tab, select VHD

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

Installing MikoPBX

1. To start the virtual machine, click 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

Starting MikoPBX

1. On the open Connect tab, copy the external address of the created virtual machine and enter it in the browser address bar

1. To log in, use the username - admin and password - admin

This guide covers creating and configuring a virtual machine in VMware Workstation Pro and installing MikoPBX on it.

You can download the VMware Workstation Pro installer from the official website.

Creating a Virtual Machine

1. Open VMware Workstation Pro and click "Create a New Virtual Machine" to start creating a new virtual machine.

1. In the setup interface, select the virtual machine type: "Typical (recommended)". Then, click "Next >".

1. Choose the installation source, "Installer disc image file (iso):". Select the .iso file you want to use. You can download the distribution from this link. Click "Next >" to continue.

1. Select "Linux" for the "Guest operating system" and "Debian 11.x 64-bit" as the version. Click "Next >".

1. Enter a desired name for the virtual machine in "Virtual machine name:" and, if necessary, specify a location on your computer under "Location". Click "Next >".

1. Set the size for the primary (system) hard drive, with a recommended size of 1GB. Choose "Split virtual disk into multiple files" and click "Next >".

1. A summary of the virtual machine configuration will appear. Click "Finish" to create the virtual machine.

Adding and Connecting a Second Disk

Now, let's create and attach a second hard drive, which will be used to store call recordings.

1. Open the settings of the previously created virtual machine.

1. Click "Add..." to add a new system component.

1. In Hardware types, select "Hard Disk" and click "Next >".

1. Choose "Virtual disk type" - "SCSI". Click "Next >".

1. Choose "Create a new virtual disk" and click "Next >".

1. Specify the disk size, with a recommended minimum of 50GB. Also, choose "Split virtual disk into multiple files". Click "Next >".

1. Give the hard drive a custom name and click "Finish".

Configuring the Network Interface for the Virtual Machine

In the settings, go to "Network Adapter" and select "Network connection" - "Bridged: Connected directly to the physical network". Click "OK".

First System Boot

1. Start the virtual machine.

1. The MikoPBX command-line interface will open as the PBX starts loading from the optical disk where the ISO image was mounted. This is indicated by the line: "The system is loaded in Recovery mode":

1. To install MikoPBX, select "[8] Install".

2. A list of available disks will be displayed (in this example, sdb, sdc). The system suggests a default disk, sdb in our case, for the installation. If you agree with the suggested disk for the system, press Enter. Otherwise, enter the name of another disk.

1. The system will issue a warning. To confirm the operation, enter "y" and press Enter.

2. After installation, you'll be prompted to select a disk for storing call recordings. Enter the disk name (in this example, sdc) and press Enter.

1. After installation, the system will restart. MikoPBX will now boot from sdb, the installation disk, without the line "The system is loaded in Recovery mode"—indicating a successful installation.

First Login to MikoPBX

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.

Enter the IP address in your browser’s address bar. 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

• GSM - 1.68 Mbps

• G.722 - 4.67 Mbps

• G.729 - 1.38 Mbps

Minimum system requirements

• 800 Mb hard disk for the main system

• A 50+ Gb hard drive for recording conversations

• 1 (2 cores) x86-64 processor

• 2 GB of RAM

• Network Adapter

Sign in to the service Amazon Web Services

To follow the instructions, install the Amazon Command Line Utility by opening Terminal and entering the following command

Let's get started with the setup

Copying access keys

1. Go to your account

2. From the dropdown menu, select Security credentials

If you don't have an access key, do the following

1. Under the Access keys table, select Create access key

2. Copy the Access key and Secret access key

If you already have an access key, simply copy the Access key and Secret access key

Creating a bucket

1. Open Services / Storage / S3

2. On the tab select Create bucket

3. Enter a unique bucket name

1. Use default values for other fields

2. After entering the values, click Create bucket

1. Open the created bucket and select Upload

2. On the opened tab select Add files

3. Upload the file from the MikoPBX distribution with the .raw extension

4. Click Upload

5. Wait for the file to finish uploading

Adding permissions and attaching policies

If not done previously for this cloud

1. Create a separate folder for files on your computer

2. Create a file named trust-policy.json in the folder

   1. Open Terminal and navigate to the created folder

   2. Run the command vi trust-policy.json

   3. Enter editing mode by pressing i and paste the text

   4. Press ESC and type :wq to save the file

1. Similarly, create a file named role-policy.json and change the bucket name value in the text to the name of your created bucket

1. Similarly, create a file named import-image.sh, change the DEFAULT_BUCKET parameter value to the name of your created bucket and the DEFAULT_IMAGE parameter value to the name of the image uploaded to the bucket

1. Run the command aws configure, specify the region and copied Access key and Secret access key

1. Run the command

1. Run the command

1. Run the command

If the command executes successfully, a unique AMI identifier will be generated

Creating a virtual machine

1. Open Services / Compute / EC2 and navigate to Images / AMIs

2. Select the created image and click Launch an instance from AMI to create a virtual machine

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

1. Specify the instance type - t3.micro

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. In the Network settings section, check Allow SSH traffic and Allow HTTPS traffic

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

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

Sign in to the service Amazon Web Services

MikoPBX in AWS Marketplace:

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

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

Loading the MikoPBX image

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

2. In the URL field, paste the link to the MikoPBX distribution file with the .iso extension

3. Click the Download button and wait for the file to finish downloading

Creating a virtual machine

1. Select Create VM

2. On the General tab, enter the name of the virtual machine, for example mikopbx-vm

1. Go to the OS tab, and in the ISO image field, select the previously downloaded image

2. Set the OS type to Linux

1. On the System tab, uncheck the Qemu Agent box, and use the default values for other fields

1. Go to the Disks tab

2. Adjust the size of the system disk to 1 GB

1. Click the Add button and add an additional disk for data storage

2. Specify a disk size of at least 50 GB

1. On the CPU and Memory tabs, specify the computing resources for the virtual machine based on the expected load on the PBX. For a test machine, you can set Cores (CPU tab) to 2 and Memory (Memory tab) to 2 GB

1. On the Network tab, uncheck the Firewall box

1. Go to the last tab, Confirm, and check the Start after created box

2. After entering the values, click the Finish button

Installing MikoPBX

1. Go to the created virtual machine mikopbx-vm

2. On the open tab, go to the Console section

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

1. Select the disk for the system 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, enter the disk name for connection from the keyboard, for example sdb

Starting MikoPBX

1. On the open tab in the Console section, copy the external address of the created virtual machine and enter it in the browser address bar

1. To log in, use the username - admin and password - admin

Most modern PCs support booting from a USB device. MikoPBX can be run from a USB device.

Using Windows

To create a bootable USB drive, we recommend using the imageUSB application. You can download it . Alternatively, use .

1. Download and install the application.

2. Run ImageUSB

1. Perform the "Refresh drives" action. Select the USB drive, then select the image file. Perform the "Write" action.

1. Wait for the writing process to complete, then connect the USB drive to the PC. Restart the PC to boot from the drive.

Using OSX

1. Open the Terminal application.

2. Connect the USB drive.

3. Run the following command:

Information about all connected drives will be displayed.

In this example, the name of the USB device is "/dev/disk3." Compare the output of the diskutil list command before and after connecting the device.

1. Format the drive. You will need to enter the administrator password.

1. Unmount the device with the following command:

1. Write the image to the USB drive:

Wait for the writing process to complete, then connect the USB drive to the PC. Restart the PC to boot from the drive.

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.

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.

First, log in to the Microsoft Azure portal

Let's proceed with the setup.

Creating a resource group

1. Open Menu / All services / General / Resource groups

2. In the Resource groups tab, select Create

3. Enter the group name, for example MikoPBX_group

4. Use default values for other fields

5. After entering the values, click the Review + create button, then the Create button

Creating a storage account

1. Open Menu / All services / Analyze and transform data / Storage accounts

2. In the Storage accounts tab, select Create

3. Specify the created resource group MikoPBX_group

4. Enter the storage account name, for example pbximgs

5. Use default values for other fields

6. After entering the values, click the Review + create button, then the Create button

Configuring the created storage account

1. Go to the card of the created storage account pbximgs

2. In the opened tab, go to the Data storage / Containers

3. Add a new container

4. Enter the container name, for example imgs

5. Click the Create button

1. Open the created container imgs

2. In the opened tab, select Upload

3. Select a file from the MikoPBX distribution with the .vhd extension

4. Click the Upload button

Creating an image

1. Open Menu / All services / Compute / Images

2. In the Images tab, select Create, let's create a new image based on the uploaded *.vhd file

3. Specify the resource group MikoPBX_group

4. Enter a unique name for the image, for example MikoPBX_Azure

1. Specify the OS type - Linux

2. Specify the generation of virtual machines - Gen 1

3. Select the blob storage object by clicking Browse, Browse / pbximgs / imgs / *.vhd

4. Specify the account type - Standard HDD

5. Use default values for other fields

6. After entering the values, click the Review + create button, then the Create button

Creating a virtual machine

1. Open Menu / All services / Compute / Virtual machines

2. In the Virtual machines tab, select Create / Azure virtual machine

3. Specify the resource group MikoPBX_group

4. Enter the virtual machine name, for example MikoPBX-vm

1. Choose the previously created image, See all images / Other items / My images / MikoPBX_Azure

2. Specify the machine size (combination of CPU / RAM to be at least 1GB / HDD parameters)

1. Specify the username for the administrator account

If you have an SSH key, do the following

1. Select the source of the SSH public key - Use existing public key

2. Specify it in the SSH public key field

If you do not have an SSH key, do the following

1. Select the source of the SSH public key - Generate new key pair

2. Specify the key pair name, for example mikopbx_key

Continue with the following instructions:

1. In the license type field, specify Other

2. Use default values for the other fields

1. Go to the Disks tab

2. Specify the OS disk type

3. Check the Delete with VM checkbox

1. Create a new data disk

2. Specify the disk size to be at least 50GB

3. Use default values for the other fields, click OK

1. After entering the values, click the Review + create button, then click Create

Configuring ports for incoming connections

1. Open the virtual machine you created and go to Networking / Network settings / Rules

2. In the tab, choose Create inbound port rule

3. Specify the destination port ranges - 0 - 65535

4. Choose the protocol TCP

1. Specify a name, for example TCP

2. Use default values for the other fields

3. After entering the values, click the Add button

1. Similarly, create a rule for UDP. Specify the destination port ranges - 0 - 65535, protocol UDP, and name

Starting MikoPBX

1. Open the virtual machine you created and go to the Connect section

2. In the drop-down menu under More ways to connect, select Serial console

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

2. For login use the login and password provided in Serial console

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

# Creating a new user (e.g., www-user) without superuser rights
sudo adduser --disabled-password --gecos "" www-user

# Creating directories for data storage
sudo mkdir -p /var/spool/mikopbx/cf
sudo mkdir -p /var/spool/mikopbx/storage

# Granting the created user ownership of the directories
sudo chown -R www-user:www-user /var/spool/mikopbx/

Useful commands

Command to connect to the PBX console:

sudo docker exec -it mikopbx sh

Command to connect to the PBX console menu:

sudo docker exec -it mikopbx /etc/rc/console_menu

Connecting to sngrep for SIP analysis

sudo docker exec -it mikopbx sngrep

Connecting softphones

• MicroSIP

• Groundwire

• Zoiper

• Jitsi

• PhonerLite

• Linphone(Mac OS)

• Telephone(Mac OS)

• WebRTC tutorial using SIPML5

• Configuring telegram as SIP softphone

• Softphone.pro

• Bria Solo

Connecting telephones

• Yealink T19

• Yealink T21

• Yealink T28

• Snom D120

Extensions List

The "Extensions" section displays a list of internal user accounts for employees. On the left side of each employee, the status of the authorized device is displayed. If the device is successfully authorized under the respective internal user account, a green circle is shown; otherwise, it appears gray.

In the search bar, you can find the desired contact. You can search by the employee's name, internal number, mobile number, or email address.

The form also provides the ability to sort the list of employees by name, internal number, mobile number, or email address. There are buttons for copying the account password to the clipboard, editing the account, and deleting the account.

Adding an Employee

To add a new employee, simply click on the "Add new extension" button.

Main Account Settings

On the "Basic Parameters" tab, you can configure the general settings for an employee's internal account:

• Username: This value will be used for name substitution and displayed in the corresponding field on the phone screen.

• Internal Number: This is the employee's internal extension number, which is also used as the login when connecting the phone.

• Mobile Number: It is used for additional routing purposes.

• Email Address: It is used for email notifications.

• Password for SIP

Advanced Account Settings

Accesses the Advanced drop-down list.

Redefining the set string

In the "Redefining the set string" field, enter the dialing rule for mobile numbers according to your provider's requirements.

Call recording

If you want employees to have the ability to record conversations, you can enable the Сall recording feature.

DTMF Mode

The setting determines how DTMF (Dual Tone Multi-Frequency) signals are transmitted over the SIP protocol. DTMF signals are used, for example, when dialing phone numbers or interacting with IVR systems.

Transport protocol

This setting allows you to specify the transport protocol used for this account. The transport protocol determines how data is transmitted over the network. The most common transport protocols used in SIP (Session Initiation Protocol) are UDP (User Datagram Protocol), TCP (Transmission Control Protocol), and TLS (Transport Layer Security)

Network filter

The subnet described in the "Network Firewall" section specifies the allowed subnet for this account. It determines which IP addresses or networks are permitted to connect to this account. Connections originating from other subnets will result in authentication errors.

Manual additional attributes for SIP

This field is used to modify/override the configuration files of Asterisk. You can override almost all parameters. For example, when using chan_pjsip, a SIP account for an employee is described by the following sections:

[***]
type = aor
max_contacts = 10
; ----

[***]
type = auth
; ----

[***]
type = endpoint
context = all_peers
; ----

[acl_***] 
deny = 0.0.0.0/0.0.0.0
permit = 0.0.0.0/0.0.0.0
; ----

To override fields in the sections, you should fill in the "Additional Parameters" field as follows:

[acl]
; Describe access parameters from different subnets [acl_***]

[auth] 
; Describe authentication parameters for outbound calls

[aor]
; Edit AOR section for the endpoint

[endpoint] 
; Edit endpoint parameters

Routing Settings

On this tab, you can set rules for call forwarding when the employee is unavailable, busy, or does not answer.

Set the time period in seconds during which the call will be directed to the employee's internal account. If the employee cannot answer the call within the specified time, indicate to which number the call should be forwarded. By default, the call will be redirected to the employee's mobile number.

You can also specify the numbers to which the call should be redirected in case of busy and unavailable status.

Feel free to configure these parameters according to your preferences and requirements.

To work with MikoPBX in a container, you need to install Docker and Docker Compose, as well as create a user and directories for storing configuration settings and call recordings according to the instructions

Launching the Docker container

To launch the container with your application, use the following commands:

# Pulling the container image
sudo docker pull ghcr.io/mikopbx/mikopbx-x86-64

# Running the container in unprivileged mode
sudo docker run --cap-add=NET_ADMIN --net=host --name mikopbx --hostname mikopbx \
           -v /var/spool/mikopbx/cf:/cf \
           -v /var/spool/mikopbx/storage:/storage \
           -e SSH_PORT=23 \
           -e ID_WWW_USER="$(id -u www-user)" \
           -e ID_WWW_GROUP="$(id -g www-user)" \
           -it -d --restart always ghcr.io/mikopbx/mikopbx-x86-64

Testing the functionality

To ensure that your MikoPBX application is posted and working in the Docker container, you can follow these steps after launching it. These steps will help you verify the container's status and view its logs.

Step 1: Check container status

First, ensure that the container is successfully launched and running. To do this, use the command docker ps, which will show a list of running containers and their statuses.

sudo docker ps

This command will display information about all active containers. Make sure that the mikopbx container is present in the list and its status indicates that it is running (e.g., status up).

Step 2: View container logs

After confirming that the container is running, the next step is to view the logs to ensure that the application has loaded without errors and is functioning properly. The docker logs command will allow you to see the output generated by your application.

sudo docker logs mikopbx

Check the command output for a message similar to the one below. This message indicates that MikoPBX is successfully loaded and ready for use:

++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|               All services are fully loaded welcome                |
|                       MikoPBX 2024.1.60.                           |
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|                        Web Interface Access                        |
|                                                                    |
| Local Network Address:                                             |
| https://10.0.0.4                                                   |
|                                                                    |
| Web credentials:                                                   |
|    Login: admin                                                    |
|    Password: admin                                                 |
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
| SSH access disabled!                                               |
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

If you see the MikoPBX startup process, wait a moment and re-run the command sudo docker logs mikopbx

Step 3: Check access to the web Interface

When the container starts, it lacks information about the host system's address, so you need to open the external address of the host system, in this case, Ubuntu, in a web browser. https://<host machine IP>

Log into the web interface using the admin login and the admin password to make sure that the web interface is accessible and functioning correctly.

Features of containerized MikoPBX

• The NET_ADMIN flag is required for the proactive protection system fail2ban and the firewall iptables to function inside the container. When an access block is triggered, for example, by entering an incorrect password, access from the IP address of the attacker will be blocked.

• If you need to use the "Backup Module", the container should be run with the –privileged flag. When MikoPBX is run in a container, backups can also be performed by manually archiving the cf and storage directories. In this case, the privileged mode is not necessary, but the container must be stopped during copying.

• The –net=host flag indicates that NAT between the host and container will not be used. MikoPBX will be directly connected to the host machine's network. All ports that the container needs to occupy will also be occupied on the host machine. If any port on the host machine is unavailable, errors will occur when loading MikoPBX. More details in the Docker documentation...

• If necessary, you can adjust the standard set of ports used by MikoPBX. This can be done by declaring environment variables when launching the container.

Creating a container from a tar archive

In addition to using our official registry, you might need to create a container from an image, for example, for a beta version. Our published releases and pre-releases include a tar archive, which we use to create a container.

Here is an example code for its use:

# Create a container from a tar archive
sudo docker import \
  --change 'ENTRYPOINT ["/bin/sh", "/sbin/docker-entrypoint"]' \
  mikopbx-2024.1.114-x86_64.tar \
  "mikopbx:2024.1.114"

# Launch the created container
sudo docker run --cap-add=NET_ADMIN --net=host --name mikopbx --hostname mikopbx \
	 -v mikopbx_cf:/cf \
	 -v mikopbx_storage:/storage \
	 -e SSH_PORT=23 \
	 -e ID_WWW_USER="$(id -u www-user)" \
	 -e ID_WWW_GROUP="$(id -g www-user)" \
	 -it mikopbx:2024.1.114

Environment variables for configuring MikoPBX

Below are some of the environment variables that will allow you to adjust the MikoPBX ports and settings used.

• SSH_PORT - port for SSH (22)

• WEB_PORT - port for the web interface via HTTP protocol (80)

• WEB_HTTPS_PORT - port for the web interface via HTTPS protocol (443)

• SIP_PORT - port for connecting a SIP client (5060)

• TLS_PORT - port for connecting a SIP client with encryption (5061)

• RTP_PORT_FROM - beginning of the RTP port range, voice transmission (10000)

• RTP_PORT_TO - end of the RTP port range, voice transmission (10800)

• IAX_PORT - port for connecting IAX clients (4569)

• AMI_PORT - AMI port (5038)

• AJAM_PORT - AJAM port used for connecting the telephony panel for 1C (8088)

• AJAM_PORT_TLS - AJAM port used for connecting the telephony panel for 1C (8089)

• BEANSTALK_PORT - port for the Beanstalkd queue server (4229)

• REDIS_PORT - port for the Redis server (6379)

• GNATS_PORT - port for the gnatsd server (4223)

• ID_WWW_USER - identifier for www-user (can be set with the expression $(id -u www-user), where www-user is NOT a root user)

• ID_WWW_GROUP - group identifier for www-user (can be set with the expression $(id -g www-user), where www-user is NOT a root group)

• WEB_ADMIN_LOGIN - login for Web interface access

• WEB_ADMIN_PASSWORD - password for Web interface access

A full list of all possible setting parameters is available in the source code here.

To work with MikoPBX in a container, you need to install Docker and Docker Compose following the instructions

Docker compose launch option

Here is an example of a docker-compose.yml file that can be used to manage your MikoPBX container via Docker Compose:

services:
  mikopbx:
    container_name: "mikopbx"
    image: "ghcr.io/mikopbx/mikopbx-x86-64"
    network_mode: "host"
    cap_add:
      - NET_ADMIN
    entrypoint: "/sbin/docker-entrypoint"
    hostname:  "mikopbx-in-a-docker"
    volumes:
      - /var/spool/mikopbx/cf:/cf
      - /var/spool/mikopbx/storage:/storage
    tty: true
    environment:
      - ID_WWW_USER=${ID_WWW_USER}
      - ID_WWW_GROUP=${ID_WWW_GROUP}
      # 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

Save the contents into a file named docker-compose.yml, make the necessary adjustments, and launch MikoPBX using the command:

export ID_WWW_USER=$(id -u www-user)
export ID_WWW_GROUP=$(id -g www-user)
sudo docker compose -f docker-compose.yml up

Running Multiple MikoPBX Instances on One Host

Mode Without Network Isolation Between Host and Containers (–net=host)

It is also possible to organize the launch of multiple MikoPBX containers on a single host. However, you need to consider Docker's port handling features. If the –net=host mode is not used, it will lead to a high load on the host system's CPU because Docker creates a separate rule in Iptables for each allocated port.

With the –net=host mode enabled, you need to manually monitor the distribution of available ports between the running containers and built-in applications. For instance, to run two MikoPBX containers on one host, you can use the following configuration file:

services:
  mikopbx-first:
    container_name: "mikopbx-first"
    image: "ghcr.io/mikopbx/mikopbx-x86-64"
    network_mode: "host"
    entrypoint: "/sbin/docker-entrypoint"
    hostname: "mikopbx-in-docker-first"
    volumes:
      - /var/spool/mikopbx/first/cf:/cf
      - /var/spool/mikopbx/first/storage:/storage
    tty: true
    environment:
      - ID_WWW_USER=${ID_WWW_USER}
      - ID_WWW_GROUP=${ID_WWW_GROUP}
      - PBX_NAME=MikoPBXFirst
      - PBX_FIREWALL_ENABLED=0
      - PBX_FAIL2BAN_ENABLED=0
      - SSH_PORT=123
      - WEB_PORT=8080
      - WEB_HTTPS_PORT=8443
      - SIP_PORT=5060
      - TLS_PORT=5061
      - RTP_PORT_FROM=10000
      - RTP_PORT_TO=10800
      - IAX_PORT=4569
      - AMI_PORT=5038
      - AJAM_PORT=8088
      - AJAM_PORT_TLS=8089
      - BEANSTALK_PORT=4229
      - REDIS_PORT=6379
      - GNATS_PORT=4223
  mikopbx-second:
    container_name: "mikopbx-second"
    image: "ghcr.io/mikopbx/mikopbx-x86-64"
    network_mode: "host"
    tty: true
    entrypoint: "/sbin/docker-entrypoint"
    hostname: "mikopbx-in-docker-second"
    volumes:
      - /var/spool/mikopbx/second/cf:/cf
      - /var/spool/mikopbx/second/storage:/storage
    environment:
      - ID_WWW_USER=${ID_WWW_USER}
      - ID_WWW_GROUP=${ID_WWW_GROUP}
      - PBX_NAME=MikoPBXSecond
      - PBX_FIREWALL_ENABLED=0
      - PBX_FAIL2BAN_ENABLED=0
      - SSH_PORT=2223
      - WEB_PORT=8081
      - WEB_HTTPS_PORT=9443
      - SIP_PORT=6060
      - TLS_PORT=6061
      - RTP_PORT_FROM=20000
      - RTP_PORT_TO=20800
      - IAX_PORT=5569
      - AMI_PORT=6038
      - AJAM_PORT=9088
      - AJAM_PORT_TLS=9089
      - BEANSTALK_PORT=5229
      - REDIS_PORT=7379
      - GNATS_PORT=5223

Save the contents into a file named docker-compose.yml, make the necessary adjustments, and launch MikoPBX using the command:

export ID_WWW_USER=$(id -u www-user)
export ID_WWW_GROUP=$(id -g www-user)
sudo docker compose -f docker-compose.yml up

Network Bridge Mode (–net=bridge)

There is an option to launch MikoPBX containers in the –net=bridge mode. However, as mentioned above, to use this mode you either need to significantly limit the range of RTP ports or open them on the host machine without using Docker's capabilities.

For this, you will need to write a small script to determine the name of the current bridge interface and the IP address of each container. After running Docker Compose, you will then need to add the necessary iptables rules for the RTP port range as follows:

#!/bin/bash

COMPOSE_FILE="$1"

if [ -z "$COMPOSE_FILE" ]; then
    echo "Usage: $0 path/to/docker-compose.yaml"
    exit 1
fi

# We will obtain the user ID for running the container
export ID_WWW_USER=$(id -u www-user)
export ID_WWW_GROUP=$(id -g www-user)

# Stop current containers if they are running
docker compose -f "$COMPOSE_FILE" down

# Remove them
docker compose -f "$COMPOSE_FILE" rm

# Start containers in the background
docker compose -f "$COMPOSE_FILE" up -d
sleep 60

# Create a label for IPTABLES rules
IPTABLES_COMMENT="mikopbx-custom-rule"

# Determine the project identifier, used when creating a network bridge
project_prefix=$(cat "$COMPOSE_FILE" | yq e '.x-project-name' -)

# If the prefix is not set, use a default value
if [ -z "$project_prefix" ]; then
    project_prefix="default_prefix"
fi

# Function to get container IP address
function get_container_ip() {
    docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "$1"
}

# Function to get the name of the bridge interface
function get_bridge_name() {
    local network_name="$1"
    local prefix="$2"
    local network_id=$(docker network inspect "${prefix}_${network_name}" -f '{{.Id}}')

    if [ -z "$network_id" ]; then
        echo "Error: Network ${prefix}_${network_name} not found."
        return 1
    fi

    local bridge_name=$(ip link show type bridge | grep -o "br-${network_id:0:12}\b")
    echo $bridge_name
}

echo "Delete tagged iptables rules"
# Delete all iptables rules tagged with our comment
iptables -S | grep "$IPTABLES_COMMENT" | sed 's/-A /-D /' | while read rule; do
        echo "Delete rule $rule"
        iptables $rule
done

# Delete all NAT iptables rules tagged with our comment
iptables -S -t nat | grep "$IPTABLES_COMMENT" | sed 's/-A /-D /' | while read rule; do
     echo "Delete rule $rule"
     iptables -t nat $rule
done

# Parse the docker-compose file and obtain all necessary parameters.
echo "Parsing docker-compose file and configuring iptables rules"
cat "$COMPOSE_FILE" | yq e '.services[] | select(.environment[] | test("RTP_PORT_FROM")) | {"container_name": .container_name, "environment": .environment, "network": .networks[0]}' -o=json | jq -c '.' | while read -r service; do
    container_name=$(echo $service | jq -r '.container_name')
    network_name=$(echo $service | jq -r '.network')
    bridge_name=$(get_bridge_name "$network_name" "$project_prefix")
    container_ip=$(get_container_ip "$container_name")

    RTP_PORT_FROM=$(echo $service | jq -r '.environment[] | select(contains("RTP_PORT_FROM")) | split("=")[1]')
    RTP_PORT_TO=$(echo $service | jq -r '.environment[] | select(contains("RTP_PORT_TO")) | split("=")[1]')

    echo "Configuring iptables for $container_name ($container_ip) on $bridge_name from port $RTP_PORT_FROM to $RTP_PORT_TO"

    iptables -A DOCKER -t nat ! -i "$bridge_name" -p udp -m udp --dport $RTP_PORT_FROM:$RTP_PORT_TO -j DNAT --to-destination $container_ip:$RTP_PORT_FROM-$RTP_PORT_TO -m comment --comment "$IPTABLES_COMMENT"
    iptables -A DOCKER -d $container_ip/32 ! -i "$bridge_name" -o "$bridge_name" -p udp -m udp --dport $RTP_PORT_FROM:$RTP_PORT_TO -j ACCEPT -m comment --comment "$IPTABLES_COMMENT"
    iptables -A POSTROUTING -t nat -s $container_ip/32 -d $container_ip/32 -p udp -m udp --dport $RTP_PORT_FROM:$RTP_PORT_TO -j MASQUERADE -m comment --comment "$IPTABLES_COMMENT"

    echo "Don't forget to open UDP ports $RTP_PORT_FROM to $RTP_PORT_TO on external firewall if it exists"
done

echo "iptables configuration completed successfully."

Let's describe several containers in the docker-compose.yaml file, specify different ports for the web interface, SIP ports, and ranges of RTP ports to ensure they do not overlap.

services:
  mikopbx-first:
    container_name: "mikopbx-first"
    image: "ghcr.io/mikopbx/mikopbx-x86-64"
    entrypoint: "/sbin/docker-entrypoint"
    hostname:  "mikopbx-in-docker-first"
    volumes:
      - /var/spool/mikopbx/first/cf:/cf
      - /var/spool/mikopbx/first/storage:/storage
    tty: true
    cap_add:
      - net_admin
    networks:
      - network-bridge1
    environment:
      - ID_WWW_USER=${ID_WWW_USER}
      - ID_WWW_GROUP=${ID_WWW_GROUP}
      - PBX_NAME=MikoPBXFirst
      - RTP_PORT_FROM=10000 # UDP range 10000-10800 on host will be directed to the container
      - RTP_PORT_TO=10800
      - WEB_ADMIN_PASSWORD=mikopbx-first-password
      - ENABLE_USE_NAT=1
      - PBX_FIREWALL_ENABLED=1
      - PBX_FAIL2BAN_ENABLED=1
    ports:
      - "8443:443"  # TCP port 8443 on the host is directed to port 443 in the container
      - "5060:5060/udp"  # UDP port 5060 on the host is directed to port 5060 in the container
  mikopbx-second:
    container_name: "mikopbx-second"
    image: "ghcr.io/mikopbx/mikopbx-x86-64"
    tty: true
    cap_add:
      - net_admin
    networks:
      - network-bridge2
    entrypoint: "/sbin/docker-entrypoint"
    hostname:  "mikopbx-in-docker-second"
    volumes:
      - /var/spool/mikopbx/second/cf:/cf
      - /var/spool/mikopbx/second/storage:/storage
    environment:
      - ID_WWW_USER=${ID_WWW_USER}
      - ID_WWW_GROUP=${ID_WWW_GROUP}
      - PBX_NAME=MikoPBXSecond
      - RTP_PORT_FROM=20000 # UDP range 20000-20800 on host will be directed to the container
      - RTP_PORT_TO=20800
      - EXTERNAL_SIP_PORT=6060 # Inform MikoPBX about its external SIP port
      - WEB_ADMIN_PASSWORD=mikopbx-second-password
      - ENABLE_USE_NAT=1
      - PBX_FIREWALL_ENABLED=1
      - PBX_FAIL2BAN_ENABLED=1
    ports:
      - "9443:443"  # TCP port 9443 on the host is directed to port 443 in the container
      - "6060:5060/udp"  # UDP port 6060 on the host is directed to port 5060 in the container
x-project-name: mikopbx # This parameter must be present
networks:
  network-bridge1:
    driver: bridge
  network-bridge2:
    driver: bridge

Creating a directory for scripts

mkdir -p /usr/src/mikopbx

Save the start-multiple-mikopbx.sh and docker-compose.yaml files into this folder.

Install the necessary dependencies for the script.

sudo apt-get update
sudo apt-get install jq
sudo snap install yq

Navigate to our folder, add execution rights and launch our script.

cd /usr/src/mikopbx
sudo chmod +x start-multiple-mikopbx.sh
sudo ./start-multiple-mikopbx.sh docker-compose.yaml

While waiting for the containers to start, check the firewall settings on the host, and if necessary, open the ports specified in our docker-compose.yaml file, specifically:

• TCP/UDP ports 5060 and 6060 for SIP

• UDP ranges 10000-10800 and 20000-20800 for RTP voice transmission

• TCP ports 8443 and 9443 for HTTPS protocol, for web interface operation.

Access each station in turn at the addresses:

• https://<host machine IP>:8443

• https://<host machine IP>:9443

To access the web interface of the first MikoPBX, use the login admin and the password mikopbx-first-password

To access the web interface of the second MikoPBX, use the login admin and the password mikopbx-second-password

Each machine should have NAT mode enabled, indicating that the container is behind a router in the network interface settings. If the stations will be used within a local network, then in the external IP field, enter the local IP address of the host machine, otherwise its public IP address.

With that, the setup is complete, and you can configure accounts and make calls.

Environment variables for configuring MikoPBX

Below are some of the environment variables that will allow you to adjust the MikoPBX ports and settings used.

• SSH_PORT - port for SSH (22)

• WEB_PORT - port for the web interface via HTTP protocol (80)

• WEB_HTTPS_PORT - port for the web interface via HTTPS protocol (443)

• SIP_PORT - port for connecting a SIP client (5060)

• TLS_PORT - port for connecting a SIP client with encryption (5061)

• RTP_PORT_FROM - beginning of the RTP port range, voice transmission (10000)

• RTP_PORT_TO - end of the RTP port range, voice transmission (10800)

• IAX_PORT - port for connecting IAX clients (4569)

• AMI_PORT - AMI port (5038)

• AJAM_PORT - AJAM port used for connecting the telephony panel for 1C (8088)

• AJAM_PORT_TLS - AJAM port used for connecting the telephony panel for 1C (8089)

• BEANSTALK_PORT - port for the Beanstalkd queue server (4229)

• REDIS_PORT - port for the Redis server (6379)

• GNATS_PORT - port for the gnatsd server (4223)

• ID_WWW_USER - identifier for www-user (can be set with the expression $(id -u www-user), where www-user is NOT a root user)

• ID_WWW_GROUP - group identifier for www-user (can be set with the expression $(id -g www-user), where www-user is NOT a root group)

• WEB_ADMIN_LOGIN - login for Web interface access

• WEB_ADMIN_PASSWORD - password for Web interface access

A full list of all possible setting parameters is available in the source code here.

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.

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

Creating a virtual machine

1. Open the Marketplace and enter MikoPBX in the search bar

2. Select the MikoPBX 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

Authorize on the platform https://console.cloud.google.com/

Let's start configuring

Creating storage

1. Open Navigation menu / Products & solutions / Storage / Cloud Storage

2. On the Cloud Storage tab select Create

3. Enter the storage name, for example miko-images

4. Use default values for other fields

5. After entering the values, click the Create button

1. Open the created miko-images storage

2. On the opened tab select UPLOAD FILES

3. Upload the file from the MikoPBX distribution with the .vhd extension

4. Wait for the file upload to complete

Connecting Cloud Build API

1. Open Navigation menu / APIs & Services / Library / Google Enterprise API / Cloud Build API

2. On the opened tab select ENABLE

Connecting Compute Engine API

1. Open Navigation menu / APIs & Services / Library / Google Enterprise API / Compute Engine API

2. On the opened tab select ENABLE

Creating an image

1. Open Navigation menu / Products & solutions / Compute / Compute Engine

2. Go to the Storage / Images section

3. Select CREATE IMAGE to create a new image

4. Enter the image name, for example mikopbx-new-image

5. Specify the source type - Virtual disk (VMDK, VHD)

6. Select Virtual disk file under the BROWSE link, Browse / miko-images / .vhd

7. Uncheck the Install guest packages checkbox

8. In the Operating system on virtual disk field specify - No operating system. Data only.

9. Use default values for other fields

10. After entering the values, click the Create button and wait for the image creation to complete

Creating a virtual machine

1. In the Compute Engine tab go to the Virtual machines / VM Instance section

2. Select CREATE INSTANCE

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

1. In the Machine configuration / General purpose table select Series - N1

1. In the Machine type section choose Shared-core / f1-micro from the dropdown menu

1. In the Boot disk section select CHANGE

2. On the opened tab go to CUSTOM IMAGES

3. In the Image field select the previously created mikopbx-new-image

4. Use default values for other fields on the tab

5. Click the SELECT button

1. In the Advanced options / Disks section select ADD NEW DISK

2. On the opened tab enter the disk name for data storage, for example disk-storage-mikopbx

3. Specify the disk size of at least 50GB

4. Use default values for other fields on the tab

5. Click the SAVE button

If you have an SSH key, proceed as follows:

1. In the Advanced options / Security / MANAGE ACCESS section, select ADD ITEM

2. Specify it in the SSH key field

If you don't have an SSH key, proceed directly to step 18

1. Use default values for other fields

2. After entering the values, click the CREATE button

Configuring ports for incoming connections

1. Open Navigation menu / VPC network / Firewall

2. Select CREATE FIREWALL RULE to create a new rule for incoming connections

3. Enter the name of the new rule, for example internal-allow

1. Specify Direction of traffic - Ingress

2. Specify Targets

3. From the Source filter dropdown menu select IPV4 ranges and in the Source IPv4 ranges field enter 0.0.0.0/0

1. In the Protocols and ports section check the TCP (Ports - 0-65535) and UDP (Ports - 0-65535) checkboxes

1. Use default values for other fields

2. After entering the values, click the CREATE 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

3. On the opened tab navigate to Logs / Serial port 1 (console)