Skip to content

Latest commit

 

History

History
124 lines (93 loc) · 6.86 KB

README.md

File metadata and controls

124 lines (93 loc) · 6.86 KB
Raw

Translation status GitHub All Releases GitHub last commit (branch) Scrutinizer Code Quality GitHub

MikoPBX - free phone system for small business


88b           d88  88  88                     88888888ba   88888888ba  8b        d8
888b         d888  ""  88                     88      "8b  88      "8b  Y8,    ,8P
88`8b       d8'88      88                     88      ,8P  88      ,8P   `8b  d8'
88 `8b     d8' 88  88  88   ,d8   ,adPPYba,   88aaaaaa8P'  88aaaaaa8P'     Y88P
88  `8b   d8'  88  88  88 ,a8"   a8"     "8a  88""""""'    88""""""8b,     d88b
88   `8b d8'   88  88  8888[     8b       d8  88           88      `8b   ,8P  Y8,
88    `888'    88  88  88`"Yba,  "8a,   ,a8"  88           88      a8P  d8'    `8b
88     `8'     88  88  88   `Y8a  `"YbbdP"'   88           88888888P"  8P        Y8

What's MikoPBX?

MikoPBX is an open-source GUI (graphical user interface) that controls and manages Asterisk (PBX). MikoPBX is licensed under GPL. MikoPBX is an entirely modular GUI for Asterisk written in PHP and Javascript. Meaning you can simply write any module you can think of and distribute it free of cost to your clients so that they can take advantage of beneficial features in Asterisk The released firmware consists Linux operation system and all needing services like Asterisk, Nginx, PHP-FPM, iptables etc.

MikoPBX is a full-featured phone solution with top performance level, high stability and rich functionality. You can install MikoPBX on premise (hardware installation) or in any type of cloud-services (Google cloud, Amazon Cloud Solution, Microsoft Azure etc.)

The system has an easy and convenient web interface, call recording, conference calls, voice mail, call transfers and pickup, call queues, interactive voice response(IVR) menu, inbound and outbound call rules. Also, you can find holidays and night-time calls switcher there. Apart from MikoPBX has custom call-flow programming module and marketplace with paid and free extensions. All general business functionality is absolutely free forever!

Getting Started

  1. Download latest released ISO file in assets section
  2. Create a new virtual machine (e.g. VMware Player)
  3. Select Other Linux 4.x kernel 64-bit on the virtual machine settings
  4. Boot from ISO firmware and install MikoPBX on storage according to internal instructions.
  5. Continue set up your PBX system over a web interface with default credentials. Username: admin password: admin

Or follow our wiki for additional instructions.

Features

  • A very little Linux distributive.
  • Easy to install and easy to setup.
  • Multilingual interface with community-supported translation service.
  • Wiki documentation with context helpers on the web interface.
  • Latest PJSIP stack and Asterisk LTS 16 release installed.
  • Fail2Ban and iptables already included.
  • Modular architecture.
  • Plugins marketplace.
  • The PHP7.4 and phalcon framework
  • The modern codebase was written according to PSR standards and Airbnb JS code style.
  • Friendly community :)

Requirements

Concurrent calls Minimum recommended
5 to 10 1 GHz x86-64, 512 MB RAM
Up to 25 3 GHz x86-64, 1 GB RAM
More than 25 Dual CPUs 3 GHz x86-64, 2 GB RAM or more

How to modify your system

For some easy customisations, you can use a dialplan application point on a menu. The dialplan applications supports PHP-AGI or Asterisk Dialplan language.

Or direct system file customisation on the web interface.

MikoPBX usually loads from read-only offload partition. If you want to change something in the core module, you should remount the partition to write mode with a console (SSH) command remount-offload

If you want to add some new functionality, we strongly advise you look at ModuleTemplate repository.

How to report bugs and issues?

Be free to report about it here

For some ideas or question, you are welcome to our discussion club

The chat with developers you can find on telegram

Interface and documentation translation

We have already translated the web interface on several languages by Google translation service for the next list of languages:

If you find some mistakes, you are welcome to fix it on Weblate translation service.

Support

We offer paid support from MIKO LLC., the company behind MikoPBX.

Or you can ask for community help here or here

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. Become a sponsor

License

MikoPBX© - free phone system for small business Copyright © 2017-2021 Alexey Portnov and Nikolay Beketov

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/. The software licensed under the GPL-3.0 License.