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

Using Windows

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:

diskutil list

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.

sudo diskutil eraseDisk FAT32 NONAME  MBRFormat /dev/disk3;

1. Unmount the device with the following command:

sudo diskutil unmountDisk /dev/disk3;

1. Write the image to the USB drive:

sudo dd if=1.0.64-9.0-svn-mikopbx-x86-64-cross-linux.img of=/dev/disk3 bs=1m;

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

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.

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:

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

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:

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.

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:

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

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

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

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

1. Enter the IP address in your browser’s address bar. Log in using the default credentials.

First login to the MikoPBX system

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

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

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

Create a virtual machine

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" in the upper menu.

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 installation of MikoPBX using VirtualBOX is now complete.

Creating a virtual machine

1. Creating a new virtual machine.

Click "Continue"

1. Select the type of operating system Other Linux 5.x and later kernel 64-bit

Click "Continue"

1. Choosing the Legacy bios type

Click "Continue"

1. Click "Finish"

Connecting a new disk

1. After creating a virtual machine, wait for it to load

1. Go to the section "[3] Reboot the system"

1. Choose "[2] Shutdown"

1. After shutting down the virtual machine, go to Settings

1. Select "Add device"

1. Select "New Hard Disk"

Click "Add..."

1. Choose the size of the hard drive (we recommend at least 50 GB)

Click "Apply"

Installing MikoPBX

1. Start the virtual machine

1. Select "[8] Install"

1. Enter the name of the disk on which MikoPBX will be installed

In our case - sdb, enter its name and press Enter

1. Confirm the disk selection: enter y

1. Select a disk for recording conversations

In our case - sdc, enter its name and press Enter

1. The system will reboot and MikoPBX will be ready for use.

First connection to MikoPBX

1. The PBX displays the IP address of the station by which you can connect to it

1. Enter the IP address of the station in the browser bar and the MIkoPBX login menu will open:

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.

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

1. Enter the IP address in your browser’s address bar. Log in using the default credentials.

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:

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

Configuring Protection Against Hacking (Fail2Ban)

Adding and Configuring Employee Accounts

Connecting Providers

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:

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

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:

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.

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

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

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

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

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)

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 port 1 (console)

Приступим к настройке

Создание хранилища

1. Откройте Navigation menu / Products & solutions / Storage / Cloud Storage

2. На вкладке Cloud Storage выберите Create

3. Введите имя хранилища, например miko-images

4. Для других полей используйте значения по умолчанию

5. Завершив ввод значений, нажмите кнопку Create

6. Откройте созданное хранилище miko-images

7. На открывшейся вкладке выберите UPLOAD FILES

8. Загрузите файл из дистрибутива MikoPBX с расширением .vhd

9. Дождитесь окончания загрузки файла

Подключение Cloud Build API

1. Откройте Navigation menu / APIs & Services / Library / Google Enterprise API / Cloud Build API

2. На открывшейся вкладке выберите ENABLE

Подключение Compute Engine API

1. Откройте Navigation menu / APIs & Services / Library / Google Enterprise API / Compute Engine API

2. На открывшейся вкладке выберите ENABLE

Создание образа

1. Откройте Navigation menu / Products & solutions / Compute / Compute Engine

2. Перейдите в раздел Storage / Images

3. Выберите CREATE IMAGE для создания нового образа

4. Введите имя образа (Name), например mikopbx-new-image

5. Укажите тип источника (Source) - Virtual disk (VMDK, VHD)

6. Выберите Virtual disk file по ссылке BROWSE, *Browse / miko-images / .vhd

7. Уберите флажок Install guest packages

8. В поле Operating system on virtual disk укажите - No operating system. Data only.

9. Для других полей используйте значения по умолчанию

10. Завершив ввод значений, нажмите кнопку Create и дождитесь окончания создания образа

Создание виртуальной машины

1. Во вкладке Compute Engine перейдите в раздел Virtual machines / VM Instance

2. Выберите CREATE INSTANCE

3. Введите имя виртуальной машины (Name), например mikopbx-vm

4. В таблице Machine configuration / General purpose ****выберите ****Series - N1

5. В разделе Machine type в выпадающем меню выберите Shared-core / f1-micro

6. В разделе Boot disk выберите CHANGE

7. На открытой вкладке перейдите к CUSTOM IMAGES

8. В поле Image выберите созданный ранее образ mikopbx-new-image

9. Для других полей на вкладке используйте значения по умолчанию

10. Нажмите кнопку SELECT

11. В разделе Firewall ****разрешите HTTP трафик, установите флажок Allow HTTP traffic

12. В разделе Advanced options / Disks выберите ADD NEW DISK

13. На открытой вкладке введите имя диска для хранения данных (Name), например disk-storage-mikopbx

14. Укажите размер диска (Size) не менее 50Гб

15. Для других полей на вкладке используйте значения по умолчанию

16. Нажмите кнопку SAVE

Если у вас есть ключ SSH, выполните следующее

1. В разделе Advanced options / Security / MANAGE ACCESS выберите ADD ITEM

2. Укажите его в поле SSH key

Если у вас есть нет ключа SSH, сразу перейдите к пункту 19

1. Для других полей используйте значения по умолчанию

2. Завершив ввод значений, нажмите кнопку CREATE

Настройка портов для входящих соединений

1. Откройте Navigation menu / VPC network / Firewall

2. Выберите CREATE FIREWALL RULE для создания нового правила для входящего соединения

3. Введите имя нового правила (Name), например http-80

4. Укажите Direction of traffic - Ingress

5. Укажите Targets

6. Из выпадающего меню в поле Source filter выберите IPV4 ranges и в поле Source IPv4 ranges укажите 0.0.0.0/0

7. В разделе Protocols and ports установите флажок TCP и в поле Ports укажите 80

8. Для других полей используйте значения по умолчанию

9. Завершив ввод значений, нажмите кнопку CREATE

10. Аналогично создайте правило для HTTPS. Укажите имя, Direction of traffic - Ingress, Targets, Source filter - IPV4 ranges, Source IPv4 ranges - 0.0.0.0/0, Protocols and ports - TCP, Ports - 443

11. Аналогично создайте правило для SIP сигнализации TCP. Укажите имя, Direction of traffic - Ingress, Targets, Source filter - IPV4 ranges, Source IPv4 ranges - 0.0.0.0/0, Protocols and ports - TCP, Ports - 5060

12. Аналогично создайте правило для SIP сигнализации UDP. Укажите имя, Direction of traffic - Ingress, Targets, Source filter - IPV4 ranges, Source IPv4 ranges - 0.0.0.0/0, Protocols and ports - UDP, Ports - 5060

13. Аналогично создайте правило для передачи звука RTP. Укажите имя, Direction of traffic - Ingress, Targets, Source filter - IPV4 ranges, Source IPv4 ranges - 0.0.0.0/0, Protocols and ports - UDP, Ports - 10000-10200

Запуск АТС MikoPBX

1. Откройте вкладку Compute Engine перейдите в раздел Virtual machines / VM Instance

2. Скопируйте External IP созданной виртуальной машины

3. Введите в строке браузера External IP

4. Откройте созданную виртуальную машину

5. Скопируйте Instance Id - это пароль для входа в АТС по умолчанию

6. Логин для входа по умолчанию - admin

This step-by-step guide will walk you through installing MikoPBX on the Alibaba Cloud platform.

Uploading the Image to Alibaba Cloud

Creating a Bucket

1. Go to Buckets.

1. Click Create Bucket:

1. Specify the following:

• Bucket name – a custom name for your storage.

• Region – pick the region where your image will be stored.

Click OK.

1. Go to your newly created bucket by clicking its name in the Buckets section:

1. Click Upload object and upload the previously downloaded .raw disk image file (leave other parameters at default).

1. Once the disk image file is uploaded, copy its link. Click View Details to the right of the file name; in the opened menu, copy the URL field.

Creating the Image

1. Click Import Image:

1. Select Linux Operating System and click Next.

2. Enter/select the following image parameters:

   • Image File URL – Paste the link to the disk image file you uploaded.

   • Image Name – A custom, unique name for your image.

   • OS Type – Linux

   • OS Version – Others Linux

   • Architecture – 64-bit OS

   • Uncheck "Check After Import"

Click OK to create the image. Wait until the process finishes (the Status will show Available).

Creating an SSH Key Pair

Next, create and add an SSH key pair in Alibaba Cloud.

1. In the ECS Console, go to Network Security → Key Pairs:

1. Click Create SSH Key Pair:

• Name – A custom name for your key pair.

• Creation Mode – Import

• Public Key – Paste your public key, generated earlier.

• Resource Group – Choose your resource group.

Click OK to create the key pair in the cloud.

Creating a Security Group

Before creating the virtual machine, you must set up a security group (firewall).

1. Go to Network & Security → Security Groups:

1. Click Create Security Group:

1. Specify the following security group parameters:

• Security Group – A custom name for your security group.

• Network – Your selected network. If it doesn’t exist yet, click "Create VPC" to the right.

• Security Group – Basic Security Group.

• Resource Group – Your resource group.

• Allow all inbound connections (see example below). Outbound is allowed by default.

Click Create Security Group.

Creating the Virtual Machine

1. Go to Instances & Images → Instances:

1. Click Create Instance to create a new virtual machine:

1. Select your VM parameters:

• Billing Method – Choose how you’ll pay for the VM.

• Region, Network, and Zone – Select the region and zone to match your needs.

• Instance – Pick a configuration for your VM.

1. Configure additional VM parameters:

• Image – Custom Images → Choose the previously imported image.

• Storage – Select the type and size of the System Disk (20 GB is the minimum for Alibaba Cloud).

• Add a second disk by clicking Add Data Disk, specifying its type and size.

1. Choose the network parameters for your VM. The security group created earlier will be assigned automatically:

1. Click Create Order.

Connecting to the MikoPBX Console

In the Instances section, open the newly created VM by clicking its name.

Connecting via Built-in Cloud Console

1. Click Connect.

1. Select VNC. A new tab will open in your browser with console access.

Connecting via SSH

Enter the following command to connect via SSH:

ssh -i C:\Users\username\.ssh\id_ed25519 root@ip-adress

Replace:

• C:\Users\username\.ssh\id_ed25519 with the path to your SSH key,

• root if you changed the default user when creating the VM,

• ip-adress with the external IP address of your MikoPBX instance.

You will then connect via SSH:

First Login to the Web Interface

On the VM’s main page, you’ll see important parameters for logging into the MikoPBX web interface.

Paste the IP address into your browser’s address bar to access the MikoPBX web interface login page.

This guide provides a step-by-step process for installing MikoPBX on the Vultr cloud platform.

Uploading the Image to Vultr

Uploading the File to Storage

First, you need to upload the image to the cloud platform.

1. Navigate to "Cloud Storage" → "Object Storage":

1. Create a new storage resource by clicking "Add Object Storage":

1. Select the type of storage (it’s recommended to use the basic option, as you only need it to store the disk image). Also provide a name.

2. Click on your newly created storage resource:

1. Go to the "Buckets" tab and create a new bucket with a custom name.

1. The storage information will display S3 connection details.

1. Next, connect to your storage via WinSCP. Open WinSCP and select "New Site":

1. Enter the following parameters:

• File protocol – Amazon S3

• Encryption – TLS/SSL Implicit encryption

• Port number – 443

• Host Name, Access key ID, and Secret access key – from the storage information

Click "Login".

1. Upload the .iso disk image file to the storage.

1. Return to the Vultr interface and go to your bucket’s directory.

1. Click the three dots to the right of the file name, then "Change Access". Grant access by toggling the switch.

Importing the ISO

1. Click the three dots to the right of the file name and select "Copy URL".