Only this pageAll pages
Powered by GitBook
Couldn't generate the PDF for 278 pages, generation stopped at 100.
Extend with 50 more pages.
1 of 100

Russian

Loading...

Loading...

Loading...

Loading...

Loading...

Установка

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Руководство пользователя

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Часто задаваемые вопросы

Loading...

Loading...

Loading...

Loading...

Отдельный компьютер

В данной статье Вы сможете найти инструкции по установке MikoPBX на отдельный компьютер

MikoPBX поддерживает установку на отдельный компьютер. Существуют два способа:

  • Live USB - запись образа на флешку с последующей её установкой на другой диск.

  • Bootable USB - установка системы на непосредственно сам USB-носитель с последующей возможностью загрузки с нее.

В данном разделе представлены варианты записи образов на всех возможных системах (Windows, MacOS, Linux)

Знакомство с MikoPBX

Это статья про первый вход в MikoPBX. Здесь вы найдете процесс первого входа в систему и некоторые рекомендации по первоначальной настройки после входа.

Первый вход в систему MikoPBX

Перейдите в консоль MikoPBX, вверху будет находиться IP-адрес, по которому вы можете подключиться через WEB-интерфейс. При установках не на локальный компьютер используйте внутренний IP-адрес. Скопируйте или запомните его.

IP-адрес MikoPBX для подключения к WEB-интерфейсу

Введите или вставьте IP-адрес MikoPBX в web-браузере. Отобразится страница авторизации в web-интерфейс. Введите логин и пароль по умолчанию.

Данные по умолчанию:

Логин - admin

Пароль - admin

Страница авторизации в web-интерфейс

После первой успешной авторизации, MikoPBX автоматически откроет настройки для смены пароля. Поменяйте пароль и нажмите "Сохранить".

Первая авторизация в WEB-интерфейс MikoPBX

Более подробную информацию об Общих настройках в разделе

После смены пароля система будет полностью готова к работе. Рекомендуется сразу же настроить правила firewall. Прочитать про то, как это сделать, можно по ссылке.

Системные требования

В данной статье вы сможете найти системные требования для MikoPBX.

Требование к сетевому каналу

Пример расчета необходимой пропускной способности канала для различных кодеков на 30 одновременных звонков. АТС поддерживает наиболее популярные кодеки:

  • G.711 - 4.67 Mbps

  • GSM - 1.68 Mbps

  • G.722 - 4.67 Mbps

  • G.729 - 1.38 Mbps

  • Жесткий диск объемом 800 Mb для основной системы

  • Жесткий диск объемом 50+ Gb для записей разговоров

  • 1 (2 ядра) процессор x86-64

Руководство по MikoPBX

Описание MikoPBX и разделов, которые вы сможете найти в документации. Вступление в документацию.

Добро пожаловать на ресурс документации по MikoPBX! Здесь Вы сможете найти пошаговые инструкции, связанные с взаимодействием с АТС MikoPBX. Для удобства, они собраны в разделы - прямо как в Web-интерфейсе, поэтому ориентироваться в документации очень легко.

Благодарим Вас за выбор MikoPBX! ❤️

MikoPBX - это бесплатный сервер телефонии с операционной системой и простым, удобным веб-интерфейсом. Она работает практически с любой телефонной технологией в мире.

MikoPBX — это полностью модульный интерфейс для Asterisk, написанный на PHP и Javascript. Это значит что в MikoPBX возможно реализовать абсолютно любой дополнительный функционал Asterisk телефонии. Более того, если вы разработаете полезный модуль, его можно поместить в общий репозиторий и сделать доступным для всех пользователей MikoPBX. Помимо этого, MikoPBX имеет очень низкие требования к аппаратному обеспечению ПК:

Быстрое начало работы

Данная инструкция подробно расскажет о пути начала работы с MikoPBX и поможет вам быстро разобраться с настройкой системы.

Следуйте инструкциям шаг-за-шагом в том порядке, в котором они представлены для быстрой и успешной настройки системы.

MikoPBX - полноценная операционная система для вашего оборудования, не является отдельной программой. Поставляется в виде образа (файл *.iso, *.img, *.raw).

Она поддерживает многие способы установки:

  • Установка .

2Gb оперативной памяти

  • Сетевой адаптер

  • Расчет ориентировочный, при использовании одного кодека на всех устройствах, подключенных к АТС. Подробнее тут.

    Минимальные системные требования

    Мы рекомендуем использовать два жестких диска для развертывания АТС.

    ПК, с такими параметрами, в наших тестах, держит 38 одновременных входящих звонков при условиях:

    • К очереди подключено 10 агентов (все online)

    • Каждую секунду поступает новый звонок

    • Клиенту во время ожидания воспроизводится музыка (MOH)

    • На АТС не установлено доп. модулей

    Ориентировочно, 1 час разговора занимает 14Мб места на диске. Для диска хранения записей разговоров рекомендуемый размер - не менее 50 гигабайт.

    Cover

    Установка с записью образа на USB-носитель (LiveUSB)

    Cover

    Установка системы на USB- носитель (BootableUSB)

    Системных настроек.
    Одновременные звонки
    Минимально рекомендуемая конфигурация

    5 - 10

    1 GHz x86-64, 512 MB RAM

    До 25

    3 GHz x86-64, 1 GB RAM

    Более 25

    2 CPUs 3 GHz x86-64, 2 GB RAM или больше

    Для начала вам следует установить MikoPBX любым удобным для вас способом. Ниже находятся опции установки. Нажав на их название - вы можете перейти к подробным профильным статьям:

    • Установка на отдельный компьютер.

    • Установка в виртуальную машину.

    • Установка с помощью облачных сервисов.

    • Установка в Docker контейнер.

    После установки вы можете перейти к изучению вашей станции. В этом вам поможет дальнейшая документация "Руководство пользователя", которая подробно рассказывает про конкретные разделы:

    • Телефония.

    • Маршрутизация.

    • Модули.

    • Обслуживание.

    • .

    • .

    За дополнительной помощью по "быстрому старту", вы можете обратиться к данной статье.

    В случае, если вы разобрались с базовой настройкой и эксплуатацией MikoPBX, Вы можете расширить ее функционал с помощью модулей.

    Они позволяют добавить дополнительные функции вашей системы. Разобраться в них подробнее вы можете по шагам:

    1. Регистрация в Маркетплейсе MikoPBX - здесь подробно описан процесс регистрации и его особенности.

    2. Управление модулями - здесь подробно описан процесс установки и управления модулями.

    3. Документация по конкретным модулям - в этом разделе вы найдете подробное описание каждого модуля, а так же шаги по его настройки и использованию.

    В данной секции Вы можете найти ответы на интересующие вас вопросы, а так же решения, которые помогут вам расширить функционал базовых функций. Данная секция, так же, как и основная разделена на разделы для удобства поиска интересующих вас тем.

    Если у вас возник вопрос, который не разобран в данном разделе - Вы можете обратиться за помощью в Telegram Community, где пользователи MikoPBX помогают друг другу решить вопросы и потребности, связанные с АТС.

    Предисловие

    Что такое MikoPBX?

    Интерфейс MikoPBX

    С чего начать?

    Модули

    Раздел FAQ

    Установка в виртуальную машину.

  • Установка с помощью облачных сервисов.

  • Установка в Docker контейнере.

  • Перейдите по ссылке к интересующему Вас способу установки и произведите её по данным инструкциям.

    После установки Вам необходимо перейти в web-интерфейс MikoPBX для дальнейшей настройки системы. Для того, чтобы это сделать - найдите IP-адрес станции в консоли MikoPBX:

    Пример консоли MikoPBX

    В данном примере - IP-адрес 172.25.233.36. Для перехода в web-интерфейс введите этот IP в адресную строку вашего браузера:

    Окно входа в MikoPBX

    После первой авторизации, система попросит Вас поменять пароль.

    Для стабильной работы АТС необходимо настроить сеть через раздел Сеть и Firewall → Сетевые интерфейсы. Ознакомится с подробной инструкцией по данным настройкам можно здесь.

    В MikoPBX все локальные подсети возможно описать в разделе Сеть и Firewall → Сетевой экран. Сетевой экран предназначен для ограничения доступа к станции по типу трафика и подсетям. Выполните настройку по инструкции.


    Fail2ban блокирует IP адреса с нестандартной активностью, он способен снизить скорость неудачных попыток аутентификации, позволяет защитить Вашу АТС от взлома. Инструкцию, которая поможет в настройке можно найти здесь.


    После окончания первоначальной настройки АТС, Вы можете перейти к созданию учетных записей ваших сотрудников. В этом вам поможет инструкция.


    После добавления сотрудников, Вам необходимо подключить провайдеров к вашей станции. Инструкцию про этот раздел вы можете найти здесь. Инструкции с примерами настройки реальных провайдеров вы можете найти здесь.


    На данном этапе необходимо задать правила маршрутизации для входящих и исходящих вызовов: как будут обрабатываться звонки, идущие через определенного провайдера:

    • Маршрутизация входящих вызовов

    • Маршрутизация исходящих вызовов

    Для создания правил маршрутизации Вам так же могут понадобиться следующие функции:

    • Очереди вызовов

    • IVR-меню

    • Конференции


    Маркетплейс позволяет расширить стандартный функционал системы с помощью модулей:

    • Подробнее про Модули в MikoPBX Вы можете прочитать в этой статье.

    • Про регистрацию в Маркетплейсе MikoPBX Вы можете прочитать в этой статье.

    Установка MikoPBX

    на отдельный компьютер

    Первый вход в веб-интерфейс

    Если в логах Вам не даны логин и пароль, используйте данные по-умолчанию:

    Username: admin

    Password: admin

    Настройки внутри web-интерфейса:

    Настройки сети и сетевого экрана

    Настройка защиты от взлома (Fail2Ban)

    Добавление и настройка учетных записей сотрудников

    Подключение провайдеров

    Настройка входящей и исходящей маршрутизации

    Маркетплейс и модули

    На этом, основная настройка MikoPBX завершена! Для более глубокого изучения возможностей MikoPBX рекомендуем обратиться к общей документации.

    Виртуальные машины

    В данной статье Вы сможете найти инструкции по установке MikoPBX с помощью различных виртуальных машин.

    MikoPBX поддерживает установку с помощью многих виртуальных машин. В данном разделе Вы можете найти подробные инструкции по ним. Нажмите на элемент в списке ниже для перехода к инструкции по конкретной виртуальной машине:

    Облачные сервисы

    В данной статье Вы сможете найти инструкции по установке MikoPBX с помощью различных облачных сервисов.

    MikoPBX поддерживает установку с помощью многих облачных сервисов. В данном разделе Вы можете найти подробные инструкции по ним. Нажмите на элемент в списке ниже для перехода к инструкции по конкретной виртуальной машине:

    Сеть и Firewall
    Система
    VMware ESXi
    VMware Fusion
    VirtualBOX
    VMware Workstation Pro
    Hyper-V
    Proxmox
    UTM
    Yandex Cloud
    VK Cloud
    1С:Облачная инфраструктура
    AWS
    Microsoft Azure
    Google Cloud
    Hetzner cloud (Empty)
    Vscale
    Selectel
    DigitalOcean
    Alibaba cloud
    Vultr

    Hetzner cloud (Empty)

    Установка MikoPBX с помощью Hetzner Cloud

    Yandex Cloud

    Варианты установки MikoPBX в Yandex Cloud

    В сервисе Yandex Cloud есть возможность загрузить АТС MikoPBX из образа в маркетплейсе Яндекса или из образа на основе загруженного *.raw файла из дистрибутива MikoPBX (промежуточные релизы)

    Cover

    Магазин приложений

    Инструкция по установке готового образа из Яндекс Маркетплейс

    Cover

    Произвольный образ

    Подробная инструкция по загрузке MikoPBX из произвольного образа

    Cover

    Утилита коммандной строки yc

    Установка MikoPBX в Yandex Cloud с помощью утилиты yc

    Перехват на ответственного в панели телефонии 4.0 как в панели 1.0

    Перехват на ответственного

    Интеграция с 1С

    Отменить перехват на ответственного для конкретного провайдера

    Обеспечение безопасности MikoPBX

    Как защитить MikoPBX от взлома и несанкционированного доступа

    В последнее время участились случаи взлома IP-АТС. Злоумышленники получают доступ к телефонии и совершают звонки за ваш счёт — на платные номера и международные направления. Это может привести к потерям в десятки и сотни тысяч рублей за считанные часы.

    Кроме прямых финансовых потерь, взломанная АТС может использоваться мошенниками для звонков от имени вашей организации — например, для обзвона граждан якобы от лица банков или государственных органов. При этом у жертв отображается номер вашей компании, что ведёт к репутационному ущербу и возможным проверкам со стороны правоохранительных органов.

    Пройдитесь по всем пунктам этой инструкции — даже если вы уже настраивали систему, возможно, что-то было упущено.

    Критическая уязвимость в версии 2024.1.114!

    Обнаружена уязвимость в модуле внешней панели: если модуль опубликован в интернет или Firewall настроен некорректно, злоумышленник может получить все SIP-учётки и совершать звонки от имени Вашей компании.

    Необходимо выполнить следующие шаги:

    Патч безопасности для версии 2024.1.114

    Если вы используете версию 2024.1.114, установите патч одной командой:

    curl -L 'https://files.miko.ru/s/DPZcM2vywc2BTOZ/download' | sh

    Подробные инструкции: Патч 2024.1.114

    Если вы используете более старую версию — обновитесь до актуального релиза. Шаги 3 и 4 из списка выше необходимо выполнить в любом случае, независимо от версии.


    Обязательные меры безопасности

    Включите сетевой экран (Firewall)

    Сетевой экран — первая линия защиты. Он ограничивает, кто может подключаться к вашей АТС.

    Перейдите в раздел «Сеть и Firewall» → «Сетевой экран», убедитесь что переключатель активирован и создайте правила, разрешающие доступ только из нужных подсетей.

    Какие адреса добавить в правила:

    • Подсеть вашего офиса

    • Адреса VPN-сервера

    • Адреса вашего провайдера телефонии (уточните у провайдера)

    • Статические IP-адреса удалённых сотрудников

    Подробная инструкция:

    Панель управления АТС — это «ключи от всей системы». Если она доступна из интернета без ограничений, злоумышленник может получить полный контроль над телефонией.

    В правилах сетевого экрана разрешите WEB и CTI-доступ только для подсети вашего офиса или VPN. Для всех остальных правил отключите галочки WEB и CTI. Если вам нужен удалённый доступ — используйте VPN.

    Простой пароль — самая частая причина взлома. Злоумышленники перебирают тысячи комбинаций в секунду, и пароли вроде 1234, admin или password подбираются мгновенно.

    Требования к паролям SIP-аккаунтов и веб-интерфейса:

    • Минимум 12 символов

    • Буквы ВЕРХНЕГО и нижнего регистра

    • Цифры и специальные символы (!@#$%^&*)

    Что проверить:

    • Откройте карточку каждого сотрудника в разделе «Телефония» → «Сотрудники» и убедитесь, что SIP-пароль достаточно сложный

    • Проверьте пароль для входа в веб-интерфейс в разделе «Система» → «Общие настройки» → «Пароль WEB интерфейса»

    По умолчанию для SIP-авторизации используется внутренний номер сотрудника (например, 204). Злоумышленники это знают и перебирают именно стандартные номера.

    Auth Username — это имя пользователя, которое телефон или софтфон отправляет при регистрации на АТС. Оно отличается от внутреннего номера и используется исключительно для проверки подлинности подключения.

    Как настроить префикс Auth Username в MikoPBX:

    Перейдите в «Система» → «Общие настройки» → «SIP» и заполните поле «Префикс Auth Username для авторизации». Например, при префиксе MIKO внутренний номер 204 будет авторизоваться как 204MIKO.

    После изменения Auth Username необходимо обновить настройки на каждом телефоне или софтфоне. В зависимости от производителя, настройка называется по-разному:

    Производитель
    Название настройки

    Обычно эта настройка находится в разделе Account или SIP Account в веб-интерфейсе телефона.

    Fail2Ban автоматически блокирует IP-адреса, с которых идут подозрительные попытки подключения.

    Перейдите в раздел «Сеть и Firewall» → «Защита от взлома» и проверьте указанную степень защиты от атак:

    • Слабая — 20 попыток за 10 мин, бан на 10 мин. Для первой настройки и доверенных сетей.

    • Нормальная — 10 попыток за 1 час, бан на 1 день. Рекомендуется для большинства.

    • Усиленная — 5 попыток за 6 часов, бан на 7 дней. Для серверов в интернете.

    • Docker-развёртывание: при использовании bridge-режима внутренние правила файрвола и fail2ban не защищают веб-интерфейс. Настройте или переключите контейнер в network_mode: host.

    Если АТС доступна напрямую из интернета — она становится мишенью для автоматических сканеров, которые круглосуточно ищут уязвимые системы.

    • Разместите АТС за NAT-маршрутизатором

    • Для удалённых сотрудников используйте VPN-подключение

    • Если публичный IP неизбежен — обязательно настройте сетевой экран и Fail2Ban

    • В разделе «Сеть и Firewall» → «Сетевые интерфейсы»


    Даже при хорошей технической защите стоит подстраховаться финансово. Если взлом всё-таки произойдёт, эти меры ограничат возможный ущерб.

    Свяжитесь с вашим провайдером телефонии и попросите:

    • Установить суточный лимит расходов на исходящие звонки

    • Включить запрет работы при отрицательном балансе

    • Заблокировать звонки на международные и платные направления, если вы ими не пользуетесь

    • Пополняйте баланс небольшими суммами по мере необходимости

    • Настройте уведомления о расходах у провайдера, если такая возможность есть


    Если вы обнаружили, что АТС была взломана, действуйте по следующей схеме:

    Шаг 1 — Немедленно изолируйте АТС

    Закройте доступ к станции извне через сетевой экран. Смените все пароли — SIP-аккаунтов, веб-интерфейса, SSH.

    Шаг 2 — Сохраните логи и записи разговоров

    Сохраните файлы записей разговоров и логи системы отдельно — они могут понадобиться как доказательства. Со временем они могут быть перезаписаны.

    Шаг 3 — Уведомите оператора связи

    Свяжитесь с вашим провайдером телефонии и сообщите об инциденте. Оператор может помочь заблокировать дальнейшие звонки и зафиксировать факт взлома.

    Шаг 4 — Подайте заявление в УФСБ

    Обратитесь в территориальное управление ФСБ с заявлением об инциденте в сфере ИТ-безопасности. Кратко опишите что произошло, укажите что звонки совершались без вашего ведома и что вы готовы предоставить логи и записи разговоров.


    Пройдитесь по этому списку и убедитесь, что все пункты выполнены:


    • — настройка правил доступа.

    • .

    • — настройка сети, NAT, DNS.

    Vscale

    Установка MikoPBX с помощью Vscale

    Vscale переехал в Selectel

    Инструкция по установке MikoPBX в Selectel доступна по ссылке:

    Загрузка образа

    1. Скачайте актуальный образ системы с расширением .raw на сайте

    2. Выполните авторизацию на портале https://vscale.io

    3. Перейдите в раздел "Облако" - "Образы" - кликните по кнопке "Создать"

    4. Выберите тип образа - "File" (п.1)

    5. Формат образа - "raw" (п.3)

    6. Операционная система - "Linux" (п.4)

    7. Выберите файл для загрузки (п.2)

    8. Кликните по кнопке "Создать" (п.5) и дождитесь завершения операции

    1. Перейдите в раздел "Облако" - "Серверы" - кликните по кнопке "Создать"

    2. Введите имя сервера

    3. В поле "Флейвор" выберите конфигурацию сервера

    После создания сервера можно перейти к его статусу в разделе "Облако" - "Серверы"

    Пароль для входа в вэб интерфейс по умолчанию устанавливается в значение, равному "instance-id", на текущий момент нет возможности получить этот идентификатор из web интерфейса Vscale.

    Для получения пароля от web интерфейса в перейдите на вкладку "Логи":

    Теперь можно перейти по публичному адресу и начать настройку АТС.

    В Docker контейнере

    Варианты установки MikoPBX в Docker контейнере

    «Host система» должна быть запущена на базе Linux 5+. Тестировалось на Debian 11 и Ubuntu-21.04, Ubuntu Server 22.04 LTS

    MikoPBX можно запустить в Docker, используя два основных способа. Первый способ включает в себя запуск контейнера напрямую через команду Docker с указанием необходимых параметров. Второй способ предусматривает использование Docker Compose, что упрощает управление многоконтейнерными приложениями и позволяет описать всю конфигурацию в yaml-файле, что делает развертывание и обслуживание системы более удобным.

    Google Cloud

    Варианты установки MikoPBX в Google Cloud

    Установка MikoPBX в Google Cloud может быть выполнена двумя способами: из образа в маркетплейсе Google Cloud или из образа на основе загруженного файла из дистрибутива MikoPBX. Первый способ обеспечивает быстрое и простое развертывание стандартной версии MikoPBX, а второй подходит для промежуточных релизов.

    Коммандная строка YC

    Установка MikoPBX в Yandex Cloud с помощью утилиты yc

    Утилита Yandex Cloud позволяет автоматизировать создание инстансов. Ее можно использовать в скриптах.

    1. На странице продукта скопируйте значение image_id. В текущем примере fd83g1qbk6m3jnl5cvah (для версии 2022.3.15). Идентификатор образа следует укзаать в параметре create-boot-disk image-id

    2. Получим список каталогов

    yc resource-manager folder list

    Выбираем каталог и указываем его имя в параметре folder-name

    1. Список зон

    Описываем зону в параметре zone

    1. Запускаем инстанс

    1. Список инстансов обновится

    Используйте EXTERNAL IP для входа и ID в качестве пароля для пользователя admin web интерфейса

    Обслуживание

    Описание раздела Обслуживание в MikoPBX

    Раздел «Обслуживание» в MikoPBX — это интерфейс для управления техническими аспектами системы и обеспечения ее стабильной работы. Здесь администраторы могут выполнять задачи по резервному копированию и восстановлению данных, обновлению программного обеспечения, мониторингу состояния системы и управлению журналами событий. Этот раздел помогает поддерживать работоспособность телефонной системы, своевременно обнаруживать и устранять возможные проблемы.

    Раздел "Обслуживание"

    Обновление системы

    Обновление PBX

    Раздел «Обновление» в MikoPBX — это интерфейс для управления обновлениями программного обеспечения системы. Здесь администраторы могут проверять наличие новых версий, устанавливать обновления и просматривать историю изменений. Регулярное использование этого раздела обеспечивает актуальность, безопасность и стабильность работы MikoPBX.


    Диагностика системы

    Диагностика системы

    Раздел «Диагностика системы» в MikoPBX — это инструмент для мониторинга и анализа состояния телефонной системы. Здесь администраторы могут просматривать журналы событий, проверять с помощью них статус различных сервисов и компонентов системы, а также выполнять тестирование соединений и вызовов. Использование этого раздела помогает своевременно обнаруживать и устранять технические проблемы, обеспечивая стабильную и эффективную работу MikoPBX.


    Раздел «Перезагрузка и выключение системы» в MikoPBX — это интерфейс для безопасного управления состоянием телефонной системы через веб-интерфейс. Здесь администраторы могут перезагрузить систему для применения новых настроек или корректно выключить ее для технического обслуживания. Использование этого раздела предотвращает возможные ошибки и обеспечивает стабильную работу MikoPBX. Помимо этого, будет рассмотрена возможность перезагрузки через консоль.

    AWS

    Варианты установки MikoPBX с помощью AWS

    Самый простой способ установки MikoPBX — установка готового образа из AWS Marketplace. Если вы хотите запустить нестандартную версию MikoPBX, воспользуйтесь подробной инструкцией, где мы по шагам описали, каким образом можно создать AMI-образ из любого дистрибутива MikoPBX. Если же вы хотите управлять инфраструктурой как кодом и воспроизводить окружение автоматически — воспользуйтесь нашим Terraform-руководством, которое описывает полный цикл развёртывания MikoPBX в AWS: от импорта образа до запуска инстанса.

    Обновление из консоли MikoPBX

    Вариант обновления из консоли MikoPBX

    Ниже приведен пример с АТС, установленной на виртуальную машину VirtualBOX. Обновление производится с версии 2022.2.102 до версии 2022.3.15. Скачайте из репозитория iso-образ нужной вам версии АТС.

    iso-образ в репозитории релизов MikoPBX

    В программе VirtualBOX откройте настройки виртуальной машины на которой установлена АТС. Перейдите в раздел Носители. Выделите виртуальный оптический привод. Нажмите на значок в группе Атрибуты, нажмите Выбрать файл диска. Выберите скачанный iso-образ АТС. Запустите машину.

    Выбор файла диска в интерфейсе VirtualBox

    В консоли отобразится соответствующая строка "The system loaded in Recovery mode" («АТС загружена в режиме восстановления» на русском).

    Консоль MikoPBX

    Выберите Install / Repair (или нажмите на клавиатуре цифру 8) и нажмите «Enter».

    Вам нужна команда "Update to version ****.*.**". Нажмите на клавиатуре цифру 2, затем нажмите «Enter». Начнется установка обновления. Когда она завершится, АТС перезагрузится.

    После перезагрузки АТС сообщения "The system loaded in Recovery mode" уже не будет, что означает, что АТС загрузилась с жесткого диска, а не с виртуального оптического привода. Вверху зеленым шрифтом будет обозначена установленная версия обновления.

    Модули

    Описание раздела Модули в MikoPBX

    Раздел «Модули» в MikoPBX — это интерфейс для управления дополнительными функциональными компонентами системы, который включает два подраздела: «Управление модулями» и «Приложения диалплана».

    Управление этими подразделами позволяет настроить MikoPBX максимально гибко и эффективно, расширяя функциональность телефонной системы и адаптируя ее под уникальные требования организации.

    Раздел "Модули" в MikoPBX

    Регистрация в маркетплейсе модулей

    Регистрация в маркетплейсе модулей

    Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.

    Регистрация даст вам доступ к дополнительным модулям и расширениям.


    Управление модулями

    Управление модулями

    Управление модулями в MikoPBX — это интерфейс для управления дополнительными компонентами системы, расширяющими ее функциональность. Здесь администраторы могут устанавливать, обновлять, включать или отключать модули, добавляя новые возможности или интеграции с внешними сервисами. Этот раздел позволяет адаптировать систему под специфические потребности компании, обеспечивая гибкость и масштабируемость телефонной сети.


    Приложения диалпланов в MikoPBX — это набор инструментов, которые позволяют настраивать индивидуальные сценарии обработки звонков внутри системы. С их помощью вы можете определить последовательность действий, которую система выполнит при поступлении или совершении вызова. Это может включать перенаправление звонка на определенный внутренний номер, воспроизведение специальных аудиосообщений, запрос дополнительной информации у звонящего или выполнение других функций.

    Используя приложения диалпланов, вы можете гибко настроить логику работы телефонной системы под потребности вашего бизнеса, не углубляясь в сложное программирование. Это облегчает создание сложных сценариев обработки вызовов, позволяя улучшить эффективность коммуникаций и повысить уровень обслуживания клиентов.

    Сеть и Firewall

    Описание раздела Сеть и Firewall в MikoPBX

    Раздел «Сеть и Firewall» в MikoPBX — это интерфейс для настройки сетевых параметров и управления брандмауэром системы. Здесь администраторы могут настраивать IP-адреса, сетевые интерфейсы и создавать правила брандмауэра для защиты системы от несанкционированного доступа. Этот раздел обеспечивает безопасную и стабильную работу MikoPBX в сетевой инфраструктуре организации.

    Раздел "Сеть и Firewall" в MikoPBX

    Сетевые интерфейсы

    Сетевые интерфейсы

    Раздел «Сетевые интерфейсы» в MikoPBX — это интерфейс для настройки параметров сетевых подключений системы. Здесь администраторы могут управлять IP-адресами, масками подсети, шлюзами и другими сетевыми настройками для каждого сетевого интерфейса. Это позволяет корректно интегрировать MikoPBX в сеть организации и обеспечить ее стабильную работу в соответствии с требованиями сетевой инфраструктуры.


    Сетевой экран (Firewall)

    Сетевой экран

    Раздел «Сетевой экран» в MikoPBX — это интерфейс для настройки брандмауэра (Firewall) системы. Здесь администраторы могут создавать и управлять правилами фильтрации сетевого трафика, контролируя доступ к MikoPBX и защищая ее от несанкционированного доступа и сетевых угроз. Настройка сетевого экрана обеспечивает безопасность телефонной системы, предотвращая потенциальные атаки и обеспечивая стабильную работу в сетевой инфраструктуре организации.


    Защита от взлома (Fail2Ban)

    Защита от взлома

    Раздел «Защита от взлома (Fail2Ban)» в MikoPBX — это инструмент для обеспечения безопасности системы от несанкционированного доступа и сетевых атак. Fail2Ban мониторит журналы событий и автоматически блокирует IP-адреса, с которых происходят подозрительные или многократные неудачные попытки входа. Настройка этого раздела помогает предотвратить взлом системы и защитить конфиденциальные данные организации.

    Дата и время

    В данном разделе происходит настройка часов и календаря

    Раздел «Дата и время» в MikoPBX — это интерфейс для настройки системных параметров даты и времени. Здесь администраторы могут установить текущую дату и время, выбрать часовой пояс и настроить синхронизацию с серверами точного времени (NTP). Корректная настройка даты и времени важна для точной регистрации событий, журналов вызовов и работы функций, зависящих от расписания, обеспечивая синхронизацию системы с другими сетевыми устройствами и сервисами.

    Настройка производится в разделе «Система» - «Дата и время»:

    Раздел "Дата и время" в MikoPBX

    Существует возможность установить время «вручную», без использования NTP сервера. По возможности, рекомендуем использовать автоматическое определение времени.

    Для настройки времени вручную переключите тумблер "Корректировать время вручную"

    Элемент для корректировки времени вручную

    Звуковые файлы

    Добавление/создание звуковых файлов в MikoPBX

    Звуковые файлы в MikoPBX — это аудиозаписи, которые используются системой для воспроизведения различных сообщений, таких как приветствия, объявления, инструкции в IVR-меню или сигналы ожидания. Они позволяют персонализировать аудиоконтент, который слышат звонящие, улучшая взаимодействие с системой и предоставляя необходимую информацию.

    Звуковые файлы в MikoPBX используются в различных сценариях звонков и интерактивных голосовых меню (в IVR меню, в Нерабочем времени, в Очередях вызовов и для разных системных оповещений, а также В музыке на удержании) для воспроизведения голосового приветствия или оповещения клиента.

    Список доступных звуковых файлов отображается в разделе "Телефония" -> "Звуковые файлы".

    Для добавления нового звукового файла нажмите "Добавить звуковой файл".

    Установка докера и cоздание пользователя и каталогов

    Подготовка к установке MikoPBX в Docker-контейнер

    Перед началом работы с Docker, необходимо установить сам Docker и Docker Compose. Вот как это можно сделать:

    Перед созданием контейнера на хостовой машине необходимо создать пользователя и группу с ограничеными правами, а также папку для хранения настроек конфигурации и записей разговоров.

    Команда для подключения к консоли АТС:

    Команда для подключения к консольному меню АТС:

    Подключение к shgrep для анализа SIP

    Маршрутизация

    Описания раздела маршрутизации MikoPBX

    Раздел «Маршрутизация» в MikoPBX — это интерфейс для настройки правил направления вызовов внутри телефонной системы. Здесь администраторы могут определить, как обрабатывать входящие и исходящие звонки, устанавливая условия и маршруты для эффективного распределения звонков между сотрудниками, отделами или внешними линиями.

    Провайдеры телефонии в MikoPBX — это раздел системы, где настраиваются подключения к внешним операторам связи через интернет-протоколы для IP-телефонии. Здесь администраторы могут добавлять и настраивать учетные записи SIP-транков или других типов соединений, которые позволяют системе совершать и принимать звонки с городских и мобильных номеров.

    В данной статье Вы найдете подробную документацию по подключению провайдеров к станции, их настройку и особенности.


    Входящие маршруты в MikoPBX — это набор правил, определяющих, как система обрабатывает входящие звонки от внешних провайдеров телефонии. С их помощью администраторы могут настраивать направления вызовов в зависимости от различных условий, таких как номер вызывающего абонента, время суток или конкретный номер, на который поступил звонок. Это позволяет автоматически распределять входящие звонки на определенных сотрудников, отделы, IVR-меню или очереди вызовов. Настройка входящих маршрутов способствует оптимизации обработки вызовов и повышению качества обслуживания клиентов, обеспечивая гибкое и эффективное управление телефонными коммуникациями в компании.

    Телефония

    Описание раздела телефонии MikoPBX

    Глава "Телефония" в документации MikoPBX содержит подробную информацию и инструкции, связанные с настройкой и использованием телефонии в системе.

    Сотрудники в MikoPBX — это индивидуальные пользователи системы, которым назначены внутренние номера для совершения и приема звонков. Они имеют персональные учетные записи, позволяющие настроить права доступа, переадресацию вызовов и другие персональные настройки в системе.

    В данной статье Вы найдете подробную документацию по добавлению новых сотрудников в станцию, настройку их прав и профилей. Помимо этого, информацию про их дополнительные параметры.


    Очереди вызовов в MikoPBX — это функция, позволяющая распределять входящие звонки между группой операторов, удерживая вызовы в очереди до момента, когда оператор станет доступен. Это обеспечивает эффективное управление большим потоком звонков и улучшает качество обслуживания клиентов.

    Обновление из web-интерфейса

    Вариант обновления из web-интерфейса

    В некоторых разделах интерфейса (например, Сотрудники) в правом нижнем углу указана текущая версия MikoPBX.

    В web-интерфейсе АТС перейдите в Обслуживание → Обновление PBX.

    Если есть версии АТС новее вашей текущей, они будут отображены в таблице Доступны онлайн обновления, в которой в первом поле номер версии, а во втором - список изменений.

    Далее возможны два варианта обновления: обновление онлайн, обновление скачанным img-файлом.

    Настройка Proton (Логин, Пароль)

    Настройка почты для сервиса proton.me

    1. Для начала, перейдите в настройки своего аккаунта Proton ().

    1. Далее перейдите в раздел "Proton Mail" -> "IMAP/SMTP".

    Система

    Описание раздела "Система" в MikoPBX

    Раздел «Система» в MikoPBX — это интерфейс для управления общими настройками и параметрами телефонной системы. Здесь администраторы могут настраивать основные системные параметры, управлять обновлениями, датой и другими функциями, обеспечивающими стабильную и безопасную работу MikoPBX. Этот раздел позволяет контролировать и оптимизировать работу системы на уровне всей инфраструктуры.

    В разделе «Общие настройки» в MikoPBX администраторы могут управлять основными параметрами системы, такими как настройки срока хранения записей разговоров, уведомления, параметры журналов, язык звуковых оповещений и многими другими системными опциями. Этот раздел обеспечивает контроль над общими функциями и поведением MikoPBX, позволяя оптимизировать работу системы под потребности организации.


    Раздел «Дата и время» в MikoPBX — это интерфейс для настройки системных параметров даты и времени. Здесь администраторы могут установить текущую дату и время, выбрать часовой пояс и настроить синхронизацию с серверами точного времени (NTP). Корректная настройка даты и времени важна для точной регистрации событий, журналов вызовов и работы функций, зависящих от расписания, обеспечивая синхронизацию системы с другими сетевыми устройствами и сервисами.


    Перезагрузка и выключение системы

    Описание возможностей раздела

    Меню выключения/перезагрузки системы вы можете найти в MikoPBX в "Перезагрузка" -> "Обслуживание".

    При открытии страницы будет отображен список активных звонков на АТС. Отображается дата начала звонка, «Кто» и «Кому» звонит.

    • «Перезагрузить АТС» - команда начинает перезагрузку станции.

    Конференции

    Создание и настройка конференций в MikoPBX

    Конференции в MikoPBX — это функция, позволяющая организовывать групповые телефонные звонки с участием нескольких абонентов одновременно. Она позволяет проводить коллективные обсуждения, совещания и встречи по телефону, улучшая коммуникацию как внутри компании, так и с внешними партнерами.

    Список конференц-комнат располагается в разделе "Телефония" -> "Конференции".

    Для создания новой конференц-комнаты нажмите кнопку Добавить конференцию.

    Необходимо указать название конференции и ее внутренний номер, позвонив на который можно в эту конференцию зайти.

    Защита от взлома

    В данном разделе производится настройка Fail2ban.

    Fail2ban включается вместе с Сетевым экраном переключателем в разделе Сеть и Firewall → Сетевой экран.

    Сервис Fail2ban блокирует IP адреса с нестандартной активностью. При неудачной попытке авторизации в лог АТС попадет информация об ошибке, Fail2ban анализирует все неудачные попытки авторизации и считает их. Когда количество неудачных попыток авторизации превышает максимально допустимое количество, IP-адрес отправляется в бан.

    Настройки защиты от взлома можно найти в боковом меню:

    Обновление PBX

    Данная статья содержит пошаговые инструкции по обновлению MikoPBX на более новую версию.

    Установка докера и cоздание пользователя и каталогов

    Команды для установки Docker и Docker Compose и настройка перед созданием контейнера

    Запуск MikoPBX в контейнере

    Инструкции по запуску готового контейнера MikoPBX, созданию контейнера из произвольного образа и его запуску

    Запуск MikoPBX с помощью docker compose

    Инструкции по запуску нескольких MikoPBX на одном хосте с помощью docker compose

    Внешний файрвол для Docker

    Как защитить веб-интерфейс при `userland-proxy=true`: внешний bouncer или host-режим.

    Cover
    Cover
    Cover
    Cover

    Google Cloud Маркетплейс

    Инструкция по установке готового образа из Google Cloud Маркетплейс

    Google Cloud подробная инструкция

    Подробная инструкция по загрузке MikoPBX из образа на основе .vhd файла из дистрибутива

    Cover
    Cover

    Перезагрузка и выключение системы

    Перезагрузка и выключение системы

    AWS Подробная инструкция

    Подробная инструкция по созданию AMI образа

    AWS Маркетплейс

    Инструкция по установке готового образа из AWS Marketplace

    AWS terraform скрипт

    Инструкция по установке с помощью terraform (IaC)

    Cover
    Cover
    Cover
    Установка обновления
    Обновленная версия

    Приложения диалпланов

    Приложения диалпланов
    Без словарных слов, имён и дат рождения

    Snom

    Authentication Username

    Linphone

    Auth userid

    Zoiper

    Authentication user / Auth. Username

    MicroSIP

    Login

    Cisco (SPA)

    Auth ID

    Паранойя — 3 попытки за 24 часа, бан на 30 дней. Для серверов под активной атакой.
    правильно укажите топологию сети и внешний адрес. (Подробнее читайте
    ).
  • - ручная настройка маршрутизации.
  • Сотрудники — управление учётными записями и SIP-паролями.

  • Обновиться до версии 2026.1.223 или новее.

  • Установить патч безопасности (см. ниже).

  • Закрыть WEB, CTI и SIP-доступ к станции из2вне.

  • Обновить все пароли.

  • Yealink

    Register Name / Authentication User

    Grandstream

    Authenticate ID

    Fanvil

    Authentication User

    Для удалённых сотрудников с динамическим IP рекомендуем подключить у их интернет-провайдера услугу статического IP-адреса (обычно 100–200 ₽/мес). Альтернатива — VPN: все удалённые сотрудники подключаются через VPN-сервер, и в Firewall добавляется только его адрес.

    Закройте веб-интерфейс и CTI от интернета

    Используйте сложные пароли

    Измените имя авторизации (Auth Username)

    Включите защиту от перебора паролей (Fail2Ban)

    Убедитесь, что в белом списке указаны адреса вашего офиса, чтобы случайно не заблокировать себя.

    Fail2Ban не заменяет сложные пароли — даже с включённым Fail2Ban простой пароль может быть подобран.

    Защита веб-интерфейса в Docker

    Не публикуйте АТС на публичном IP-адресе

    Финансовая защита

    Установите лимит расходов у провайдера

    Не держите на счёте большие суммы

    Что делать, если взлом уже произошёл?

    Обращаться следует именно в УФСБ, а не в МВД — это инцидент в сфере ИТ-безопасности, а не мошенничество с вашей стороны. На месте можно указать, что письменный ответ не требуется.

    Чек-лист безопасности

    Полезные ссылки

    Сетевой экран
    внешний firewall-bouncer
    Сетевой экран
    Защита от взлома (Fail2Ban)
    Сетевые интерфейсы
    Сетевые маршруты
    Раздел "Защита от взлома"
    в этой статье

    В данной статье Вы найдете подробную документацию по настройке входящей маршрутизации.


    Исходящие маршруты в MikoPBX — это набор правил и настроек, определяющих, как система обрабатывает исходящие звонки от сотрудников к внешним номерам. С их помощью администраторы могут управлять направлением вызовов через различные провайдеры телефонии или линии связи в зависимости от определенных условий, таких как набранный номер, префиксы, время суток или права доступа пользователя. Это позволяет оптимизировать затраты на связь, распределять нагрузку между каналами и применять политики безопасности, ограничивая или разрешая определенные типы вызовов. Настройка исходящих маршрутов обеспечивает гибкость и контроль над исходящей телефонной связью, способствуя эффективной работе коммуникационной системы компании.

    В данной статье Вы найдете подробную документацию по настройке исходящей маршрутизации.


    Нерабочее время в MikoPBX — это инструмент для настройки правил обработки вызовов в периоды, когда компания не работает, например, ночью, в выходные или праздничные дни. С его помощью администраторы могут определить, как система будет обрабатывать входящие звонки в нерабочие часы: перенаправлять на автоответчик, воспроизводить специальные голосовые сообщения или переадресовывать вызовы на мобильные номера дежурных сотрудников. Это позволяет обеспечить корректное взаимодействие с клиентами вне рабочего времени и поддерживать высокий уровень обслуживания.

    В данной статье Вы найдете подробную документацию по настройке нерабочего времени для Вашей станции.

    Провайдеры телефонии

    Входящие маршруты (Входящая маршрутизация)

    Провайдеры телефонии
    Входящие маршруты
    Раздел "Маршрутизация" в MikoPBX

    Исходящие маршруты (Исходящая маршрутизация)

    Нерабочее время

    Исходящие маршруты
    Нерабочее время
    В данной статье Вы найдете подробную документацию по созданию и настройке таких очередей.

    IVR меню в MikoPBX — это интерактивное голосовое меню, которое позволяет звонящим взаимодействовать с телефонной системой с помощью тонового набора (DTMF). Оно автоматически направляет вызовы к нужным отделам или сотрудникам, улучшая эффективность обработки звонков и повышая качество обслуживания клиентов.

    В данной статье вы найдете документацию по созданию и настройке IVR меню.


    Конференции в MikoPBX — это функция, позволяющая организовывать групповые телефонные звонки с участием нескольких абонентов одновременно. Она позволяет проводить коллективные обсуждения, совещания и встречи по телефону, улучшая коммуникацию как внутри компании, так и с внешними партнерами.

    В данной статье вы найдете документацию по созданию и настройке комнат конференций.


    Звуковые файлы в MikoPBX — это аудиозаписи, которые используются системой для воспроизведения различных сообщений, таких как приветствия, объявления, инструкции в IVR-меню или сигналы ожидания. Они позволяют персонализировать аудиоконтент, который слышат звонящие, улучшая взаимодействие с системой и предоставляя необходимую информацию.

    В данной статье вы найдете подробную информацию про них, а так же способы добавления и их редактирования.


    История вызовов в MikoPBX — это журнал, который сохраняет информацию о всех входящих и исходящих звонках через систему. Она предоставляет детальные данные о каждом вызове, включая время, длительность, номера участников и статус, что позволяет анализировать коммуникации и оптимизировать работу телефонной сети компании. В данной статье Вы найдете информацию про хранение записей разговоров и их фильтров.

    Сотрудники

    Очереди вызовов

    Сотрудники
    Очереди вызовов
    Раздел "Телефония" в MikoPBX

    IVR меню

    Конференции

    Звуковые файлы

    История вызовов

    IVR меню
    Конференции
    Звуковые файлы
    История вызовов
    Раздел «Почта и уведомления» в MikoPBX позволяет настроить отправку системных уведомлений через электронную почту. Здесь администраторы указывают параметры SMTP-сервера, определяют события для уведомлений, такие как голосовые сообщения или системные ошибки, и редактируют шаблоны писем. Этот раздел помогает своевременно информировать пользователей и администраторов о важных событиях, обеспечивая эффективный контроль за работой системы.

    Раздел «Доступ к AMI» в MikoPBX — это интерфейс для настройки доступа к Asterisk Manager Interface (AMI). Здесь администраторы могут управлять параметрами подключения к AMI, такими как включение или отключение доступа, указание логинов и паролей для аутентификации. Настройка доступа к AMI позволяет внешним приложениям или скриптам взаимодействовать с системой MikoPBX для мониторинга и управления звонками, расширяя функциональные возможности телефонной системы.


    Раздел «Кастомизация системных файлов» в MikoPBX предоставляет администраторам возможность напрямую изменять или дополнять стандартные конфигурационные файлы системы. Здесь вы можете внести индивидуальные настройки, которые не доступны через стандартный веб-интерфейс, и адаптировать поведение системы под специфические требования вашей организации.

    Этот раздел предназначен для продвинутых пользователей, которые обладают глубоким пониманием структуры и работы MikoPBX. С его помощью можно:

    • Редактировать конфигурационные файлы: вносить изменения в существующие файлы или добавлять новые параметры.

    • Переопределять стандартные настройки: изменять значения по умолчанию для определенных функций или модулей.

    • Добавлять собственные скрипты или модули: расширять функциональность системы путем интеграции пользовательских решений.

    Важно отметить, что неправильное изменение системных файлов может привести к нестабильной работе или сбоям системы. Поэтому рекомендуется создавать резервные копии перед внесением изменений и тщательно проверять корректность настроек.

    Общие настройки

    Дата и время

    Почта и уведомления

    Общие настройки
    Дата и время
    Раздел "Система" в MikoPBX

    Доступ к AMI

    Кастомизация системных файлов

    Доступ к AMI
    Кастомизация системных файлов
    yc compute zone list 
    # Создание нового пользователя (например, www-user) без прав суперпользователя
    sudo adduser --disabled-password --gecos "" www-user
    
    # Создание каталогов для хранения данных
    sudo mkdir -p /var/spool/mikopbx/cf
    sudo mkdir -p /var/spool/mikopbx/storage
    
    # Назначение прав созданному пользователю на каталоги
    sudo chown -R www-user:www-user /var/spool/mikopbx/

    Установка Docker и Docker Compose на Ubuntu 22.04

    Создание пользователя и каталогов на хост-системе

    Полезные команды

    yc compute instance create \
    	--folder-name apor-test-catalog \
    	--name test\
    	--zone ru-central1-c \
    	--cores 2 \
    	--memory 2gb \
    	--create-boot-disk image-id=fd83g1qbk6m3jnl5cvah \
    	--ssh-key ~/.ssh/id_rsa.pub \
    	--public-ip \
    	--create-disk name=storage-test-mikopbx,size=20,auto-delete=1
    yc compute instance list                 
    +----------------------+-----------------+---------------+---------+-----------------+-------------+
    |          ID          |      NAME       |    ZONE ID    | STATUS  |   EXTERNAL IP   | INTERNAL IP |
    +----------------------+-----------------+---------------+---------+-----------------+-------------+
    | ef38gedvuug8qvv4l74p | test            | ru-central1-c | RUNNING | 51.250.39.55    | 10.130.0.6  |
    +----------------------+-----------------+---------------+---------+-----------------+-------------+
    # Обновление списка пакетов и установка необходимых зависимостей
    sudo apt update
    sudo apt install apt-transport-https ca-certificates curl software-properties-common
    
    # Добавление ключа GPG официального репозитория Docker
    curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
    
    # Добавление репозитория Docker в список источников APT
    sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
    
    # Установка Docker CE
    sudo apt update
    sudo apt install docker-ce
    
    # Установка 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
    
    # Проверка версии Docker Compose
    sudo docker-compose --version
    
    sudo docker exec -it mikopbx sh
    sudo docker exec -it mikopbx /etc/rc/console_menu
    sudo docker exec -it mikopbx sngrep
    Выберите загруженный ранее образ MikoPBX
  • Настройте два диска, первый на 5Гб, второй на 50Гб

  • В разделе "Сеть" - "Публичный IP" - выберите "Создать новый публичный IP"

  • В разделе "Доступ" задайте сложный пароль

  • Кликните по кнопке "Создать сервер" и дождитесь завершения операции

  • Создание сервера

    Вход в web интерфейс

    https://docs.mikopbx.com/mikopbx/setup/cloud/selectel
    Элемент "Добавить новый звуковой файл"

    Нажмите Загрузить и выберите звуковой файл.

    Кнопка для загрузки новых файлов

    Откорректируйте наименование файла при необходимости.

    Имя файла записи

    Сохраните изменения.

    Запись файла с помощью микрофона, используя протокол https

    Пользовательские звуковые файлы хранятся на АТС по пути /storage/usbdisk1/mikopbx/media/custom. Музыка на удержании хранится в /storage/usbdisk1/mikopbx/media/moh.

    Если клиент при звонке попадает в очередь или ожидает переадресацию, АТС проигрывает для него мелодию. Есть возможность загрузить свои мелодии для прослушивания во время ожидания. Это можно сделать на вкладке Музыка на удержании описанным выше способом.

    Вкладка "Музыка на удержании"

    Загрузка звукового файла на АТС

    Поддерживаемые форматы файлов: wav, mp3, ogg, m4a, aac.

    Раздел "Звуковые файлы"

    При работе по протоколу https есть возможность записать звуковой файл с использованием микрофона. При работе по https должен использоваться доверенный сертификат.

    Музыка на удержании

    Обновления загружаются на АТС и сразу же применяются. Для обновления таким способом нажмите кнопку
    в нужной вам версии обновления.
    Кнопка для обновления системы

    Появится окно предупреждения. Нажмите в нем Обновить.

    Окно предупреждения

    АТС загрузит и применит обновления, а затем перезагрузится.

    Для обновления данным способом нажмите кнопку в нужной вам версии обновления.

    Кнопка для загрузки файла обновления

    Начнется скачивание img-образа. Дождитесь завершения загрузки.

    Затем нажмите кнопку и выберите данный img-файл.

    Выбор файла для обновления

    Затем нажмите Применить обновление, а в появившемся окне предупреждения нажмите Обновить.

    Установка обновления

    Начнется применение обновлений. После окончания которого АТС перезагрузится.

    Процесс обновления

    Рекомендуем проводить обновления последовательно, «не перепрыгивая» через релизы.

    Обновление онлайн

    Будьте внимательны! Если система установлена на тот же диск, где хранятся записи разговоров, то могут быть сложности с обновлением. см. форум

    Отображение версии в web-интерфейсе
    Раздел "Обновление PBX"
    Раздел "Доступные онлайн обновления"

    Обновление скачанным img-файлом

    Следует сразу заметить, что данным способом можно выполнить не только обновление, но и откат на более прежнюю версию.

    Далее пролистайте до секции "SMTP submission". Нажмите "Generate token".

    Кнопка для создания нового токена "Generate token"
    1. Введите произовольное название в поле "Token name" - MikoPBX в нашем случае, так же выберите Email address для которого Вы создаете токен.

    Создание нового SMTP токена

    Будет создан токен. Его параметры будут показаны один раз и когда Вы закроете окно, станут недоступны. Сохраните их, мы будем использовать их для дальнейшей настройки.

    Параметры созданного токена
    1. Перейдите в раздел "Система" -> "Почта и уведомления".

    Раздел "Система" -> "Почта и уведомления".
    1. Перейдите в "Настройки SMTP". Заполните все необходимые параметры:

    • Адрес отправителя - Ваш адрес электронной почты, под которым Вы генерировали токен.

    • Имя отправителя - имя от которого отправляется почта.

    • Тип аутунтификации - "Логин и пароль".

    • SMTP логин - SMTP Username из окна с данными токена.

    • SMTP пароль - SMTP token из окна с данными токена.

    • SMTP хост - smtp.protonmail.ch

    • SMTP порт - 587.

    • Тип шифрования - STARTLS (порт 587).

    Нажмите "Сохранить".

    Параметры почты в MikoPBX

    Нажмите "Проверить подключение". Вы увидите следующее окно, подтверждающее правильность введенных данных:

    Успешное подключение

    Генерация SMTP токена

    ссылка
    Настройки учетной записи Proton
    Раздел "IMAP/SMTP"

    Подключение в MikoPBX

    «Выключение АТС» - завершает все процессы и отключает станцию.

    Опции выключения/перезагрузки системы

    Вы можете перезагрузить станцию через консольное меню. Для этого выберете раздел «[3] Перезагрузить систему».

    Консоль MikoPBX

    Если вы хотите перезагрузить станцию: нажмите «[1] Перезагрузить MikoPBX».

    Если вы хотите выключить станцию: нажмите «[2] Выключить».

    Перезагрука/выключение станции

    В случае аварийной перезагрузки АТС (например, выключение электроэнергии) может потребоваться выполнить проверку диска на ошибки.

    В консольном меню АТС введите команду «[9] Консоль(Shell)» и нажмите Enter

    Система запустит консоль АТС.

    Консольное меню MikoPBX

    Введите команду Reboot. Нажмите Enter

    Система перезагрузится с проверкой диска.

    Команда Reboot

    Перезагрузка станции через интерфейс MikoPBX

    Пока есть активные вызовы перезагрузка и отключение не будут доступны через web интерфейс.

    Раздел "Обслуживание" -> "Перезагрузка"
    Список активных звонков

    Перезагрузка станции через консольное меню

    Перезагрузка с проверкой диска

    Для того чтобы в конференцию не могли зайти сотрудники, для которых это обсуждение не предназначено, можно защитить конференц-комнату паролем. Для этого заполните поле PIN-код. В это поле можно вводить только цифры, минимум одна цифра.
    Установка пин-кода для входа в конференцию

    В этом случае для того чтобы попасть в данную конференцию сотруднику после набора номера конференции необходимо будет ввести пин-код.

    • Все собеседники общаются только голосом (никаких других способов передачи информации, кроме речевого, не предоставляется);

    • все собеседники могут говорить и слышать друг друга одновременно (то есть обеспечивается дуплексная связь);

    • участники используют для общения телефоны (аппаратные или программные).

    • Каждый участник конференции звонит на номер конференции. Первый участник слышит музыку на удержании до тех пор, пока к конференции не присоединится хотя бы еще один участник.

    • Сотрудник может перевести своего собеседника в конференцию, реализовав перевод с помощью комбинации стар-кодов на своем телефоне. Перевести в конференцию можно как внутренний номер, так и внешний. Комбинация для переводов задается в разделе "Система" -> "Общие настройки" -> "Переводы вызовов". Пример: Сотрудник набирает комбинацию **1111 (комбинация для безусловного перевода) и его собеседник попадает в конференцию и становится её первым участником. У переводившего сотрудника вызов завершается, и, чтобы попасть в конференцию он звонит на номер конференции 1111.

    Создание конференц-комнат

    Раздел "Телефония" -> "Конференции"
    Кнопка "Добавить конференцию"
    Название и внутренний номер конференции

    Характерные особенности конференц-связи

    Использование

    Максимальное количество участников конференции не ограничено.

    Если происходит определенное число неудачных попыток входа "Количество попыток для блокировки" в течение определенного периода "В течение (секунд)", IP адрес будет заблокирован в течение заданного периода времени "Блокировать на (секунд)".
  • Белый список адресов определяет IP - адреса, которые не будут заблокированы Fail2ban. Указывать можно как ip адрес 93.188.40.10, так и подсеть 93.188.40.0/24. В качестве разделителя используется «пробел».

  • Обратите внимание, что если Вы в разделе «Сетевой экран» для подсети указали настройку «Никогда не блокировать адреса из этой сети», то подсеть автоматом попадает в белый список и добавлять ее вручную не требуется. Не нужно пытаться наполнять вручную список белых IP-адресов, желательно в исключительных случаях прописывать IP-адреса.

  • Максимальное количество входящих пакетов SIP - опция позволяет ограничить количество пакетов с одного IP адреса в секунду. Если ограничение будет превышено, новые пакеты будут отброшены. Это может повысить устойчивость сервера к атакам.

  • Параметры защиты

    Список заблокированных адресов показывает , какие IP-адреса в настоящее время заблокированы.

    Список заблокированных адресов

    Так же вы можете разблокировать адрес кликом на соответствующую кнопку в таблице.

    Будьте внимательны, Fail2ban не поможет при использовании простых паролей.

    Переключатель "Сетевой экран и защита от взлома включены"
    Раздел "Защита от взлома"

    В Docker (bridge) fail2ban пишет блокировки в Redis, но контейнер не управляет iptables хоста — для веб-интерфейса блокировки не применяются автоматически. Чтобы перенести их на host, поднимите внешний bouncer (см. ). SIP-защита при этом работает обычным способом.

    Перед обновлением обязательно сделайте резервную копию настроек АТС. Делается это при помощи .

    Cover

    Обновление онлайн из web-интерфейса

    Через web-интерфейс MikoPBX, используя встроенный механизм обновлений

    Cover

    Обновление из консоли MikoPBX

    Из консоли MikoPBX командой для загрузки и установки новой версии

    Cover

    Обновление Docker

    Путём скачивания последнего образа контейнера MikoPBX и перезапуска с новым образом

    Установка системы на USB носитель (Bootable USB)

    Установка системы на USB-носитель

    Перед началом загрузите образ диска с расширением .raw. Сделать это можно здесь.

    Установка системы на USB-носитель

    Windows

    Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!

    В данной инструкции будет использоваться утилита balenaEtcher. Скачать можно по ссылке.

    1. Первым делом, отформатируйте Ваш USB-носитель со следующими параметрами:

    • File system - FAT32

    • Allocation unit size - 8192 bytes

    1. Откройте balenaEtcher. Нажмите "Flash from file" и выберите ранее загруженный .raw файл.

    1. Нажмите "Select target".

    1. Из списка выберите Ваш USB-носитель.

    Нажмите "Select 1".

    1. Далее нажмите "Flash!"

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

    1. Подключите Ваш usb-носитель и откройте Terminal.

    1. Выполните команду:

    Будет отображена информация про все подключенные диски. Нас интересует диск с маркировкой (external, physical). В нашем случае это disk4, в Вашем случае номер может быть другим. Используйте его номер для выполнения дальнейших шагов в этой инструкции.

    1. Далее необходимо отформатировать USB носитель. Для этого используйте команду:

    Для подтверждения введите пароль администратора, дождитесь окончания форматирования.

    1. Отмонтируйте (отключите) диск, используя следующую команду:

    1. Запишите образ на USB-носитель, используя следующую команду:

    Дождитесь окончания записи образа. Далее перейдите к разделу "".

    В данной инструкции в качестве примера, запись образа будет произведена на Ubuntu 24.04.

    1. Подключите Ваш usb-носитель и откройте Terminal.

    1. Выполните команду:

    Будет отображена информация про все подключенные диска. Найдите в этом списке Ваш usb-носитель и запомните его наименование. В нашем случае, это диск sdb.

    1. Далее необходимо отформатировать usb-носитель, используя следующую команду:

    Для подтверждения введите пароль администратора, дождитесь окончания форматирования.

    1. Отмонтируйте (отключите) диск, используя следующую команду:

    1. Запишите образ на USB-носитель, используя следующую команду:

    Дождитесь окончания записи образа. Далее перейдите к разделу "".

    1. Запуститесь с USB-носителя. При возникновении ошибок (черный экран) - убидитесь, что:

    • Secure Boot - Disabled

    • CSM (Compatibility Support Module) - Enabled

    1. Система успешно загружена, но не подключен диск для хранения записей разговоров. Для его подключения, передвигаясь стрелочками на клавиатуре, перейдите в пункт "[6] Data storage" и нажмите Enter.

    1. Далее выберите пункт "Mount drive as data storage" для подключения диска.

    1. Выберите диск, который будет использоваться для хранения записей разговоров. Для этого введите его ID (название), например sdc в нашем случае.

    Нажмите Enter.

    1. После этого система перезагрузится и будет готова к работе и первой авторизации в Web-интерфейс.

    Для перехода в Web-интерфейс, введите IP-адрес Вашей MikoPBX в строку браузера. Используйте стандартные данные для авторизации.

    Установка с записью образа на USB-носитель (Live USB)

    Установка системы с помощью записи образа на USB-носитель

    Запись образа на USB-носитель

    Windows

    Перед началом процесса, отформатируйте Ваш носитель со следующими параметрами:

    • File system - FAT32

    • Allocation unit size - 8192 bytes

    Форматирование диска

    Для записи образа будет использована утилита Rufus. Скачать ее можно по ссылке.

    Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!

    1. После установки утилиты, перейдите в ее интерфейс. В разделе "Device" выберите Ваш носитель, нажмите SELECT и выберите ранее загруженный . Начнется его проверка.

    1. После окончания проверки, установите следующие параметры и нажмите "START":

    • File system - FAT32

    • Cluster size - 8192 Bytes

    • Quick format - отмечено

    1. После этого, во всплывающем окне выберите "Write in DD Image mode". Нажмите "OK".

    1. Во всплывающем предупреждении, о том, что все данные на диске будут удалены, нажмите "ОК".

    Дождитесь окончания записи образа. По его завершении, Вы увидите надпись "READY". Далее перейдите к разделу .

    1. Подключите Ваш usb-носитель и откройте Terminal.

    1. Выполните команду:

    Будет отображена информация про все подключенные диски. Нас интересует диск с маркировкой (external, physical). В нашем случае это disk4, в Вашем случае номер может быть другим. Используйте его номер для выполнения дальнейших шагов в этой инструкции.

    1. Далее необходимо отформатировать USB носитель. Для этого используйте команду:

    Для подтверждения введите пароль администратора, дождитесь окончания форматирования.

    1. Отмонтируйте (отключите) диск, используя следующую команду:

    1. Запишите образ на USB-носитель, используя следующую команду:

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

    В данной инструкции в качестве примера, запись образа будет произведена на Ubuntu 24.04.

    1. Подключите Ваш usb-носитель и откройте Terminal.

    1. Выполните команду:

    Будет отображена информация про все подключенные диска. Найдите в этом списке Ваш usb-носитель и запомните его наименование. В нашем случае, это диск sdb.

    1. Далее необходимо отформатировать usb-носитель, используя следующую команду:

    Для подтверждения введите пароль администратора, дождитесь окончания форматирования.

    1. Отмонтируйте (отключите) диск, используя следующую команду:

    1. Запишите образ на USB-носитель, используя следующую команду:

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

    1. Запуститесь с USB-носителя. При возникновении ошибок (черный экран) - убидитесь, что:

    • Secure Boot - Disabled

    • CSM (Compatibility Support Module) - Enabled

    1. Система загружена в режиме LiveCD, об этом нам говорит красная надпись. Необходимо произвести установку. Для этого, передвигаясь стрелочками на клавиатуре, перейдите в раздел "[8] Install". Нажмите "Enter".

    1. Выберите диск, который будет использоваться для установки системы. Для этого введите его ID (название), например sdc в нашем случае.

    1. Подтвердите Ваш выбор, введите "y" для продолжения.

    1. После установки системы, Вам будет предложено выбрать диск для хранения записей разговоров. По аналогии с первым диском, сделайте выбор.

    1. После этого система перезагрузится и будет готова к работе и первой авторизации в Web-интерфейс.

    Для перехода в Web-интерфейс, введите IP-адрес Вашей MikoPBX в строку браузера. Используйте стандартные данные для авторизации.

    Магазин приложений

    Установка MikoPBX в Yandex Cloud из Marketplace

    Для начала зарегистрируйтесь в сервисе Yandex Cloud.

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

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

    1. Откройте Все сервисы / Инфраструктура и сеть / Compute Cloud

    2. Перейдите в раздел Виртуальные машины

    3. На вкладке выберите Создать ВМ

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

    5. Укажите зону доступности

    1. Укажите параметры вычислительных ресурсов виртуальной машины, исходя из ожидаемой нагрузки на АТС и вашего бюджета. Для тестовой машины можно указать Гарантированная доля vCPU - 20%, RAM - 1 Гб

    1. В разделе Выбор образа/загрузочного диска выберите Marketplace / Показать все продукты Marketplace / VoIP / MikoPBX IP АТС

    2. В разделе Диски и файловые хранилища скорректируйте размер загрузочного диска до 1 Гб

    1. В разделе Диски и файловые хранилища выберите Добавить диск

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

    3. Укажите тип диска HDD

    1. В разделе Сетевые настройки выберите существующую или создайте новую облачную сеть

    2. В поле Подсеть в выпадающем меню выберите Добавить подсеть

    3. На открытой вкладке введите имя подсети, например local-mikopbx

    1. Публичный адрес и Внутренний IPv4-адрес оставьте в положении Автоматически

    1. В разделе Доступ укажите Сервисный аккаунт

    2. Введите Логин и SSH-ключ, предварительно сгенерированный по

    3. В разделе Дополнительные настройки установите флажок Разрешить доступ к серийной консоли

    1. Завершив ввод значений, нажмите кнопку Создать ВМ

    1. Дождитесь запуска созданной виртуальной машины, обычно первый запуск занимает 6-8 минут. Статус Running, еще не означает что система полностью развернулась

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

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные во вкладке Серийная консоль логин и пароль

    AWS Маркетплейс

    Установка MikoPBX с помощью образа из AWS Маркетплейса

    Авторизуйтесь в сервисе Amazon Web Services https://aws.amazon.com

    MikoPBX в AWS Маркетплейс:

    X86:

    ARM64:

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

    Для быстрого и удобного поиска в сервисе Amazon используйте панель поиска

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

    1. Откройте Services / Compute / EC2 и перейдите в раздел Images / AMI Catalog

    2. На открытой вкладке в поисковой строке введите MikoPBX

    3. В разделе AWS Marketplace AMIs выберите образ (x86 или ARM версию), нажав кнопку Select

    4. На открытой вкладке нажмите кнопку Subscribe now

    5. Нажмите кнопку Launch an instance form AMI для создания виртуальной машины

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

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

    1. Укажите SSH ключ в поле Key pair

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

    1. Выберите Create new key pair и укажите имя пары ключей (Key pair name), например mikopbx_key

    Следуйте дальше по инструкции

    1. При необходимости измените размер диска для хранения данных в разделе Configure storage, по умолчанию его размер - 50Гб

    1. В разделе Network settings все необходимые правила Firewall настраиваются автоматически

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

    2. Нажмите кнопку Launch instance

    1. Перейдите к созданной виртуальной машине mikopbx-vm

    2. На открытой вкладке выберите Connect / EC2 serial console, дождитесь полной загрузки системы, пока не отобразятся параметры авторизации

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные в EC2 serial console логин и пароль

    Selectel

    Установка MikoPBX с помощью Selectel

    В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы Selectel.

    Перед началом вам необходимо скачать актуальный образ MikoPBX с расширением .raw. Сделать это можно по ссылке.

    Загрузка образа в Selectel

    1. Перейдите в раздел Облачная платформа -> Образы.

    Раздел "Образы"
    1. Нажмите "Создать образ".

    1. Укажите:

    • Имя образа - любое желаемое название для вашего образа.

    • ОС - Linux

    • Источник - Файл

    Все остальное - по умолчанию.

    Нажмите создать и дождитесь окончания процесса.

    1. Перейдите в раздел Облачная платформа -> Серверы

    1. Нажмите "Создать сервер":

    1. В конфигурации вашей ВМ укажите:

    • Имя - произвольное название.

    • Пул - такой же, как у раннее созданного образа.

    • Источник - выберите раннее загруженный образ.

    • Диски: Здесь вам необходимо указать размер для первого диска (он же - системный диск) - 5Гб (минимально возможный в Selectel). А так же создайте новый диск, используя кнопку "Добавить". Укажите размер. Для диска, который используется для записи разговоров - рекомендуемое значение >50Гб. Типы дисков - "Базовый HDD"

    • Сеть - "Приватная + 1 публичный IP"

    1. Нажмите "Создать сервер".

    После создания, сразу остановите запуск сервера.

    1. Перейдите в раздел Облачная платформа -> Сеть.

    1. Перейдите в конфигурацию сети "Nat":

    1. Перейдите в раздел Подсети -> Автоматические сетевые настройки.

    1. Включите переключатель "DHCP-сервер".

    1. Вернитесь к разделу Облачная платформа -> Серверы. Далее - в созданный сервер.

    2. Включите сервер:

    1. Перейдите в раздел "Syslog":

    Произведите подключение по:

    External IP Address - внешний IP-адрес вашей MikoPBX. Скопируйте и вставьте его в адресную строку.

    Web credentials - данные для входа в WEB-интерфейс. Введите логин и пароль.

    Нерабочее время

    Настройка правил нерабочего времени

    Назначение

    «Нерабочее время» в MikoPBX — это инструмент для настройки правил обработки вызовов в периоды, когда компания не работает, например, ночью, в выходные или праздничные дни. С его помощью администраторы могут определить, как система будет обрабатывать входящие звонки в нерабочие часы: перенаправлять на автоответчик, воспроизводить специальные голосовые сообщения или переадресовывать вызовы на мобильные номера дежурных сотрудников. Это позволяет обеспечить корректное взаимодействие с клиентами вне рабочего времени и поддерживать высокий уровень обслуживания.

    Раздел "Нерабочее время" в MikoPBX

    Создание правила

    Чтобы добавить новое правило нажмите на кнопку Добавить интервал времени.

    Создание нового правила нерабочего времени

    Откроется форма создания нового правила.

    Форма создания нового правила

    В ней есть возможность указать:

    • Период - календарный период отсутствия сотрудников в офисе. Например, на время новогодних или майских праздников

    • Дни недели - конкретные дни недели, для которых будет выполняться данное правило

    • Период времени - период времени отсутствия сотрудников в течении суток.

    В поле Комментарий можно заметку, с описанием созданного правила, чтобы по данному описанию можно было быстро сориентироваться о сущности данного правила.

    Кнопкой с ластиком можно очистить поля, напротив которых эта кнопка располагается.

    Активировав эту функцию, сверху у вас появится новое меню "Ограничения по маршрутам"

    Здесь вы можете выбрать к каким конкретно маршрутам будет применяться создаваемое вами правило.

    Данным правилом указываются звонки с конца рабочего дня (19:00) и до начала рабочего дня (9:00).

    Данным правилом указываются звонки по выходным дням: в субботу и воскресенье.

    Обновление Docker

    Вариант обновления для MikoPBX в Docker контейнере

    Для обновления контейнера MikoPBX до последней версии, вы можете выполнить следующие шаги в командной строке. Эти шаги включают остановку текущего контейнера, скачивание новой версии образа и запуск контейнера с использованием обновлённого образа.

    Обновление Docker контейнера

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

    # Остановка текущего контейнера
    sudo docker stop mikopbx
    
    # Удаление текущего контейнера
    sudo docker rm mikopbx

    Для запуска нового контейнера с использованием последней версии образа и теми же настройками, что и ранее (включая монтирование томов и прочие параметры сети), воспользуйтесь следующими командами:

    # Скачивание последней версии образа контейнера
    sudo docker pull ghcr.io/mikopbx/mikopbx-x86-64:latest
    
    # Запуск контейнера в не привилегированном режиме
    sudo docker run --cap-add=NET_ADMIN --net=host --name mikopbx --hostname mikopbx \
               -v data_volume:/cf \
               -v data_volume:/storage \
               -e SSH_PORT=23 \
               -it -d --restart always ghcr.io/mikopbx/mikopbx-x86-64:latest

    Обновление с помощью docker compose

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

    # Остановка текущего контейнера
    sudo docker stop mikopbx
    
    # Удаление текущего контейнера
    sudo docker rm mikopbx

    Следующий шаг — это скачивание последней версии образа MikoPBX:

    # Скачивание последней версии образа контейнера
    sudo docker pull ghcr.io/mikopbx/mikopbx-x86-64:latest

    Пример файла docker-compose.yml, который может быть использован для обновления вашего контейнера MikoPBX через Docker Compose:

    Сохраните содержимое в файл docker-compose.yml, выполните необходимые корректировки и запускайте командой:

    • Данные: Поскольку данные сохраняются в Docker Volume, они остаются нетронутыми при обновлении, что позволяет сохранить настройки и пользовательские данные.

    • Переменные окружения: Убедитесь, что все необходимые переменные окружения передаются корректно.

    • Безопасность: Перед обновлением всегда рекомендуется создать резервные копии ваших данных.

    Эти шаги помогут обеспечить гладкое и безопасное обновление вашего контейнера MikoPBX.

    Сетевой экран

    Описание и настройка Firewall правил в MikoPBX

    Сетевой экран в MikoPBX — это интерфейс для настройки брандмауэра (Firewall) системы. Здесь администраторы могут создавать и управлять правилами фильтрации сетевого трафика, контролируя доступ к MikoPBX и защищая ее от несанкционированного доступа и сетевых угроз. Настройка сетевого экрана обеспечивает безопасность телефонной системы, предотвращая потенциальные атаки и обеспечивая стабильную работу в сетевой инфраструктуре организации.

    В MikoPBX все локальные подсети возможно описать в разделе «Сеть и Firewall» → «Сетевой экран». Сетевой экран предназначен для ограничения доступа к станции по типу трафика и подсетям.

    Раздел "Сеть и Firewall" -> "Сетевой экран" в MikoPBX

    Для того, чтобы добавить новое правило, необходимо нажать на кнопку "Добавить новую подсеть":

    Элемент для создания нового правила

    Общие настройки

    Название - задайте произвольное имя для нового правила сетевого экрана. Справа от адреса подсети находится поле Маска подсети в формате CIDR.

    • SIP&RTP-регистрация телефонов и голосовой трафик - Session Initiation Protocol используется для установки соединений между VoIP телефонами

    • WEB-доступ к административному интерфейсу настройки АТС

    • SSH-root доступ к системе. SSH(Secure Shell) позволяет получить доступ к консоли MikoPBX.

    • У каждой подсети есть флаг «Это VPN или локальная сеть». При установке этого флага MikoPBX будет представляться всем локальным подсетям локальным IP, а не внешним.

    • Флаг «Никогда не блокировать адреса из этой сети» следует включать только для доверенных подсетей. Если включен данный флаг, то правила защиты от взлома на данную подсеть не распространяются.

    В Docker (bridge-режим) внутренние правила файрвола MikoPBX и fail2ban не защищают веб-интерфейс: контейнер не управляет iptables хоста, а HTTP-клиенты приходят со шлюза docker0. SIP-защита продолжает работать (UDP-DNAT сохраняет source IP).

    Для защиты веб-интерфейса в Docker используйте один из двух подходов:

    • network_mode: host для контейнера (если хост выделен под АТС);

    • Внешний bouncer (CrowdSec-совместимый) поверх API MikoPBX — подробнее в разделе .

    Настройка Mail.ru (Логин, Пароль)

    Настройка почты для сервиса mail.ru

    Создания пароля для входа

    Необходимо создать специальный пароль для входа в почтовую программу. С обычным паролем от почты войти не получится. Чтобы создать такой пароль, к почте должен быть привязан телефон. Перейдите в Контакты и адреса и проверьте, привязан ли он. Если нет — привяжите.

    1. Откройте почту. В левом нижнем углу перейдите в "Настройки" → "Все настройки" → "Безопасность" → "Пароли для внешних приложений."

    Раздел "Пароли для внешних приложений" в настройках почты Mail.ru
    1. Нажмите Создать.

    1. На следующей странице добавьте название для создаваемого пароля - это поможет для его идентификации в будущем. В нашем примере - "SMTP для MikoPBX".

    Нажмите Продолжить.

    1. Выберите тип протокола - "Только отправка писем в Почте".

    Нажмите Продолжить.

    1. Скопируйте пароль и введите его, когда будете входить с почтой Mail в почтовую программу.

    1. Перейдите в раздел "Система" -> "Почта и уведомления".

    1. Перейдите в "Настройки SMTP". Заполните все необходимые параметры:

    • Адрес отправителя - Ваш адрес электронной почты.

    • Имя отправителя - имя от которого отправляется почта.

    • Тип аутунтификации - "Логин и пароль".

    • SMTP логин - Ваш адрес электронной почты.

    Нажмите "Сохранить".

    Нажмите "Проверить подключение". Вы увидите следующее окно, подтверждающее правильность введенных данных:

    Настройка Yandex Mail (Логин, Пароль)

    Настройка почты для сервиса Yandex

    Для получения уведомлений о пропущенных вызовах по электронной почте необходимо настроить SMTP-клиент. Подробная информация об уведомлениях в MikoPBX рассмотрена . В рамках данной инструкции будет рассмотрен пример настройки уведомлений о пропущенных вызовах для почтового сервиса Yandex.

    по настройки smtp. Для большей безопасности следует использовать «». Не используйте основной пароль от почтового ящика.

    1. Введем IP адрес АТС MikoPBX в браузере и перейдем в Система → Почта и уведомления.

    Раздел "Почта и уведомления"

    Настройки SMTP клиента для сервиса Yandex:

    • SMTP хост - smtp.yandex.ru

    • SMTP Порт - 465 (Порт для обслуживания клиентов)

    • Адрес отправителя и Логин - E-mail с которого будут отправляться сообщения о пропущенных вызовах

    • Пароль - пароль от электронной почты, необходимый для авторизации

    • Метод шифрования - Использовать TLS

    1. Осуществим отправку тестового письма на электронную почту любого сервиса. В случае успешного тестирования на указанный Вами адрес электронной почты придет тестовое письмо.

    О том, как настроить шаблон письма для создания e-mail уведомлений вы можете прочитать .

    Входящие маршруты

    Описание и настройка входящей маршрутизации

    В данном разделе необходимо создать правила и шаблоны распределения входящих звонков для созданных в MikoPBX провайдеров. Правила входящих звонков описывают маршрут звонка с момента его поступления в АТС до момента его завершения. Вы можете создавать неограниченное количество правил входящей маршрутизации. Для одного провайдера можно создать несколько правил.

    Правила располагаются в списке в порядке их приоритета. Если за указанный в правиле интервал времени никто не ответит на входящий вызов, то вызов направится на следующее по приоритету правило. Правила можно перемещать в списке вверх-вниз, то есть изменять их приоритет, перетаскивая их за стрелки.

    Если ни по одному из правил на звонок не ответили, применяется входящий маршрут по умолчанию.

    Доступны следующие действия, которые можно указать в качестве правила по умолчанию:

    IVR меню

    Создание и настройка IVR меню в MikoPBX

    IVR меню в MikoPBX — это интерактивное голосовое меню, которое позволяет звонящим взаимодействовать с телефонной системой с помощью тонового набора (DTMF). Оно автоматически направляет вызовы к нужным отделам или сотрудникам, улучшая эффективность обработки звонков и повышая качество обслуживания клиентов.

    Перед созданием IVR меню необходимо загрузить звуковые файлы, которые будут проигрываться клиенту при звонке в Вашу компанию. Звуковые файлы добавляются в разделе Телефония → Звуковые файлы

    Также есть возможность записать файл с помощью микрофона, если с АТС соединиться по https.

    Перейдите в Телефония → IVR меню.

    Подключение S3 хранилища DigitalOcean

    Инструкция по подключению DigitalOcean Spaces Object Storage в качестве S3-хранилища

    1. Перейдите в консоль DigitalOcean ().

    2. Перейдите в раздел "Manage" -> "Spaces Object Storage". Нажмите "Create a Spaces Bucket" для создания нового бакета.

    Подключение S3 хранилища Yandex Cloud

    Инструкция по подключению Яндекс Cloud Object Storage в качестве S3-хранилища

    1. Перейдите в консоль Yandex Cloud ().

    2. Перейдите в раздел "Все сервисы" -> "Object Storage".

    Google Cloud Маркетплейс

    Установка MikoPBX в Google Cloud с помощью Маркетплейса

    Авторизуйтесь на платформе

    MikoPBX в Google Cloud Маркетплейс:

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

    Если у вас есть сервисная учетная запись, проверьте наличие нужных ролей, в случае необходимости добавьте их

    Если сервисной учетной записи нет, создайте и добавьте ей нужные роли

    1. Откройте Navigation menu / Products & solutions / Management / IAM & Admin

    Хранилище

    Использование дискового пространства и настройки хранения

    Раздел «Хранилище» в MikoPBX позволяет контролировать использование дискового пространства и управлять настройками хранения данных. Здесь отображается подробная разбивка занятого места по категориям: записи разговоров, системные логи, резервные копии и другие файлы. Помимо мониторинга локального хранилища, раздел предоставляет возможность настроить автоматическую выгрузку записей в облачное хранилище S3.

    Расположение раздела: "Обслуживание" -> "Хранилище".

    На вкладке «Информация о хранилище» отображается общая картина использования дискового пространства.

    В верхней части страницы находится блок с горизонтальной диаграммой, которая наглядно показывает, какую долю от общего объёма диска занимает каждая категория данных.В примере занято 56.0 GB из 100.0 GB. Каждый сегмент диаграммы окрашен в свой цвет в соответствии с легендой:

    Настройка Yandex Mail (oAuth2)

    Настройка почты для сервиса Yandex Mail через oAuth2 авторизацию

    1. Авторизуйтесь в Ваш аккаунт Яндекс и далее перейдите на . Нажмите "Создать".

    1. В диалоговом окне выберите опцию "Для атворизации пользователей". Нажмите "Перейти к созданию".

    модуля резервного копирования
    Внешний файрвол для Docker

    Применять только к определенным входящим маршрутам - можно активировать эту функцию и с помощью нее выбирать на какие входящие маршруты будет распространяться данное правило. (Подробнее ниже)

  • Действие с входящим вызовом - можно выбрать проиграть звуковой файл или перевести вызов. Перевести вызов можно на конференцию, IVR меню, очередь, внутренний номер сотрудника или служебные номера завершения вызова.

  • Применять только к определенным входящим маршрутам

    Примеры правил

    Параметр "Применять только к определённым маршрутам"
    Раздел "Ограничения по маршрутам"
    Пример правила №1
    Пример правила №2
    AMI-доступ к asterisk manager api через telnet. Asterisk Manager Interface (AMI) предоставляет доступ к Asterisk по TCP/IP протоколу.
  • AJAM - доступ к asterisk manager api, через http, https

  • ICMP-проверка связи командой ping

  • CTICLIENT-подключение панели телефонии для 1С

  • Доступные сервисы

    Дополнительные параметры

    Поведение в Docker-контейнере

    Внешний файрвол для Docker
    Параметры правила
    Раздел "Доступные сервисы"
    Раздел "Дополнительные параметры"

    SMTP пароль - созданный пароль для внешнего приложения.

  • SMTP хост - smtp.mail.ru

  • SMTP порт - 465.

  • Тип шифрования - SSL/TLS (порт 465).

  • Пароль будет отображен только один раз! В случае утери необходимо создать новый, повторив все шаги с самого начала.

    Подключение в MikoPBX

    Кнопка "Создать" для создания нового пароля
    Создание пароля. Добавление названия
    Создание пароля. Выбор типа протокола
    Созданный пароль для внешнего приложения
    Раздел "Система" -> "Почта и уведомления".
    Параметры почты для подключения mail.ru SMTP
    Успешное подключение mail.ru
    здесь
    Документация Yandex
    Пароли приложений
    Параметры настроек отправки сообщений
    здесь

    Примечания

    docker-compose.yml
    services:
      mikopbx:
        container_name: "mikopbx"
        image: "ghcr.io/mikopbx/mikopbx-x86-64:latest"
        network_mode: "host"
        cap_add:
          - NET_ADMIN
        entrypoint: "/sbin/docker-entrypoint"
        hostname:  "mikopbx-in-a-docker"
        volumes:
          - data_volume:/cf
          - data_volume:/storage
        tty: true
        environment:
          # Изменение имени станции через переменные окружения
          - PBX_NAME=MikoPBX-in-Docker
          # Изменение стандартного порта SSH на 23
          - SSH_PORT=23
          # Изменение стандартного порта WEB на 8080
          - WEB_PORT=8080
          # Изменение стандартного порта WEB HTTPS на 8443
          - WEB_HTTPS_PORT=8443
          
    volumes:
      data_volume:
    sudo docker compose -f docker-compose.yml up
    Create extended label and icon files -
    убрать галочку
    diskutil list
    sudo diskutil eraseDisk FAT32 NONAME  MBRFormat /dev/disk4;
    sudo diskutil unmountDisk /dev/disk4;
    sudo dd if=mikopbx-2024.1.114-x86_64.iso of=/dev/disk4 bs=1m;
    lsblk
    sudo mkfs.vfat -F 32 -n NONAME /dev/sdb
    sudo umount /dev/sdb*
    sudo dd if=mikopbx-2024.1.114-x86_64.iso of=/dev/sdb bs=1M

    MacOS

    Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!

    Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!

    Linux

    Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!

    Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!

    Установка системы

    Все данные с выбранного диска будут удалены!

    Данные для первого входа в Web-интерфейс:

    Логин: admin

    Пароль: admin

    .iso образ
    "Установка системы"
    "Установка системы"
    "Установка системы"
    Утилита Rufus
    Выбранный образ и носитель
    Начало записи образа
    Параметр "Write in DD image mode"
    Подтверждение форматирования диска
    Успешная запись образа на USB-носитель
    Список дисков
    Форматирование USB-носителя
    Выполнение команды unmount
    Запись образа на USB-носитель
    Команда lsblk
    Форматирование диска
    Команда umount
    Успешная запись образа на диск
    Загруженная система с USB-носителя
    Раздел "[8] Install"
    Выбор системного диска
    Подтверждение выбора диска
    Выбор диска для хранения записей разговоров
    Успешно установленная система
    Укажите размер диска не менее 50 Гб
  • Наполнение - Пустой

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

  • Нажмите кнопку Добавить

  • В поле CIDR укажите диапазон адресов, например 172.16.32.0/24
  • Для других полей на вкладке используйте значения по умолчанию

  • Нажмите кнопку Создать

  • Загрузка АТС MikoPBX из образа в маркетплейсе

    Настройка дисков

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб для хранения записей разговоров

    Настройка сети

    Настройка параметров SSH

    Запуск АТС MikoPBX

    инструкции
    MikoPBX создание загрузочного диска в Yandex Cloud
    Файл - выберите раннее загруженный файл с расширением .raw
    Конфигурация - желаемое "железо" исходя из ваших потребностей.

    Создание сервера в Selectel

    Включение DHCP

    Первый запуск MikoPBX

    Кнопка "Создать образ"
    Параметры загружаемого образа диска
    Раздел "Серверы"
    "Создать сервер"
    Первая секция конфигурации
    Вторая секция конфигурации
    "Создать сервер"
    Раздел "Сеть"
    Сеть "Nat"
    Автоматические сетевые настройк
    "DHCP-сервер"
    Элемент переключения состояния сервера
    Раздел "Syslog"
    • Воспроизвести сигнал занято - клиент будет воспроизведен сигнал занято и входящий вызов будет завершен;

    • Положить трубку;

    • Перевести вызов - вызов можно перевести на номер, который вы можете выбрать в поле, расположенном справа от действия. В качестве номера для перевода можно выбрать IVR-меню, очередь вызовов, конференцию, внутренний номер сотрудника.

    Для одного провайдера можно описать несколько входящих маршрутов.

    Сперва вызов идет по верхнему маршруту. Если клиент не дозвонился, то вызов идет по нижнему правилу (более низкий приоритет). Если клиент не дозвонился и по второму маршруту, то вызов идет по маршруту по умолчанию.

    Несколько маршрутов для одного провайдера

    Чтобы добавить новое правило входящей маршрутизации нажмите на кнопку Добавить новое правило.

    Элемент "Добавить новое правило"

    В поле Заметка опишите маршрут, который хотите реализовать. В дальнейшем это поможет вам в отладке схемы звонка.

    Выберите Провайдера, для которого создаете новый шаблон распределения входящих звонков.

    Дополнительный номер DID - это номер, на который вам позвонил клиент, в ряде случаев может совпадать с логином провайдера. Это не обязательное поле и его следует заполнять, если необходимо более точно маршрутизировать вызовы.

    Параметры обработки входящих

    Голосовое приветствие - необязательное поле, допускается выбрать медиа файл для воспроизведения звонящему.

    На следующем шаге необходимо указать на какой телефонный номер будет направлен входящий вызов от клиента. В качестве телефонного номера могут выступать номера IVR-меню, очереди вызовов, конференции, внутренние номера сотрудников.

    Укажите время, в течение которого вызов будет идти на указанный вами телефонный номер.

    Если спустя указанный интервал времени никто не ответит на входящий вызов, то вызов направится на следующее по приоритету правило.

    Дополнительные примеры настройки входящей маршрутизации доступны в разделе FAQ.

    Приоритет правил маршрутизации и маршрут по умолчанию

    Раздел "Входящие маршруты" в MikoPBX
    Настройка приоритета правил маршрутизации
    Маршрут по умолчанию

    Несколько маршрутов для одного провайдера

    Создание правила маршрутизации

    Раздел "Интерактивные голосовые меню - IVR"

    Нажмите Создать новое IVR меню. Задайте наименование IVR меню, номер и при необходимости комментарий. Выберите звуковой файл, который вы загрузили на предыдущем этапе.

    Создание нового IVR (интерактивного голосового меню)

    Настройте Действия при донаборе. В первой колонке укажите цифру или комбинацию цифр, которую набирает абонент, а во второй выберите номер, куда будет направлен вызов.

    Настройка действия при донаборе

    Задайте Количество повторов перед переводом на номер по умолчанию.

    Установите Таймаут ожидания ввода добавочного номера (значение в секундах), после которого будет повтор голосового приветствия.

    Номер по умолчанию необходим для случая, если клиент не ввел добавочный номер (к примеру не было технической возможности).

    Включите переключатель Разрешить набор любого внутреннего номера при необходимости.

    Введите номер IVR меню, позвонив на который, можно на это IVR попасть.

    Нажмите Сохранить.

    Настройки IVR
    • При звонке на голосовое меню (Номер IVR меню) начинает проигрываться звуковой файл Голосовое приветствие.

    • Во время проигрывания голосового меню можно выбирать пункты меню или набирать внутренний номер сотрудника. За донабор внутренних номеров отвечает флаг Разрешить донабор любого внутреннего номера. Он разрешает набор внутренних номеров сотрудников с SIP-аккаунтом; переходы на очереди, IVR, конференции и другие направления настраиваются отдельными действиями при донаборе.

    • После проигрывания голосового меню происходит ожидание в течение значения Таймаут ожидания ввода добавочного номера для набора добавочного. Общее время для набора номера = длительность звукового файла + таймаут ожидания ввода добавочного номера.

    • Если общее время для набора номера истекло, происходит повторное голосовое оповещение и ожидание в течение таймаута, то есть следующая попытка IVR.

    • Если пользователь некорректно набирает номер или вообще ничего не набирает, то также происходит повторное голосовое оповещение и ожидание в течение таймаута - следующая попытка IVR.

    • Максимальное количество попыток задается в параметре Количество повторов, перед переводом на номер по умолчанию.

    • Как только попытки превысят указанное значение, происходит переадресация на Номер по умолчанию.

    Предварительная настройка

    Создание IVR-меню

    Загрузка звуковых файлов в MikoPBX
    Запись файла с помощью микрофона

    Описание принципа работы IVR

    На странице создания бакета, в разделе "Choose a datacenter region", выберите ближайший к серверу MikoPBX регион. Выберите "Standart Storage".
    Параметры создаваемого бакета #1
    1. В поле "Choose a unique Spaces Bucket name" укажите произвольное название для бакета.

    Нажмите "Subscribe & Create Bucket".

    Параметры создаваемого бакета #2
    1. Перейдите на страницу созданного бакета (нажмите на его название в разделе "Buckets").

    Созданный бакет в разделе "Buckets".
    1. Перейдите на вкладку "Settings".

    Вкладка "Settings" на странице созданного бакета
    1. Пролистайте до раздела "Access Keys". Нажмите "Create Access Key" для создания новой связки ключей.

    Раздел "Access Keys"
    1. Заполните необходимые параметры для создаваемого ключа:

    • Select access scope - Limited Access.

    • Buckets - выберите ранее созданный бакет.

    • Permissions - Read/Write/Delete.

    • Give this access key a name - укажите произвольное название для идентификации связки ключей.

    Нажмите "Create Access Key".

    Параметры создаваемой связки ключей

    Будет отображены значения связки ключей (Access Key ID и Secret Key). Сохраните эти значения, они понадобятся в будущем при настройке на стороне MikoPBX.

    Связка access ключей
    1. Перейдите во вкладку "Обслуживание" -> "Хранилище".

    Раздел "Хранилище"
    1. Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:

    • Автоматическая загрузка записей в облачное хранилище — включите переключатель.

    • URL точки доступа S3 — введите https://sgp1.digitaloceanspaces.com - замените sgp1 на Ваш регион.

    • Регион S3 — укажите регион Вашего бакета в DigitalOcean, в этой инструкции - sgp1.

    • Имя бакета S3 — укажите имя бакета, созданного в DigitalOcean (например, mikopbx-s3-storage в этой инструкции)

    • Ключ доступа и Секретный ключ — вставьте значения, полученные в первой части этой инструкции (связка Access ключей).

    Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.

    Нажмите «Сохранить».

    Параметры для подключения S3 DigitalOcean

    После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Соединение с S3 успешно» и начнется синхронизация записей телефонных разговоров.

    Успешное подключение

    Создание бакета и ключей

    ссылка
    Раздел "Spaces Object Storage"

    Запомните название Вашего региона (sgp1 на скриншоте ниже), оно понадобится в будущем для настройки внутри MikoPBX.

    Подключение к MikoPBX

    Более короткое локальное хранение быстрее освобождает дисковое пространство.

    Нажмите "Создать бакет".
    Кнопка "Создать бакет"
    1. Заполните следующие параметры для создаваемого бакета:

    • Имя — укажите название бакета (в нашем примере - mikopbx-s3-storage). Имя должно быть уникальным в рамках всего Yandex Cloud.

    • Макс. размер — задайте максимальный объём бакета. Рекомендуется установить значение, соответствующее вашим потребностям (не менее 50 ГБ для рабочей станции), чтобы контролировать расход облачного пространства. Если ограничение не нужно — отметьте «Без ограничения».

    • Доступ — для всех трёх параметров (Чтение объектов, Чтение списка объектов, Чтение настроек) выберите значение «С авторизацией».

    После заполнения всех параметров нажмите кнопку «Создать бакет».

    Параметры создаваемого бакета
    1. Перейдите в раздел "Все сервисы" -> "Identity and Access Management".

    Раздел "Identity and Access Management"
    1. Нажмите "Создать сервисный аккаунт".

    Кнопка "Создать сервисный аккаунт"
    1. Укажите следующие параметры:

    • Имя — введите название сервисного аккаунта (например, mikopbx-s3-access).

    • Роли в каталоге — нажмите «Добавить роль», в строке поиска введите storage и выберите роль storage.editor. Эта роль даёт необходимые права.

    После заполнения параметров нажмите «Создать».

    Параметры создаваемого сервисного аккаунта
    1. Перейдите в дашбоард созданного сервисного аккаунта, нажав на его название.

    Созданный сервисный аккаунт
    1. Нажмите "Создать новый ключ" -> "Создать статический ключ доступа".

    Создание нового ключа для сервисного аккаунта

    6. Введите описание для создаваемого ключа и нажмите "Создать".

    Описание создаваемого ключа

    Будут отображены идентифкатор ключа и секретный ключ. Сохраните эти значения, они понадябтся позже для подключения хранилища к MikoPBX.

    Созданный идентификатор и ключ
    1. Перейдите во вкладку "Обслуживание" -> "Хранилище".

    Раздел "Хранилище"
    1. Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:

    • Автоматическая загрузка записей в облачное хранилище — включите переключатель.

    • URL точки доступа S3 — введите https://storage.yandexcloud.net

    • Регион S3 — укажите регион Вашего аккаунта в Yandex Cloud, в этой инструкции - ru-central1

    • Имя бакета S3 — укажите имя бакета, созданного в Яндекс Cloud (например, mikopbx-s3-storage в этой инструкции)

    • Ключ доступа и Секретный ключ — вставьте значения, полученные при создании статического ключа сервисного аккаунта.

    Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.

    Нажмите «Сохранить».

    Параметры для подключения S3 Yandex Cloud

    После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.

    Успешное подключение

    Создание бакета

    ссылка
    Раздел "Object Storage"

    Создание сервисного аккаунта

    После закрытия диалога значение ключа будет недоступно.

    Подключение к MikoPBX

    Более короткое локальное хранение быстрее освобождает дисковое пространство.

    Перейдите к вкладке Service accounts и нажмите на CREATE SERVICE ACCOUNT

  • Введите имя сервисной учетной записи, например mikopbx-service-account

  • Нажмите кнопку CREATE AND CONTINUE

    1. Добавьте роли Cloud Infrastructure Manager Agent, Compute Admin, Compute Network Admin, Service Account User

    1. Нажмите кнопку DONE

    1. Откройте Marketplace и введите в поисковой строке MikoPBX

    2. Выберите образ MikoPBX

    3. На открытой вкладке выберите LAUNCH

    1. В поле Deployment name введите имя, например mikopbx-vm

    2. В разделе Deployment Service Account установите флажок Existing account и выберите созданный ранее сервисный аккаунт

    1. При необходимости измените размер диска для хранения данных в разделе Data Storage, по умолчанию его размер - 50Гб

    1. В разделе Networking все необходимые правила Firewall настраиваются автоматически

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

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

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

    2. Перейдите к созданной виртуальной машине mikopbx-vm-mikopbx-vm

    3. На открытой вкладке перейдите к Logs / Serial port 1 (console)

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные в Serial port 1 (console) логин и пароль

    Для быстрого и удобного поиска на платформе Google Cloud используйте панель поиска

    Добавление ролей сервисной учетной записи

    https://console.cloud.google.com/
    https://console.cloud.google.com/marketplace/product/mikopbx-public/mikopbx

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

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб

    Запуск АТС MikoPBX

    🟠 Записи разговоров

  • 🟣 История разговоров

  • 🔵 Системные логи

  • 🟢 Дополнительные модули

  • 🩵 Резервные копии

  • 🔴 Системные кеши

  • ⚫ Прочие файлы

  • Раздел "Информация о хранилище"

    В нижней части страницы находится список категорий данных и количество памяти, которая каждая из них занимает.

    На вкладке "Локальное хранилище" доступно определение срока хранения записей разговоров на станции: передвигая ползунок, выберите необходимый период хранения:

    • 30 дней (1 месяц) - минимальный период хранения.

    • 90 дней (3 месяца) - рекомендуется для малого бизнеса.

    • 1 год - для соблюдения требований законодательства.

    • Бесконечно - хранить все записи без ограничений.

    Вкладка "Локальное хранилище". Выбор срока хранения записей разговора.

    На этой вкладке настраивается автоматическая выгрузка записей разговоров во внешнее S3-совместимое хранилище (например: Amazon S3, Яндекс Cloud, VK Cloud).

    В верхней части вкладки находится переключатель «Автоматическая загрузка записей в облачное хранилище» — он включает или отключает функцию выгрузки.

    Для подключения к бакету необходимо заполнить следующие поля:

    • URL точки доступа S3 — адрес сервиса хранилища (например, https://storage.yandexcloud.net для Yandex Cloud S3).

    • Регион S3 — регион размещения бакета (например, ru-central1).

    • Имя бакета S3 — название бакета, в который будут загружаться записи.

    • Ключ доступа и Секретный ключ — учётные данные сервисного аккаунта для авторизации.

    Нажмите "Сохранить" для сохранения настроек.

    Вкладка "Облачное хранилище S3"

    Далее нажмите кнопку «Проверить соединение» — система выполнит тестовое подключение и отобразит результат в верхней части страницы. При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.

    Успешное соединение с S3 хранилищем

    В нижней части вкладки расположен ползунок «Локальное хранение (режим S3)» — он определяет, как долго записи будут сохраняться локально на станции перед тем, как они будут выгружены в облачное хранилище и удалены со станции (локально). Срок локального хранения не может превышать общий срок хранения.

    Ползунок "Локальное хранение (режим S3)"

    Информация о хранилище

    Диаграмма работы S3 хранилища в MikoPBX
    Раздел "Обслуживание" -> "Хранилище"

    Локальное хранилище

    Более длительные периоды хранения требуют больше дискового пространства.

    Облачное хранилище S3

    Более короткое локальное хранение быстрее освобождает дисковое пространство.

    Инструкции по подключению облачных хранилищ

    Подключение S3 хранилища Yandex Cloud
    Подключение S3 хранилища AWS

    Далее заполните необходимую информацию:

    • Название - произвольное.

    • Иконка сервиса - произвольное изображение.

    • Почта для связи - почта на которую будут приходить уведомления об авторизации.

    Нажмите "Продолжить".

    Параметры приложения #1
    1. Далее выберите в качестве платформы "Веб-сервисы". В поле "Redirect URl" вставьте следующую ссылку:

    Замените 192.168.100.60 на ip-адрес Вашей станции.

    Нажмите "Продолжить".

    Параметры приложения. Refirect URl
    1. Далее на странице "Права доступа к данным пользователей" в разделе "Дополнительные" впишите "smtp" и выберите доступ "Отправка писем через Яндекс.Почту по протоколу SMTP".

    Выдача необходимого разрешения
    1. На следующей странице нажмите "Всё верно, создать приложение".

    Подтверждение создания приложения

    После создания приложения будет выведены ClientID и Client Secret. Далее они понадобятся нам для настройки внутри web-интерфейса MikoPBX.

    ClientID и Client Secret
    1. Перейдите в Web-интерфейс MikoPBX. Далее "Система" -> "Почта и уведомления" -> "Настройки SMTP".

    Заполните все необходимые данные:

    • Адрес отправителя, Имя отправителя - Ваша почта и от какого имени будут отправляться письма.

    • Тип аутентификации - OAuth2.

    • SMTP логин - Ваша почта.

    • Провайдер OAuth2 - Yandex Mail.

    • Идентификатор приложения (Client ID), Секретный ключ (Client Secret) - данные из Yandex (6 пункт из прошлого раздела в этой инструкции).

    Все остальные настройки оставьте по умолчанию. Более подробное описание Вы можете найти в главное статье о параметрах почты (ссылка).

    После этого нажмите "Сохранить"!

    Настройки SMTP в Web-интерфейсе MikoPBX
    1. Нажмите "Подключить через OAuth2". Войдите в Ваш аккаунт Яндекс. После авторизации, нажмите "Log in as...".

    Раздел "Service login". Авторизация в приложении.
    1. При успешной авторизации Вы увидите соответствующее окно.

    Успешная авторизация

    Создание приложения в Yandex

    страницу создания приложения
    Главная страница приложений Яндекс ID | OAuth
    Выбор типа приложения в YandexID | OAuth
    https://192.168.100.60/pbxcore/api/v3/mail-settings/oauth2-callback

    Настройки внутри MikoPBX

    diskutil list
    sudo diskutil eraseDisk FAT32 NONAME  MBRFormat /dev/disk4;
    sudo diskutil unmountDisk /dev/disk4;
    sudo dd if=mikopbx-2024.1.114-x86_64.raw of=/dev/disk4 bs=1m;
    lsblk
    sudo mkfs.vfat -F 32 -n NONAME /dev/sdb
    sudo umount /dev/sdb*
    sudo dd if=mikopbx-2024.1.114-x86_64.raw of=/dev/sdb bs=1M

    MacOS

    Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!

    Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!

    Linux

    Размер USB-носителя должен быть не менее 1 ГБ. Все данные на USB-носителе будут удалены!

    Все данные на диске будут удалены! Еще раз проверьте название диска который Вы форматируете!

    Загрузка с USB-накопителя

    Данные для первого входа в Web-интерфейс:

    Логин: admin

    Пароль: admin

    Загрузка с USB-накопителя
    Загрузка с USB-накопителя
    Загрузка с USB-накопителя
    Форматирование USB-накопителя
    Опция "Flash from drive"
    "Select target"
    Выбор диска для записи
    Начало записи образа
    Успешная запись образа
    Вывод команды diskutil list
    Форматирование диска
    Отключение диска (команда unmountDisk)
    Успешная запись образа
    Список всех подключенных дисков
    Форматирование диска
    Команда "umount"
    Успешно записанный образ
    Загрузка с USB-носителя
    Раздел "Data Storage"
    Выбор действия
    Выбор диска
    Успешно установленная система

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб для хранения записей разговоров

    Запуск АТС MikoPBX

    Обязательно выполните настройку Firewall на самой АТС MikoPBX

    MikoPBX
    https://aws.amazon.com/marketplace/pp/prodview-ota6fb2tftuhw
    https://aws.amazon.com/marketplace/pp/prodview-nrp2sx3c4kuow
    Образы MikoPBX в маркетплейсе AWS

    VMware ESXi

    Установка MikoPBX с помощью VMware ESXi.

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

    1. Создаём новую виртуальную машину

    2. Указываем Имя, Тип и Версию виртуальной машины, как показано на изображении ниже.

    Имя, Тип и Версия виртуальной машины
    1. Выбираем хранилище для создания.

    2. Для данной виртуальной машины выделяем объём оперативной памяти 1024 Мб. Создаём новый виртуальный жёсткий диск для основной системы размером 1024 Мб.

    1. Выбираем тип контроллера SCSI и тип адаптера, как на изображении ниже

    1. Выбираем BIOS в качестве Firmware.

    1. Проверяем и сохраняем изменения.

    1. Перейдём к настройкам созданной виртуальной машины. Создайте новый жесткий диск для хранения записей разговоров.

    1. Переходим на вкладку носителей CD/DVD Drive. Загружаем iso-образ для установки. Ставим галочку слева от пункта "Connect as power on"

    1. Запустите созданную виртуальную машину.

    2. Откроется командный интерфейс АТС. АТС начнет загружаться.

      На данном этапе MikoPBX загружается с оптического диска, на который записан ISO-образ. На это нам указывает строчка: "The system is loaded in Recovery mode".

    1. Переключите язык интерфейса на русский. Для этого выполните Change Language -> Русский. Меню примет вид:

    1. Произведите установку MikoPBX.

    Нажмите Выполнить установку.

    1. Отобразится информация о всех доступных дисках (в данном примере: sdb, sdc).

    1. Введите с клавиатуры имя диска, который вы подразумевали под "системный", в текущем случае sdb и нажмите Enter (Если он выбран по умолчанию можно просто нажать Enter).

    2. Система запросит подтверждение. Введите - y и нажмите Enter.

    1. После выполнения установки будет предложено выбрать диск для хранения записей разговоров.

    Введите имя диска (в данном примере - единственный доступный диск sdc) и нажмите Enter.

    1. После завершения установки система перезагрузится.

    Теперь MikoPBX будет запускаться с диска sdb, на который вы ее установили. Увидим, что строчка «The system is loaded in Recovery mode» отсутствует.

    На этом установка MikoPBX завершена.

    Для того, чтобы открыть панель управления вам надо вбить в строку браузера IP-адрес вашей виртуальной машины.

    Логин и пароль по умолчанию - admin

    На этом установка MikoPBX на завершена.

    VMware Fusion

    Установка MikoPBX с помощью VMware Fusion.

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

    1. Создаем новую виртуальную машину.

    1. После скачивания последней версии образа (ссылка), указываем ISO файл с установочным дистрибутивом.

    Нажимаем "Continue"

    1. Выбираем тип операционной системы Other Linux 5.x and later kernel 64-bit

    Нажимаем "Continue"

    1. Выбираем тип биоса Legacy

    Нажимаем "Continue"

    1. Нажимаем "Finish"

    1. После создания виртуальной машины, дождитесь ее загрузки

    1. Перейдите в раздел "[3] Reboot the system"

    1. Выберите "[2] Shutdown"

    1. После выключения виртуальной машины, перейдите в настройки

    1. Выберите "Add device"

    1. Выберите "New Hard Disk"

    Нажмите "Add..."

    1. Выберите размер жесткого диска(мы рекомендуем не менее 50ГБ)

    Нажмите "Apply"

    1. Запустите виртуальную машину

    1. Выберите пункт "[8] Install"

    1. Введите имя диска, на который будет установлена MikoPBX

    В нашем случае - sdb, введите его название и нажмите Enter

    1. Подтвердите выбор диска: введите y

    1. Выберите диск для записи разговоров

    В нашем случае - sdc, введите его название и нажмите Enter

    1. Система перезагрузится и MikoPBX будет готова к использованию.

    1. В АТС отображается IP адрес станции, по которому к ней можно подключится

    1. Введите IP адрес станции в строку браузера и у вас откроется меню входа в MIkoPBX

    Логин и пароль по умолчанию - "admin"

    Proxmox LXC контейнер

    Установка MikoPBX в LXC контейнер

    Proxmox LXC — это легковесные контейнеры в составе платформы виртуализации Proxmox VE, работающие на базе технологии LXC (Linux Containers). Они позволяют запускать изолированные Linux-системы с минимальным потреблением ресурсов по сравнению с полноценными виртуальными машинами.

    Загрузка шаблона контейнера

    1. Перейдите в "local" хранилище, далее "CT Templates". Нажмите "Download from URL" для перехода к диалогу загрузки шаблона из URL.

    Загрузка шаблона из ссылки
    1. Перейдите на с релизами и скопируйте ссылку на скачивание файла-шаблона с расширением "lxc.tar.gz".

    1. Вставьте ссылку в поле "URL", нажмите "Query URL". Если Вы скопировали правильную ссылку, то в поле "File name" будет подставлено название файла с расширением "lxc.tar.gz".

    Нажмите "Download" для начала загрузки.

    После окончания загрузки, Вы увидите надпись "TASK OK".

    1. Нажмите "Create CT" в правой верхней части интерфейса для создания нового контейнера.

    1. Заполните все базовые параметры контейнера:

    • Hostname - укажите название для сервиса.

    • Password - укажите пароль для входа в Web-интерфейс MikoPBX.

    • SSH public keys - сгенерируйте и вставьте Ваш ssh-ключ. Далее Вы сможете использовать его для подключения к станции по SSH. Подробнее про генерацию ключей и SSH подключение можно прочитать .

    Нажмите "Next".

    1. Выберите ранее загруженный шаблон в разделе "Template".

    Нажмите "Next".

    1. Далее укажите размер системного диска. Рекомендуемое значение - 1 ГБ.

    Нажмите "Add" для добавления нового диска.

    1. Укажите размер второго диска: на нем будут храниться записи разговоров. Рекомендуемый размер - не менее 50 ГБ. Так же укажите путь к диску - "/storage".

    Нажмите "Add" для добавления нового диска.

    1. Укажите размер третьего диска для хранения конфигурации. Рекомендуемый размер - 0.5 ГБ. Так же укажите путь к диску - "/cf".

    Нажмите "Next".

    1. На следующей вкладке укажите количество ядер, которые будут использованы. Для небольшой компании можно указать 1-2 ядра (подробнее в ).

    Нажмите "Next".

    1. Далее укажите количество оперативной и Swap памяти для контейнера.

    Нажмите "Next".

    1. В следующем разделе, выберите Ваши параметры сети. В нашем случае используется DHCP для получения IPv4. Firewall здесь можно не включать, но необходимо настроить его позже в MikoPBX (подробнее можно прочитать в ).

    Нажмите "Next".

    1. В разделе с настройкой параметров DNS нажмите "Next".

    Вы увидите итоговую конфигурацию контейнера. Нажмите "Finish".

    1. Перейдите в окно управления созданного контейнера, нажав на его название. Нажмите на кнопку "Start" для запуска.

    1. Далее перейдите во вкладку "Console". Дождитесь загрузки системы и найдите IP-адрес Web-интерфейса.

    Введите его в адресную строку Вашего браузера. Далее произведите первую авторизацию в MikoPBX.

    Hyper-V

    Установка MikoPBX с помощью HyperV.

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

    1. Выберите Действие / Создать / Виртуальная машина

    2. На вкладке Укажите имя и местонахождение введите имя виртуальной машины, например mikopbx-vm

    1. Перейдите к следующей вкладке Укажите поколение, выберите поколение - Поколение 1

    1. На вкладке Выделить память выделите необходимый размер оперативной памяти, исходя из ожидаемой нагрузки на АТС. Для тестовой машины можно указать 2 Гб

    1. Перейдите к вкладке Настройка сети, выберите заранее настроенное сетевое соединение

    1. На вкладке Подключить виртуальный жесткий диск скорректируйте размер диска под систему до 1 Гб

    1. На вкладке Параметры установки установите флажок Установить операционную систему с загрузочного компакт- или DVD-диска

    2. Выберите Файл образа (.iso) и укажите ссылку на файл из дистрибутива MikoPBX с расширением .iso

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

    1. Перейдите к Параметрам созданной виртуальной машины

    2. Выберите IDE контроллер, к которому подключен диск под систему

    3. На открывшейся вкладке выберите Жесткий диск, нажмите кнопку Добавить

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

    1. На вкладке Выберите тип диска укажите тип диска - Фиксированного размера

    1. На вкладке Укажите имя и местонахождение укажите имя, например storage.vhd, и расположение диска

    1. На вкладке Настройка диска задайте размер диска для хранения данных не менее 50Гб

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

    2. Завершите настройку, нажав кнопку Готово

    1. Для запуска виртуальной машины нажмите Пуск

    1. Перейдите к вкладке Подключить созданной виртуальной машины mikopbx-vm

    2. Если загрузка прошла успешно, появится консольное меню. Введите с клавиатуры 8 для начала установки

    1. Выберите диск под систему и введите с клавиатуры имя диска, например sdb. Подтвердите выбор, введите с клавиатуры y

    1. Подключите диск для хранения записей разговоров, ведите с клавиатуры наименование диска для подключения, например sdc

    1. На открытой вкладке Подключить скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    1. Для входа используйте логин - admin и пароль - admin

    DigitalOcean

    Установка MikoPBX с помощью сервиса DigitalOcean

    Инструкция актуальна для версии 2024.2.111 и новее!

    В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы DigitalOcean.

    Перед началом Вам необходимо скопировать ссылку на актуальный образ MikoPBX с расширением .raw. Сделать это можно на github MikoPBX.

    Загрузка образа в DigitalOcean

    1. Перейдите в "Manage" -> "Backups & Snapshots"

    Раздел "Backups & Snapshots"
    1. Перейдите в "Custom Images" -> "Import via URL":

    1. Вставьте ссылку на файл образа диска с расширением .raw, скопированную ранее.

    2. Введите имя для образа, выберите регион для его загрузки (должен совпадать с будущим регионом виртуальной машины). В качестве операционной системы образа выберите "Unknown"

    Нажмите "Upload image"

    Дождитесь загрузки образа.

    1. Перейдите на главную страницу DigitalOcean.

    1. Для перехода к создаю виртуальной машины, перейдите в "Create" -> "Droplets":

    1. Выберите регион и датацентр для Вашей виртуальной машины.

    1. Далее выберите ранее загруженный образ и конфигурацию для вашей виртуальной машины:

    1. Перейдите во вкладку "Additional Storage". Здесь необходимо добавить второй диск, который будет использоваться для хранения записей разговоров. Для этого нажмите "Add volume" и укажите параметры для нового диска.

    1. Перейдите в раздел "Choose authentication method". Здесь необходимо выбрать "SSH Key" и добавить связку ключей для SSH подключения. Подробнее прочитать про их создание Вы можете в следующих статьях:

    1. Нажмите "Create Droplet".

    1. Перейдите в меню созданной машины. Дождитесь ее запуска. Далее подключитесь с помощью встроенной консоли в DigitalOcean (элемент на скриншоте).

    1. После загрузки системы, перейдите в web-интерфейс, используя внешний IP-адрес, указаный в консоли (external).

    1. Вставьте IP-адрес машины в строку браузера. После перехода на страницу авторизации в MikoPBX, используйте следующие данные для входа:

    • Логин - admin

    • Пароль - id Виртуальной машины, найти который Вы можете в адресной строке:

    1. Для подключения по SSH следуйте . В данной статье будет пример с использованием powershell (windows).

    1. Перейдите в Powershell и пропишите следующую команду:

    После нажатия "Enter" произойдет авторизация по SSH и Вы попадете в консольное меню MikoPBX.

    Почта и уведомления

    Настройка почты и уведомлений

    Раздел «Почта и уведомления» в MikoPBX позволяет настроить отправку системных уведомлений через электронную почту. Здесь администраторы указывают параметры SMTP-сервера, определяют события для уведомлений, такие как голосовые сообщения или системные ошибки, и редактируют шаблоны писем. Этот раздел помогает своевременно информировать пользователей и администраторов о важных событиях, обеспечивая эффективный контроль за работой системы.

    С 2026 года многие облачные провайдеры закрывают порты на SMTP по умолчанию (например Selectel, DigitalOcean). В случае ошибок подключений - уточняйте информацию у Вашего облачного провайдера.

    Раздел "Почта и уведомления" в MikoPBX

    Общие настройки

    Общие настройки почты
    • Использовать оповещения - позволяет включить/отключить все оповещения на email, включая голосовую почту.

    • Отправлять уведомления о пропущенных вызовах - позволяет включить/отключить уведомления о пропущенных вызовах.

    • Единый Email для уведомлений о пропущенных вызовах - общий адрес электронной почты для отправки уведомлений о пропущенных внешних вызовах (если у сотрудника не указан email, используется этот общий адрес).

    • Отправлять уведомления о голосовых сообщениях - позволяет включить/отключить уведомления о голосовых сообщениях.

    • Единый Email для уведомлений о голосовых сообщениях - общий адрес электронной почты для отправки уведомлений о голосовых сообщениях (приоритет: 1. Личный email сотрудника; 2. Указанный email в этом поле)

    • Отправлять уведомления о входах в систему - позволяет включить/отключить уведомления о входах в систему.

    • Отправлять системные уведомления - позволяет включить/отключить отправку системных уведомлений.

    • Email системного администратора - адрес, на который будут отправляться системные уведомления.

    • Адрес отправителя, Имя отправителя - от имени этого адреса и имени будут отправляться электронные письма.

    • Тип аутентификации:

      • Логин и пароль - классический тип аутентификации при подключении к SMTP-серверу, при котором используется адрес почтового ящика (логин) и пароль от него. Все параметры (сервер, порт, шифрование, логин и пароль) вводятся и хранятся вручную

    • SMTP логин, SMTP пароль - параметры авторизации.

    • SMTP хост - адрес почтового сервера.

    • SMTP порт - порт почтового сервера.

    • SMTP логин - параметры авторизации.

    • Провайдер OAuth2 - почтовый сервис, через который выполняется OAuth-аутентификация (например, Microsoft/Outlook, Google/Gmail).

    • Идентификатор приложения (Client ID) - уникальный идентификатор приложения, созданного в панели управления выбранного OAuth-провайдера. Используется для того, чтобы провайдер понимал, какое именно приложение запрашивает доступ к почтовому ящику.

    В нашей документации приведено несколько примеров подключения для каждого из типов аутентификации. Ниже Вы можете найти ссылки на эти инструкции.

    • Аутентификация по логину и паролю:

    • Аутентификация oAuth2:

    Управление модулями

    Подключение, настройка и управление модулями

    Дополнительные модули позволяют расширить возможности функционала основной системы. В данной инструкции вы сможете найти информацию про управление модулями, а так же про установку приложений с помощью встроенного Marketplace.

    Для использования платных и бесплатных модулей, необходимо зарегистрировать копию MikoPBX и бесплатно получить лицензионный ключ. Инструкцию по тому, как это сделать - вы можете найти .

    Подробные инструкции по настройке и эксплуатации каждого модуля вы можете найти здесь.

    Найти раздел Управления модулями вы можете в "Модули" -> "Маркетплейс модулей".

    Раздел "Маркетплейс модулей"

    Установленные модули

    В данном разделе происходит основное управление модулями: их подключение, настройка, а так же загрузка своих, "кастомных" модулей. Документацию по разработке своих модулей вы можете найти здесь.

    Все установленные модули находятся в списке, в одноимённой вкладке:

    Все установленные модули

    Есть возможность загрузить свой модуль, используя кнопку "Загрузить новый модуль". Необходимо загружать файлы .zip. После загрузки модуль появится в списке на вкладке "Установленные модули"

    Так же есть возможность перейти в настройки любого модуля для дальнейшей его конфигурации:

    Помимо этого, можно включить/отключить модуль.

    Из интерфейса установленного модуля можно быстро перейти к его документации, нажав на знак вопроса справа от короткого описания модуля:

    Существует возможность вынести любой модуль в боковое меню для быстрого доступа к нему, что может быть полезно, если вам требуется постоянный доступ к настройки модуля для изменения параметров или его состояния.

    Для того, чтобы это сделать - выполните дальнейшую инструкцию:

    1. Перейдите в настройки модуля, который Вы хотите вывести в боковое меню, нажав на элемент редактирования справа от версии модуля:

    1. Нажмите на значок настроек справа от статуса состояния модуля для перехода к настройкам отображения модуля в боковом меню:

    1. В данном разделе вы можете:

    • Переключить отображение модуля в боковом меню - "Показывать модуль в боковом меню".

    • Выбрать раздел в котором он будет отображаться - в примере выбран раздел "Модули".

    • Так же можно указать произвольное название модуля.

    После завершения настройки - нажмите "Сохранить".

    В данном разделе вы можете установить модули от MIKO, а так же от производителей-партнеров.

    Напротив каждого модуля есть кнопка для его скачивания и установки. Так же здесь отображена базовая информация по модулю с коротким описанием каждого модуля.

    Слева от названия модуля вы можете найти значок, по которому можно понять платный ли он или бесплатный. Например, на изображении выше модуль "REST API Автоинформатор" - платный, а модуль "Генератор SSL сертификатов через Let's Encrypt" - бесплатный.

    Существует возможность перейти в карточку модуля, нажав на его название в интерфейсе маркетплейса.

    Здесь вы можете найти версию актуального релиза, информацию про разработчика, платный ли модуль или бесплатный. Тут же находятся 3 раздела:

    Здесь вы можете найти изображения про функционал и настройки модуля. Помимо этого - базовое описание модуля, а так же раздел "Полезные ссылки", где располагается ссылка на подробную документацию по настройке и эксплуатации модуля.

    В данном разделе вы можете найти историю версий модуля, с подробным описанием изменений, а также минимально совместимой версии MikoPBX для корректной его работы. Так же вы можете установить конкретную версию модуля, нажав на синий элемент под общим ее описанием.

    Здесь вы можете ознакомиться с пользовательским лицензионным соглашением для каждого модуля расширения.

    В случае покупки модуля, вам будет выдан купон. Для его активации перейдите в Модули -> Маркетплейс модулей:

    Далее перейдите в раздел "Управление лицензией"

    В поле "Активация купона" введите ваш купон, далее нажмите "Активировать купон"

    История вызовов

    Просмотр и фильтр истории вызовов в MikoPBX

    История вызовов в MikoPBX — это журнал, который сохраняет информацию о всех входящих и исходящих звонках через систему. Она предоставляет детальные данные о каждом вызове, включая время, длительность, номера участников и статус, что позволяет анализировать коммуникации и оптимизировать работу телефонной сети компании. Располагается в разделе "Телефония" -> "История вызовов".

    Раздел "История вызовов"

    Чем она полезна

    История вызовов в MikoPBX позволяет:

    • Отобразить все вызовы;

    • Отобразить вызовы по отбору;

    • Визуально отобразить пропущенные вызовы из общего списка звонков;

    • Скачать/прослушать запись разговора.

    Каждый элемент списка содержит информацию о:

    • номере телефона звонящего абонента (Кто);

    • номере телефона, на который звонили (Кому);

    • дате и времени свершения звонка (Дата звонка);

    Вызовы, отмеченные красным цветом, являются пропущенными. Длительность разговора для пропущенных вызовов равна нулю, такие вызовы невозможно прослушать.

    Для каждой записи истории звонков доступна возможность прослушивания и скачивания записи разговоров. При скачивании можно выбрать формат WebM (Opus), MP3, WAV или OGG (Opus).

    Каждая строка вызова содержит полную информацию об участниках разговора.

    На скриншоте выше отображено следующее:

    1. Вызов поступил на номер 79255283744;

    2. На вызов ответила Белкина;

    3. Белкина осуществила консультативный перевод на Шевченко;

    В строке поиска истории вызовов можно реализовать следующие отборы:

    1) Отбор по номеру телефона

    В строке поиска можно ввести как внутренний номер сотрудника, так и номер клиента (внешний).

    2) Отбор по конкретному полю

    В строке поиска можно указать префикс, чтобы искать только по нужному полю:

    • src:74952293042 - искать по номеру звонящего;

    • dst:302 - искать по номеру назначения;

    • did:74952293042 - искать по DID-номеру;

    Если префикс не указан, MikoPBX выполняет общий поиск по номеру звонящего, номеру назначения, DID и имени сотрудника.

    3) Отбор по дате

    При открытии истории звонков MikoPBX выбирает период по последним записям журнала. Установите нужный вам период и нажмите Применить.

    4) Отбор по linkedid

    linkedid - уникальный идентификатор звонка. Данным отбором удобно пользоваться, если необходимо найти вызов, исходя из данных . Для применения этого отбора: 1. Откройте журнал звонков 1С; 2. Выделите нужную строку; 3. Нажмите Подробнее во встроенном плеере (или вызвав контекстное меню на данной строке); 4. Скопируйте поле Идентификатор; 5. Вставьте это значение в строку поиска истории вызовов MikoPBX в формате linkedid:значение и нажмите Enter.

    API ключи

    Описание работы в MikoPBX

    REST API MikoPBX позволяет автоматизировать управление станцией и интегрировать её с внешними системами — CRM, helpdesk, корпоративными порталами и собственными сервисами. Для доступа к API используются API ключи.

    Авторизация

    Все запросы к REST API авторизуются через заголовок Authorization: Bearer <token>. MikoPBX поддерживает два типа токенов:

    Тип
    Когда использовать?

    JWT токен

    Для внешних интеграций всегда используйте API ключ — он создаётся вручную, имеет настраиваемые права доступа и может быть отозван в любой момент.

    1. Перейдите в раздел «Система» → «API ключи».

    1. Нажмите «Добавить API ключ».

    • Заполните поле Описание (например: CRM Integration)

    • Скопируйте сгенерированный API-ключ — он отображается только один раз

    Важно: сохраните ключ сразу после создания. После закрытия страницы восстановить его невозможно — придётся создавать новый.

    Придерживайтесь принципа минимальных привилегий — каждый ключ должен иметь доступ только к тем ресурсам, которые реально нужны.

    При создании ключа доступны два варианта:

    • Полные права доступа — ключ получает доступ ко всем ресурсам API на чтение и запись. Используйте только если это действительно необходимо.

    • Ручная настройка — для каждого ресурса API отдельно указывается уровень доступа: только чтение, чтение и запись, или нет доступа.

    Сетевой фильтр: выберите один из двух вариантов:

    • Только локальные подключения — ключ будет работать только из локальной сети. Рекомендуется если интеграция работает внутри инфраструктуры.

    • Разрешены подключения с любых адресов — ключ доступен без ограничений по IP. Используйте только если клиент находится за пределами локальной сети.

    Соблюдение следующих требований защищает API от перехвата токенов и несанкционированного доступа:

    1. Валидный SSL сертификат:

    Используйте доверенный SSL сертификат на стороне сервера MikoPBX. Самый простой способ — выпустить бесплатный сертификат через модуль Let's Encrypt (инструкция по работе с модулем находится ).

    Работа без валидного сертификата допустима только в изолированной тестовой среде без доступа из интернета.

    1. Доверие к сертификату на стороне клиента:

    Клиент обязан проверять сертификат сервера при каждом запросе. Отключение проверки (verify=False в Python, -k в curl) недопустимо в production: без неё возможна атака типа «человек посередине» (MITM), при которой злоумышленник перехватывает Bearer-токен в открытом виде.

    1. Ограничение прав (scope) ключа:

    Каждый ключ должен иметь доступ только к тем ресурсам, которые реально используются интеграцией. Не используйте «Полные права доступа» без необходимости — компрометация такого ключа даёт атакующему полный контроль над API.

    1. Ограничение сетевого доступа:

    Если интеграция работает внутри локальной сети — выбирайте «Только локальные подключения». Это исключает возможность использования скомпрометированного ключа из внешней сети.

    Вариант «Разрешены подключения с любых адресов» используйте только когда клиент физически находится за пределами локальной сети, и убедитесь что остальные меры безопасности соблюдены — валидный SSL сертификат и минимальные права ключа.

    Нажмите на карточку для перехода:

    UTM

    Установка MikoPBX в UTM

    В данной иснтрукции будет произведена установка на UTM. Перед ее началом скачайте файл образа диска с расширением ".iso". Сделать это можно по ссылке.

    Данная инструкция актуальна с первого релиза, опубликованного в 2026 году. Протестированно на процессорах Apple Silicon.

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

    1. Перейдите в UTM. Нажмите "Create a New Virtual Machine" для создания новой виртуальной машины.

    Главная страница UTM. Создание новой виртуальной машины.
    1. В качестве типа виртуальной машины выберите "Virtualize".

    Выбор типа виртуальной машины
    1. В качестве типа операционной системы выберите "Preconfigured" - "Linux".

    1. Выберите ранее загруженный файл образа диска в разделе "Boot ISO Image". Для этого нажмите на "Browse...".

    1. Далее укажите характеристики Вашей виртуальной машины. В нашем случае будут использованы 2 ГБ ОЗУ и 2 ядра процессора.

    1. Далее укажите размер для системного диска. В нашем случае - 1 Гб.

    1. Нажмите Continue.

    1. Будет отображена итоговая конфигурация виртуальной машины. Задайте ей желаемое имя (поле "Name"). И нажмите "Save".

    1. Перейдите в настройки ВМ. Для этого нажмите правой кнопкой мыши по её названию, далее "Edit".

    1. Перейдите в "Drives". Нажмите "New..."

    1. Создайте новый диск со следующими параметрами:

    • Interface - VirtlO

    • Size - не менее 50Гб (в этой документации для тестовой машины будет использовано 10Гб)

    Нажмите "Create".

    1. Запустите виртуальную машину.

    1. После загрузки Вы увидите надпись PBX is running in Live or Recovery mode. Это означает, что система загружена из образа диска в Live режиме. Необходимо произвести установку системы. Для этого перейдите к разделу "[8] Install on Hard Drive".

    1. Выберите диск для установки системы. В нашем случае доступны диски vda и vdb, для установки выбираем диск vda.

    1. Подтвердите выбор: введите "y" с клавиатуры и нажмите Enter.

    1. Далее выберите диск для хранения записей разговоров. В нашем случае единственный оставшийся размером 10 Гб.

    После этого система будет перезагружена и доступна в обычном режиме (надпись "PBX is running in Live or Recovery mode" пропадет).

    Введите этот IP-адрес в строку браузера для перехода в Веб-интерфейс.

    VMware Workstation Pro

    Установка MikoPBX с помощью VMware Workstation Pro

    В текущей инструкции будет описан процесс создания и настройки виртуальной машины в VMware Workstation Pro, а так же процесс установки MikoPBX.

    Скачать установщик VMware Workstation Pro можно .

    1. Перейдите в интерфейс VMware WorkStation Pro. Нажмите кнопку "Create a New Virtual Machine" для создания новой виртуальной машины.

    Proxmox

    Установка MikoPBX с помощью Proxmox.

    1. Откройте вкладку local / ISO images и выберите Download from URL

    2. В поле URL вставьте ссылку на файл из дистрибутива MikoPBX с расширением .iso

    3. Нажмите кнопку Download, дождитесь окончания загрузки файла

    Произвольный образ

    Установка в Yandex cloud произвольного образа MikoPBX

    Для начала зарегистрируйтесь в сервисе .

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

    1. Откройте Все сервисы / Инфраструктура и сеть / Compute Cloud

    2. Перейдите в раздел Виртуальные машины

    Microsoft Azure

    Установка MikoPBX с помощью Microsoft Azure.

    Для начала авторизуйтесь на портале Microsoft Azure

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

    1. Откройте Меню / Все службы / Общие / Группы ресурсов

    2. На вкладке Группы ресурсов выберите Создать

    Сетевые интерфейсы

    Описание и настройка сетевых интерфейсов

    Раздел «Сетевые интерфейсы» в MikoPBX — это интерфейс для настройки параметров сетевых подключений системы. Здесь администраторы могут управлять IP-адресами, масками подсети, шлюзами и другими сетевыми настройками для каждого сетевого интерфейса. Это позволяет корректно интегрировать MikoPBX в сеть организации и обеспечить ее стабильную работу в соответствии с требованиями сетевой инфраструктуры.

    Раздел находится в "Сеть и Firewall" -> "Сетевые интерфейсы":

    Имя хоста - это имя машины. Если значение не указано, то используется имя mikopbx.local.

    Существует два способа настроить IP-адрес в MikoPBX:

    Настройка Gmail (oAuth2)

    Настройка почты для сервиса gmail

    1. Перед началом настройки, необходимо поменять некоторые параметры аккаунта Google. Для этого перейдите на страницу управления ().

    1. Перейдите в раздел "Безопасность и вход в аккаунт". Убедитесь, что у Вас настроена двухэтапная аутентификация.

    Регистрация в маркетплейсе модулей

    Описание процесса регистрации

    Регистрация в Маркетплейсе MikoPBX не влияет на базовый функционал системы. Вы можете использовать MikoPBX для работы со звонками без регистрации и установки дополнительных модулей. Однако, Мы рекомендуем пройти процедуру регистрации в маркетплейсе для получения возможности расширения функционала системы.

    Регистрация даст вам доступ к дополнительным модулям и расширениям. Есть бесплатные модули, который мы вынесли из базового функционала для упрощения первоначальной настройки, а также платные модули от нас и других разработчиков. Если вы разработчик, то можете связаться с нами, написав на почту developers@mikopbx.com для получения инструкций о том, как разработать собственный модуль и добавить его в Marketplace.

    Для начала регистрации в маркетплейсе вам необходимо перейти во вкладку "Модули" -> "Маркетплейс модулей":

    В случае, если у Вас не выполнена регистрация в Маркетплейсе, раздел будет выглядеть вот так:

    Внутренние компоненты системы, модули, встроенные инструменты

    API ключ

    Внешние интеграции: CRM, скрипты, сторонние сервисы

    Создание API-ключа

    Настройка прав доступа

    • "Чтение" позволяет получать данные (GET)

    • "Чтение и запись" позволяет создавать, изменять и удалять данные (POST, PUT, DELETE).

    Безопасность

    Примеры и подробная документация

    здесь
    Раздел "Система" -> "API ключи"
    Базовые настройки API ключа
    Cover

    Примеры использования REST API

    Cover

    Интерактивная документация и список эндпоинтов

    Настройки виртуальной машины

    Для такого диска, мы рекомендуем указывать размер не менее, чем 50 ГБ

    Установка MikoPBX

    Перемещаться по пунктам меню можно клавишами управления курсором.

    Выбрать пункт меню - клавиша Enter.

    Также можно выбирать пункт меню нажав на буквенно-цифровом блоке клавиатуры соответствующую пункту цифру.

    Все данные на диске, куда устанавливается MikoPBX, будут потеряны.

    Ориентировочно, 1 час разговора занимает 14Мб места на диске.

    Первый вход в MikoPBX

    Размер оперативной памяти и памяти для системного жесткого диска
    Тип контроллера и тип адаптера
    Раздел "Boot options"
    Загрузка образа системы
    IP-адрес MikoPBX
    Окно входа в веб-интерфейс

    Подключение нового диска

    1 час записи разговоров занимает примерно 14мб на диске.

    Установка MikoPBX

    Первое подключение к MikoPBX

    OAuth2 - способ аутентификации, при котором Вы не храните и не передаёте пароль от почтового ящика. Вместо этого приложение получает временный токен доступа у почтового провайдера (Microsoft 365/Outlook, Google Workspace/Gmail и т.д.) и использует его при отправке писем через SMTP.

    Тип шифрования:
    • Без шифрования (порт 25) - классический способ подключения к SMTP без защиты канала.

    • STARTTLS (порт 587) - рекомендованный и наиболее распространённый способ отправки почты. Соединение начинается без шифрования, после чего клиент и сервер согласовывают переход на защищённый канал.

    • SSL/TLC (порт 465) - подключение к SMTP с шифрованием с самого начала соединения. Канал защищён сразу после установки TCP-соединения, без этапа переключения.

  • Проверять сертификат сервера - настройка безопасности, которая определяет, будет ли клиент проверять подлинность SSL/TLS-сертификата SMTP-сервера при установке защищённого соединения (STARTTLS или SSL/TLS).

  • Секретный ключ (Client Secret) - конфиденциальный ключ приложения, выданный OAuth-провайдером. Используется вместе с Client ID для подтверждения подлинности приложения при получении и обновлении токенов доступа. Должен храниться в секрете и не передаваться третьим лицам.

  • SMTP хост - адрес почтового сервера.

  • SMTP порт - порт почтового сервера.

  • Тип шифрования:

    • Без шифрования (порт 25) - классический способ подключения к SMTP без защиты канала.

    • STARTTLS (порт 587) - рекомендованный и наиболее распространённый способ отправки почты. Соединение начинается без шифрования, после чего клиент и сервер согласовывают переход на защищённый канал.

    • SSL/TLC (порт 465) - подключение к SMTP с шифрованием с самого начала соединения. Канал защищён сразу после установки TCP-соединения, без этапа переключения.

  • Проверять сертификат сервера - настройка безопасности, которая определяет, будет ли клиент проверять подлинность SSL/TLS-сертификата SMTP-сервера при установке защищённого соединения (STARTTLS или SSL/TLS).

  • Настройки SMTP

    Аунтефикация по логину и паролю

    Аунтефикация с OAuth2

    Как подключить?

    Настройка Yandex Mail (Логин, Пароль)
    Настройка Mail.ru (Логин, Пароль)
    Настройка Proton (Логин, Пароль)
    Настройка Gmail (oAuth2)
    Настройка Yandex Mail (oAuth2)
    Настройка Microsoft Outlook (oAuth2)
    Настройки SMTP. Часть 1
    Настройки SMTP. Часть 2
    Настройки SMTP. Часть 3

    Быстрый доступ к модулю

    Маркетплейс модулей

    У каждого платного модуля есть испытательный период - 2 недели. За этот период вы можете попробовать функционал модуля и принять решение о покупке. Для покупки модуля - напишите на почту sale@mikopbx.com

    Карточка модуля

    Описание модуля

    История версий

    Лицензионное соглашение

    Активация купонов

    Ключ защиты всегда начинается с MIKO-. Купон для изменения состава продуктов всегда начинается с MIKOUPD-

    здесь
    Кнопка "Загрузить новый модуль"
    Переход в настройки модуля
    Включение/отключение модуля
    Быстрый переход к документации по модулю
    Модули в быстром доступе
    Переход в настройки модуля
    Параметры модуля
    Параметры отображения модуля в боковом меню
    Раздел "Маркетплейс"
    Кнопка для установки модуля
    Карточка модуля
    Раздел "История версий"
    Раздел "Модули" -> "Маркетплейс модулей"
    Активация купона

    длительности разговора (Длительность) - время голосового приветствия не учитывается.

    Шевченко продолжила разговор с клиентом.

    linkedid:mikopbx-... - искать по уникальному идентификатору звонка.

    Отборы

    Для применения отбора нужно после ввода в поле значения нажать Enter.

    журнала звонков 1С
    Помеченные пропущенные вызовы в журнале
    Прослушивание и скачивание вызовов
    Расширенная история вызова
    Отбор по номеру телефона
    Поиск по номеру или отдельному полю истории вызовов
    Отбор по дате вызова
    Отбор по linkedid
    Создать
  • На вкладке Выбор формата диска выберите формат - VHD

  • Диск для хранения данных

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб для хранения записей разговоров

    Установка АТС MikoPBX

    После появления сообщения “Press any key within 30 seconds to boot from LiveCD…” не нажимайте никаких кнопок. В этом случае система загрузится с жесткого диска.

    Запуск АТС MikoPBX

    для хранения записей разговоров
    В интерфейсе создания виртуальной машины укажите тип виртуальной машины: "Typical (recommended)". Далее, нажмите - "Next >".
    Выбор типа создаваемой виртуальной машины
    1. Далее выберите источник установки "Installer disc image file (iso):", выберите файл образа диска с расширением .iso. Скачать дистрибутив вы можете по ссылке. После выбора нажмите "Next >" для продолжения.

    Выбор источника установки системы для создаваемой виртуальной машины
    1. Выберите "Linux" в поле "Guest operating system". В качестве "Version" - "Debian 11.x 64-bit". Нажмите "Next >"

    Выбор операционной системы и версии для создаваемой виртуальной машины
    1. Укажите желаемое имя для виртуальной машины в поле "Virtual machine name:". Так же есть возможность указать локацию для этой виртуальной машины на вашем компьютере: используйте поле "Location". Нажмите "Next >".

    Указание названия и пути для создаваемой виртуальной машины
    1. Укажите размер для первого (системного) жесткого диска: рекомендуемое значение - 1Гб. Выберите "Split virtual disk into multiple files". Нажмите "Next >".

    Указание параметров для системного жесткого диска для создаваемой виртуальной машины
    1. Отобразится итоговая конфигурация виртуальной машины. Нажмите "Finish". Произойдет создание виртуальной машины.

    Итоговая конфигурация создаваемой машины.

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

    1. Перейдите в настройки раннее созданной виртуальной машины.

    Раздел настроек виртуальной машины
    1. Нажмите "Add..." для добавления нового элемента системы.

    Кнопка для добавления нового элемента системы
    1. Выберите "Hard Disk" в разделе "Hardware types". Нажмите "Next >"

    Выбор типа нового элемента системы
    1. Выберите "Virtual disk type" - "SCSI". Нажмите "Next >".

    Выбор типа диска
    1. Выберите "Create a new virtual disk". Нажмите "Next >".

    Выбор параметра "Create a new virtual disk"
    1. Выберите размер диска: рекомендованное значение - не менее 50 Гб. Так же выберите параметр "Split virtual disk into multiple files". Нажмите "Next >"

    Указание параметров для создаваемого диска
    1. Укажите произвольное название для жесткого диска. Нажмите "Finish"

    Название для второго жесткого диска

    В настройках перейдите в раздел "Network Adapter". Выберите "Network connection" - "Bridged: Connected directly to the physical network". Нажмите "OK"

    Настройка сетевого интерфейса
    1. Произведите запуск виртуальной машины.

    Кнопка для запуска виртуальной машины
    1. Откроется командный интерфейс MikoPBX. АТС начнет загружаться. На данном этапе MikoPBX загружается с оптического диска, на который записан ISO-образ. На это нам указывает строчка: "The system is loaded in Recovery mode".

    Загруженная MikoPBX с оптического диска
    1. Переключите язык интерфейса на русский. Для этого выполните "[1] Change Language" -> "[2] Русский".

    2. Далее произведем установку MikoPBX. Перейдите в пункт "[8] Install".

    3. Отобразится информация о всех доступных дисках (в данном примере: sdb, sdc). Системой предложен диск по умолчанию, в нашем случае - sdb. Если вы согласны с предложенным диском, который будет использоваться в качестве системного - нажмите Enter. В противном случае напишите название другого диска.

    Выбор диска для системы
    1. Далее система выдаст предупреждения. Для подтверждение операции - введите "y" и нажмите Enter.

    2. После выполнения установки будет предложено выбрать диск для хранения записей разговоров. Введите имя диска (в данном примере - единственный доступный диск sdc) и нажмите Enter.

    Выбор диска для хранения записей разговоров
    1. После завершения установки система перезагрузится.

      Теперь MikoPBX будет запускаться с диска sdb, на который вы ее установили. Увидим, что строчка «The system is loaded in Recovery mode» отсутствует. Это значит, что установка MikoPBX совершена успешно.

    Успешно установленная MikoPBX

    Для того, чтобы открыть веб-интерфейс MikoPBX вам надо вписать в строку браузера IP-адрес вашей виртуальной машины, найти его вы можете в консоли.

    IP-адрес MikoPBX

    Впишите IP-адрес в адресную строку вашего браузера. Произведите первый вход в MikoPBX по стандартному логину и паролю.

    Страница авторизации в WEB-интерфейс MikoPBX

    Используйте для установки на VMware Workstation Pro версии АТС MikoPBX отличные от 2024.1.114

    Версия 2024.1.114 временно не поддерживает установку с помощью VMware Workstation Pro!

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

    на сайте
    Элемент "Create a New Virtual Machine"

    Создание и подключение второго диска

    Указание сетевого интерфейса для виртуальной машины

    Первый запуск системы

    Перемещаться по пунктам меню можно .

    Выбрать пункт меню - клавиша Enter.

    Также можно выбирать пункт меню нажав на соответствующую пункту цифру.

    Все данные на диске, куда устанавливается MikoPBX, будут потеряны.

    Первый вход в MikoPBX

    При первом входе в WEB-интерфейс MikoPBX используйте стандартные данные:

    • Логин: admin

    • Пароль: admin

    1. Выберите Create VM

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

    1. Перейдите к следующей вкладке OS, в поле ISO image выберите загруженный ранее образ

    2. Укажите тип OS (Type) - Linux

    1. На вкладке System уберите флажок Qemu Agent, для других полей используйте значения по умолчанию

    1. Перейдите к вкладке Disks

    2. Скорректируйте размер диска под систему до 1 Гб

    1. Нажмите кнопку Add и добавьте дополнительный диск для хранения данных

    2. Укажите размер диска не менее 50 Гб

    1. На вкладках CPU и Memory укажите параметры вычислительных ресурсов виртуальной машины, исходя из ожидаемой нагрузки на АТС. Для тестовой машины можно указать в поле Cores (вкладка CPU) - 2, в поле Memory (вкладка Memory) - 2 Гб

    1. На вкладке Network уберите флажок Firewall

    1. Перейдите к последней вкладке Confirm и установите флажок Start after created

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

    1. Перейдите к созданной виртуальной машине mikopbx-vm

    2. На открытой вкладке перейдите в раздел Console

    3. Если загрузка прошла успешно, появится консольное меню. Введите с клавиатуры 8 для начала установки

    1. Выберите диск под систему и введите с клавиатуры имя диска, например sda. Подтвердите выбор, введите с клавиатуры y

    1. Подключите диск для хранения записей разговоров, ведите с клавиатуры наименование диска для подключения, например sdb

    1. На открытой вкладке в разделе Console скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    1. Для входа используйте логин - admin и пароль - admin

    QEMU Guest Agent позволяет Proxmox получать от MikoPBX внутренние IP-адреса, корректно завершать работу гостя по команде Shutdown и снимать консистентные бэкапы (fs-freeze). Сам бинарь qemu-ga уже включён в дистрибутив MikoPBX и автоматически запускается под управлением monit (сервис vm-tools) — нужно только включить канал агента на стороне Proxmox.

    1. Выберите виртуальную машину MikoPBX, откройте вкладку Options и сделайте двойной клик по строке QEMU Guest Agent

    2. Установите флажок Use QEMU Guest Agent (значение Enabled), параметр Type оставьте VirtIO (по умолчанию), нажмите OK

    На хосте Proxmox (быстрая проверка «жив/мёртв»):

    Внутри MikoPBX (по SSH):

    Если monit summary показывает vm-tools Initializing, а файл /dev/virtio-ports/org.qemu.guest_agent.0 отсутствует — значит со стороны Proxmox virtio-serial-канал ещё не проброшен в VM (опция не включена либо машина не была холодно перезапущена).

    Загрузка образа MikoPBX

    qm agent <VMID> ping                       # должно вернуть пустой ответ без ошибки
    qm agent <VMID> info                       # версия агента и список поддерживаемых команд
    qm guest cmd <VMID> get-host-name          # hostname гостя — подтверждает реальный ответ
    qm agent <VMID> network-get-interfaces     # IP-адреса гостя (видны в WEB-интерфейсе VM)
    ls -la /dev/virtio-ports/org.qemu.guest_agent.0   # файл должен существовать
    ps w | grep qemu-ga | grep -v grep                # процесс qemu-ga должен быть запущен
    monit summary | grep vm-tools                     # ожидаемое состояние: Running

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

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб

    Установка АТС MikoPBX

    После появления сообщения “Press any key within 30 seconds to boot from LiveCD…” не нажимайте никаких кнопок. В этом случае система загрузится с жесткого диска.

    Запуск АТС MikoPBX

    Включение QEMU Guest Agent

    После включения опции необходимо выполнить полную остановку и повторный запуск виртуальной машины (Stop → Start в WEB-интерфейсе или из CLI Proxmox: qm stop <VMID> && qm start <VMID>).

    Обычная перезагрузка (Reboot) не подходит — устройство virtio-serial, через которое работает агент, добавляется в процесс QEMU только при холодном старте. Без рестарта внутри MikoPBX не появится файл /dev/virtio-ports/org.qemu.guest_agent.0 и агент стартовать не сможет.

    Проверка работы QEMU Guest Agent

    На вкладке выберите Создать ВМ
  • Введите имя виртуальной машины, например vm-mikopbx

  • Укажите зону доступности

    1. Укажите параметры вычислительных ресурсов виртуальной машины, исходя из ожидаемой нагрузки на АТС и вашего бюджета. Для тестовой машины можно указать Гарантированная доля vCPU - 20%, RAM - 1 Гб

    Перед созданием виртуальной машины необходимо предварительно загрузить образ MikoPBX в облачное хранилище

    1. Откройте Все сервисы / Инфраструктура и сеть / Object Storage

    2. На вкладке Object Storage выберите Создать бакет

    3. Введите имя нового бакета, например mikopbx-imgs

    4. Укажите макс. размер 1 Гб

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

    6. Завершив ввод значений, нажмите кнопку Создать бакет

    1. Откройте созданный бакет mikopbx-imgs

    2. На открывшейся вкладке выберите Загрузить объекты

    3. Выберите файл из дистрибутива MikoPBX с расширением .raw

    4. Нажмите кнопку Загрузить

    1. После завершения загрузки откройте загруженный объект

    2. Выберите Получить ссылку и скопируйте ссылку на образ

    3. Откройте Все сервисы / Инфраструктура и сеть / Compute Cloud

    4. Перейдите в раздел Образы

    5. На вкладке выберите Загрузить образ

    6. Введите имя образа, например mikopbx-img

    7. В поле Ссылка на образ в Object Storage укажите скопированную ранее ссылку на образ АТС

    8. Нажмите кнопку Загрузить

    Вернемся к выбору образа на вкладке Все сервисы / Инфраструктура и сеть / Compute Cloud / Виртуальные машины

    1. В разделе Выбор образа/загрузочного диска выберите Свой образ / Выбрать / Наполнение - Образ / mikopbx-img

    2. В разделе Диски и файловые хранилища скорректируйте размер загрузочного диска до 1 Гб

    1. В разделе Диски и файловые хранилища выберите Добавить диск

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

    3. Укажите тип диска HDD

    4. Укажите размер диска не менее 50 Гб

    5. Наполнение - Пустой

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

    7. Нажмите кнопку Добавить

    1. В разделе Сетевые настройки выберите существующую или создайте новую облачную сеть

    2. В поле Подсеть в выпадающем меню выберите Добавить подсеть

    3. На открытой вкладке введите имя подсети, например local-mikopbx

    4. В поле CIDR укажите диапазон адресов, например 172.16.32.0/24

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

    6. Нажмите кнопку Создать

    1. Публичный адрес и Внутренний IPv4-адрес оставьте в положении Автоматически

    1. В разделе Доступ укажите Сервисный аккаунт

    2. Введите Логин и SSH-ключ, предварительно сгенерированный по инструкции

    3. В разделе Дополнительные настройки установите флажок Разрешить доступ к серийной консоли

    1. Завершив ввод значений, нажмите кнопку Создать ВМ

    1. Дождитесь запуска созданной виртуальной машины, обычно первый запуск занимает 6-8 минут. Статус Running, еще не означает что система полностью развернулась

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

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные во вкладке Серийная консоль логин и пароль

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

    Yandex Cloud

    Загрузка АТС MikoPBX из произвольного образа

    Настройка дисков

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб

    Настройка сети

    Настройка параметров SSH

    Запуск АТС MikoPBX

    Введите имя группы, например MikoPBX_group

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

  • Завершив ввод значений, нажмите кнопку Просмотр и создание, затем кнопку Создать

    1. Откройте Меню / Все службы / Интернет вещей / Учетные записи хранения

    2. На вкладке Учетные записи хранения выберите Создать

    3. Укажите созданную группу ресурсов MikoPBX_group

    4. Введите имя учетной записи, например pbximgs

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

    6. Завершив ввод значений, нажмите кнопку Проверка, затем кнопку Создать

    1. Перейдите к карточке созданной учетной записи хранения pbximgs

    2. На открытой вкладке перейдите в меню Хранилище данных / Контейнеры

    3. Добавьте новый контейнер

    4. Введите имя контейнера, например imgs

    5. Нажмите кнопку Создать

    1. Откройте созданный контейнер imgs

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

    3. Выберите файл из дистрибутива MikoPBX с расширением .vhd

    4. Нажмите кнопку Отправка

    1. Откройте Меню / Все службы / Вычисление / Образы

    2. На вкладке Образы выберите Создать, создадим новый образ на основе загруженного *.vhd файла

    3. Укажите группу ресурсов MikoPBX_group

    4. Введите уникальное имя для образа, например MikoPBX_Azure

    1. Укажите тип ОС - Linux

    2. Укажите поколение виртуальных машин - Поколение 1

    3. Выберите BLOB-объект хранилища по ссылке Обзор, Обзор / pbximgs / imgs / *.vhd

    4. Укажите тип учетной записи - HDD (цен. категория "Стандартный")

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

    6. Завершив ввод значений, нажмите кнопку Просмотр и создание, затем кнопку Создать

    1. Откройте Меню / Все службы / Вычисление / Виртуальные машины

    2. На вкладке Виртуальные машины выберите Создать / Виртуальная машина Azure

    3. Укажите группу ресурсов MikoPBX_group

    4. Введите имя виртуальной машины, например MikoPBX-vm

    1. Выберите созданный ранее образ, Посмотреть все образы / Другие элементы / Мои изображения / MikoPBX_Azure

    2. Укажите размер машины (совокупность параметров ЦП / ОЗУ не менее 1Гб / HDD)

    1. Укажите имя пользователя для учетной записи администратора

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

    1. Выберите источник открытого ключа SSH - Использовать существующий открытый ключ

    2. Укажите его в поле открытый ключ SSH

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

    1. Выберите источник открытого ключа SSH - Создать новую пару ключей

    2. Укажите имя пары ключей, например mikopbx_key

    Следуйте дальше по инструкции

    1. В поле тип лицензии укажите Другое

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

    1. Перейдите на вкладку Диски

    2. Укажите тип диска ОС

    3. Установите флажок Удалить с виртуальной машиной

    1. Создайте новый диск данных

    2. Укажите размер диска не менее 50Гб

    3. Для других полей используйте значения по умолчанию, нажмите кнопку ОК

    1. Завершив ввод значений, нажмите кнопку Просмотр и создание, затем кнопку Создать

    1. Откройте созданную виртуальную машину и перейдите в раздел Сетевые подключения / Параметры сети / Правила

    2. На вкладке выберите Создание правила для порта / Правило входящего порта

    3. Укажите диапазоны портов назначения - 0 - 65535

    4. Выберите протокол TCP

    1. Укажите имя, например TCP

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

    3. Завершив ввод значений, нажмите кнопку Добавить

    1. Аналогично создайте правило для UDP. Укажите диапазоны портов назначения - 0 - 65535, протокол UDP и имя

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

    2. В выпадающем меню Дополнительные способы подключения выберите Серийная консоль

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные во вкладке Последовательная консоль логин и пароль

    Для быстрого и удобного поиска на портале Azure используйте панель поиска

    Создание группы ресурсов

    https://portal.azure.com/

    Создание учетной записи хранения

    Настройка созданной учетной записи хранения

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

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

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб

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

    Обязательно выполните настройку Firewall на самой АТС MikoPBX

    Запуск АТС MikoPBX

    DHCP (Dynamic Host Configuration Protocol) - это протокол, который позволяет автоматически настраивать IP-адрес. Рекомендуется использовать этот способ, если вы не хотите заниматься ручной настройкой. Просто включите опцию "Использовать DHCP для получения настроек сети" и система автоматически получит IP-адрес от DHCP сервера.

  • Ручная настройка - если вы не хотите использовать DHCP или хотите задать IP-адрес вручную, вы можете выполнить ручную настройку сети. Для этого вам понадобятся некоторые знания о топологии сети. В поле IP-адрес введите желаемый IP-адрес, а рядом с ним укажите маску подсети в формате CIDR. Например, /24 соответствует маске подсети 255.255.255.0.

  • "VLAN ID" - Кроме того, MikoPBX поддерживает виртуальные сетевые интерфейсы, известные как VLAN. Эта функция особенно полезна, если у вас есть только один физический сетевой интерфейс, но вам требуется использовать несколько виртуальных интерфейсов. С помощью VLAN можно создать виртуальные интерфейсы, которые работают поверх физического интерфейса. Преимуществом использования VLAN является возможность направлять телефонные разговоры через него, в то время как сетевое оборудование может осуществлять отдельную обработку трафика VLAN, обеспечивая стабильное соединение.

    Важно отметить, что количество сетевых интерфейсов в MikoPBX не ограничено, и вы можете настроить и использовать несколько интерфейсов в соответствии с вашими потребностями.

    Раздел "Сетевые интерфейсы"

    "Сетевой интерфейс с доступом в интернет" - это основной интерфейс, через который MikoPBX будет получать доступ к внешним адресам, то есть адресам вне вашей локальной сети.

    Если вы не указали адрес DNS-сервера, MikoPBX будет использовать сервер 8.8.8.8 по умолчанию. DNS-серверы отвечают за преобразование доменных имен в IP-адреса, позволяя устройствам находить нужные ресурсы в сети.

    В зависимости от топологии вашей сети, вам потребуется выполнить определенные настройки MikoPBX. Вариант, когда АТС находится за сетевым маршрутизатором, является наиболее распространенным. Это означает, что MikoPBX подключена к вашей локальной сети, и для доступа к интернету используется маршрутизатор. Другой вариант - АТС находится на публичном IP, то есть имеет прямой доступ к интернету без промежуточного маршрутизатора.

    В обоих случаях необходимо настроить MikoPBX соответствующим образом, чтобы обеспечить правильное функционирование и доступ к внешним ресурсам.

    • Если АТС находится за маршрутизатором, то необходимо установить галку «Эта станция расположена за NAT маршрутизатором»

    • Если нам известен внешний адрес станции (ip или доменное имя)и проброшены порты АТС во внешний мир, то имеет смысл заполнить поля «Внешний IP адрес Вашего маршрутизатора» или «Внешнее имя хоста вашего маршрутизатора».

    Всем адресам, которые не являются для АТС локальными, станция будет представляться внешним адресом:

    • Если «Внешний IP адрес Вашего маршрутизатора» пустое, а «Внешнее имя хоста вашего маршрутизатора» заполнено, то АТС будет представляться именно этим полем (Внешнее имя).

    Раздел "Топология сети"
    1. Перейдите в раздел Система → Кастомизация системных файлов.

    Раздел "Кастомизация системных файлов"
    1. Откройте для редактирования файл /etc/static-routes.

    Файл /etc/static-routes
    1. Выберите режим «Заменять полностью» и вставьте правило. Например, route add -net 54.246.198.136 netmask 255.255.255.255 gw 172.16.32.15 dev eth0

    Для указания операционной системе, какой сетевой интерфейс (в данном случае eth0) использовать для поиска IP-адреса 54.246.198.136, а также для указания шлюза (gateway) для направления запроса (в данном случае 172.16.32.15), мы задаем соответствующие значения в настройках сетевого правила.

    Маска подсети "255.255.255.255" указывает, что данное правило будет применимо только к конкретному IP-адресу 54.246.198.136. Если вам необходимо создать правило для группы адресов, например, для всей подсети 54.246.198.0, то фактически это охватывает диапазон адресов от 54.246.198.1 до 54.246.198.254.

    Таким образом, указывая сетевой интерфейс и шлюз в сетевых настройках, вы определяете, какую сеть и через какой маршрут направлять соответствующие запросы и коммуникацию. Это важно для настройки сетевого взаимодействия и обеспечения правильной маршрутизации трафика в вашей сети.

    Нажмите "Сохранить"

    Режим и код для ручной настройки сетевых машрутов

    Параметры

    Сетевые интерфейсы

    Раздел "Сетевые интерфейсы"
    Локальное имя хоста

    Топология сети

    Внешний IP-адрес обязателен для заполнения. Если указано доменное имя - то приоритет за ним и Внешний IP адрес не используется.

    Когда вы включаете опцию «Эта станция расположена за NAT маршрутизатором», важно указать внешний адрес или имя хоста вашего маршрутизатора. Это необходимо для правильной настройки связи между внешней сетью и вашей АТС. Помимо этого, на самом маршрутизаторе необходимо выполнить проброс портов SIP 5060 и RTP 10000-10200 на локальный адрес АТС. Проброс портов позволяет маршрутизатору правильно направлять сетевой трафик SIP и RTP к вашей АТС.

    Однако, если ваш провайдер позволяет вам регистрироваться без использования NAT и у вас нет необходимости подключать внешних абонентов, то вы можете не включать опцию «Эта станция расположена за NAT маршрутизатором». Даже если ваша АТС находится за NAT-маршрутизатором, но вы не нуждаетесь во внешних подключениях, эта опция не обязательна.

    Важно учитывать требования вашего провайдера и особенности вашей сети при выборе и настройке этой опции.

    Ручная настройка сетевых маршрутов

    Перейдите в консоль Google Cloud, в раздел "APIs & Services" (ссылка). Создайте проект под текущую задачу.

    Раздел "APIs & Services" в Google Cloud
    1. Перейдите в библиотеку APIs (раздел "Library").

    Раздел "Library" в APIs & services
    1. Введите в поиске: "gmail api". Перейдите в карточку Gmail API.

    Gmail API в библиотеке Google Cloud
    1. Нажмите "Enable" для подключения.

    Подключение API
    1. Перейдите на главную страницу APIs & Services. Далее "OAuth consent screen".

    Раздел "OAuth consent screen" в APIs & Services
    1. Создайте проект (нажмите "Get started"). Заполните произвольное название и Вашу почту. В качестве Audience выберите "Internal". Нажмите "Create" для завершения.

    Параметр "Audience" в создании проекта
    1. Вернитесь на главную страницу APIs & Services. Далее в раздел "Credentials". Нажмите "Create credentials". Выберите "OAuth client ID" для создания.

    Создание нового OAuth client ID
    1. В качестве Application type, выберите "Web application". Далее введите произвольное название. Нажмите "Create".

    Создание нового OAuth client ID
    1. Добавьте новый "Authorized redirect URI".

    Добавление нового URl для перевода
    1. Будет создан OAuth client. Сохраните ClientID и Client secret себе в заметки. В будущем эти данные понадобятся для подключения.

    Успешно созданный клиент
    1. Перейдите в раздел "Система" -> "Почта и уведомления":

    Раздел "Почта и уведомления" в MikoPBX
    1. Далее, "Настройки SMTP". Заполните следующие параметры:

    • Адрес отправителя, Имя отправителя - Ваша почта и от какого имени будут отправляться письма.

    • Тип аутентификации - OAuth2.

    • SMTP логин - Ваша почта.

    • Провайдер OAuth2 - Google/Gmail.

    • Идентификатор приложения (Client ID), Секретный ключ (Client Secret) - данные, которые сохранены из Google Cloud (12 пункт из прошлого раздела в этой инструкции).

    Все остальные настройки оставьте по умолчанию. Более подробное описание Вы можете найти в главное статье о параметрах почты (ссылка).

    После этого нажмите "Сохранить"!

    Параметры почты для подключения Gmail
    1. Нажмите на синюю кнопку "Подключить через OAuth2". Далее выберите Ваш аккаунт Gmail.

    Выбор аккаунта Google
    1. Подтвердите вход: нажмите "Continue".

    Продолжения авторизации
    1. Подтвердите выдачу необходимых разрешений. (Нажмите "Allow").

    Выдача разрешений

    При успешной авторизации, вы увидите следующее окно.

    Успешная авторизация

    Access blocked: Authorization Error (Error 400: invalid_request)

    Ошибка 400: invalid_request

    Решение: впишите URl адрес станции в Веб-интерфейсе MikoPBX: "Сеть и Firewall" -> "Сетевые интерфейсы". Перейдите в раздел "Топология сети" и впишите имя хоста в поле "Внешнее имя хоста вашего маршрутизатора". (Включите "Эта станция расположена за NAT маршрутизатором")

    Решение проблемы

    Для настройки OAuth 2.0 в Google требуется использовать URL-адрес станции. Самый простой способ — создать DNS-запись на локальном сервере или добавить соответствие IP-адреса и доменного имени в файл hosts на устройстве, с которого выполняется настройка.

    Настройки аккаунта Google

    ссылка
    Страница упрвления аккаунтом Google
    Настройка двухэтапной аутентификации

    Формат:

    https://mikopbx.station.com/pbxcore/api/v3/mail-settings/oauth2-callback

    Замените "mikopbx.station.com" на URl Вашей станции.

    Настройки в MikoPBX

    Решение возможных проблем

    Нажмите синюю кнопку "Регистрация в маркетплейсе" для начала регистрации:
    Кнопка "Регистрация в маркетплейсе" в разделе "Модули" -> "Маркетплейс"

    Лицензионный ключ используется для хранения всех ваших лицензий от любых продуктов МИКО. Если у вас уже есть ключ, вы можете просто вписать его в одноименное поле. Если ключ у вас был, но вы его забыли, вы можете поискать письмо в вашей электронной почте входящие письма по адресу lic@miko.ru

    Лицензионный ключ

    Получить новый ключ можно автоматически, заполнив регистрационную форму ниже:

    • Название организации - введите имя вашей компании/организации.

    • Адрес электронной почты контактного лица - введите адрес электронной почты вышей компании/организации.

    • Контактное лицо - введите данные контактного лица.

    • Телефон контактного лица (необязательно).

    • Уникальный идентификатор компании (ИНН, ИИН, УНП и т.д.) (необязательно).

    Нажмите "Зарегистрироваться"

    Регистрационная форма для маркетплейса

    В случае успешной регистрации, вы увидите следующий экран:

    • Уведомление об успешной регистрации системы.

    • Наведите курсор на поле с лицензионным ключом, если вам необходимо его увидеть или скопировать. По умолчанию значение ключа размыто.

    Успешная регистрация в маркетплейсе

    Для управления лицензией перейдите в раздел Маркетплейс -> Управление лицензией. Нажмите на одноименный элемент:

    Элемент "Управление лицензией"

    Вы попадете на сайт SaaS сервер лицензирования:

    Страница "SaaS сервер лицензирования"

    Для управления лицензией введите ваш лицензионный ключ в поле "Введите ваш лицензионный ключ или активированный ранее купон":

    Нажмите "Login"

    Введённый лицензионный ключ

    Вы попадете в систему, где находятся 9 секций:

    Система SaaS

    Перейдите в раздел "Монитор сессий":

    Раздел "Монитор сессий"

    Слева для каждой привязки в колонке Информация есть кнопка i, которая позволяет посмотреть подробную информацию о хосте, к которому привязана лицензия.

    Информация о хосте

    Для каждой привязки в колонке "Действие" есть кнопка "Сброс", которая позволяет сбросить активную привязку лицензии от хоста.

    Сброс лицензии на хосте.

    При регистрации может возникать проблема отсутствии у MikoPBX связи с интернетом, а именно с отсутствием связи с серверами lic.miko.ru и lic.mikopbx.com по порту 443(https)

    Решение: проверить доступ к станции из интернета, проверить настройки firewall и общего доступа к вышеупомянутым ресурсам.

    MikoPBX переодически обращается к серверам лицензирования для проверки установленных модулей. Если лицензия на модуль недоступна, то он будет отключен, а рядом с названием модуля появится соответствующая иконка в виде перечеркнутого ключа.

    Общая информация

    Сама MikoPBX - бесплатное решение и не требует никакой регистрации. Отсутствие лицензии никак не влияет на звонки. Вы в любой момент можете зарегистрироваться, а также отменить регистрацию в Marketplace.

    Процесс регистрации

    В случае переноса MikoPBX на другой хост или восстановлении из бекапа, необходимо выполнить сброс привязок лицензий на модули в личном кабинете lm.mikopbx.com

    При регистрации выдается 1 ключ на компанию. Это значит, что если Вы используйте несколько станций MikoPBX в своей компании - вам достаточно будет одной регистрации.

    Раздел "Модули" -> "Маркетплейс модулей"
    Раздел Маркетплейса, в случае, если не выполнена регистрация

    Управление лицензией

    Возможные проблемы

    Проблема при регистрации в Маркетплейсе

    Иконка перечеркнутого ключа

    ssh -i C:\Users\<Username>\.ssh\id_ed25519 do-user@mikopbxipadress

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

    Рекомендуемый размер диска для хранения записей разговоров - от 50ГБ.

    Подключение к консоли и первый вход в WEB-Интерфейс

    Подключение из консоли Digital Ocean

    Подключение по SSH

    Стандартный логин для авторизации по SSH для ВМ в DigitalOcean - do-user.

    Замените:

    1. C:\Users\<Username>\.ssh\id_ed25519 на путь к Вашему ключу на локальном устройстве

    2. do-user на Ваш root-логин (если Вы его изменяли при созданиии ВМ)

    3. mikopbxadress на IP-адрес вашей станции (IPv4 в интерфейсе управления Виртуальной машиной)

    Windows
    MacOS/Linux
    инструкциям
    "Import via URL"
    Параметры образа
    Главная страница DigitalOcean
    Создание нового "Droplet"
    Параметры ВМ #1
    Параметры ВМ #2
    Раздел "Additional Storage"
    Методы авторизации
    Консоль в Digital Ocean
    external ip-адрес
    ID виртуальной машины
    Команда для SSH подключения

    Создание LXC контейнера

    Swap — это область на диске, которую система использует как дополнительную память, когда заканчивается оперативная память (RAM). Она работает значительно медленнее RAM и служит резервом, чтобы система не завершала процессы при нехватке памяти.

    Первый запуск

    Данные для входа:

    Login: admin

    Password: пароль, который Вы задали на начальном этапе создания контейнера.

    Github MikoPBX
    здесь
    этой статье
    этой статье
    Копирование ссылки на шаблон
    Загрузка шаблона из URL
    Успешная загрузка шаблона
    Кнопка "Create CT" для создания нового контейнера
    Базовые параметры контейнера
    Выбор шаблона для создаваемого контейнера
    Параметры системного диска
    Указание параметров для второго диска
    Указание парметров для третьего диска
    Параметры создаваемого контейнера (CPU)
    Параметры создаваемого контейнера (Memory)
    Параметры создаваемого контейнера (Network)
    Параметры создаваемого контейнера (DNS)
    Итоговая конфигурация контейнера
    Процесс запуска контейнера
    IP-адрес web-интерфейса
    Web-интерфейс MikoPBX

    В MikoPBX используются два диска:

    1. Системный диск. На него устанавливается система, рекомендуемый размер - 1 Гб.

    2. Диск для хранения записей разговоров. Рекомендуемый размер - от 50 Гб.

    Подключение диска для хранения данных

    Установка системы

    Стандартные данные для входа:

    • Login: admin

    • Password: admin

    Выбор типа операционной системы
    Выбор файла образа диска для виртуальной машины
    Конфигурация ВМ
    Указание размера системного диска
    Раздел "Shared Directory"
    Итоговая конфигурация
    Настройки ВМ
    Раздел "Drives"
    Создание второго диска
    Запуск ВМ
    MikoPBX в режиме LiveCD
    Выбор диска для установки системы
    Подтверждение выбора диска
    Выбор диска для хранения записей разговоров
    IP-адрес MikoPBX
    Web-интерфейс MikoPBX

    Запуск MikoPBX в контейнере

    Установка MikoPBX в Docker контейнер

    Для работы с MikoPBX в контейнере необходимо установить docker и docker compose, а также создать пользователя и папки для хранения настроек конфигурации и записей разговоров по инструкции

    Установка докера и cоздание пользователя и каталогов

    Запуск контейнера Docker

    Для запуска контейнера с вашим приложением воспользуйтесь следующими командами:

    # Получение образа контейнера
    sudo docker pull ghcr.io/mikopbx/mikopbx:latest
    
    ## Альтернативно — можно загрузить образ с Docker Hub
    # sudo docker pull mikopbx/mikopbx:latest
    
    # Запуск контейнера в не привилегированном режиме
    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:latest

    Docker автоматически загрузит образ под архитектуру вашей системы (x86-64 или arm64).

    Образ также доступен на Docker Hub: mikopbx/mikopbx:latest

    Проверка работы

    Чтобы убедиться, что ваше приложение MikoPBX запостилось и работает в Docker-контейнере, можно выполнить следующие шаги после его запуска. Эти шаги помогут проверить состояние контейнера и просмотреть его логи.

    Шаг 1: Проверка статуса контейнера

    Сначала нужно удостовериться, что контейнер успешно запущен и работает. Для этого используем команду docker ps, которая покажет список запущенных контейнеров и их статус.

    sudo docker ps

    Эта команда выведет информацию о всех активных контейнерах. Убедитесь, что контейнер mikopbx присутствует в списке и его статус указывает на то, что он запущен и работает (например, статус up).

    После подтверждения того, что контейнер запущен, следующим шагом будет просмотр логов для проверки, что приложение загрузилось без ошибок и функционирует нормально. Команда docker logs позволит вам увидеть вывод, который генерирует ваше приложение.

    Просмотрите вывод команды на наличие сообщения, подобного указанному ниже. Это сообщение свидетельствует о том, что MikoPBX успешно загружена и готова к использованию:

    Если отображается процесс запуска MikoPBX, то необходимо подождать и повторить команду sudo docker logs mikopbx

    При старте контенер не имеет информации об адресе хостовой системы, потому необходимо открыть внешний адрес хостовой системы, в данном случае Ubuntu в браузере. https://<IP адрес хост системы>

    Войдите в веб-интерфейс, используя логин admin и пароль admin, чтобы убедиться, что веб-интерфейс доступен и функционирует корректно.

    • Флаг NET_ADMIN необходим для возможности работы системы проактивной защиты fail2ban и фаервола iptables внутри контейнера. При срабатывании блокировки доступа, например при вводе неверного пароля, доступ с IP адреса злоумышленника будет заблокирован.

    • Если необходимо использовать «», то контейнер следует запускать с флагом --privileged. Когда MikoPBX запускается в контейнере, резервное копирование можно также выполнять архивированием каталогов cf и storage вручную . В этом случае привелегированный режим можно не использовать, но в момент копирования контейнер должен быть остановлен.

    Помимо использования нашего официального реестра, вам может понадобиться вариант создания контейнера из образа, например для бета-версии. В составе опубликованных релизов и предрелизов поставляется tar-архив, который мы используем для создания контейнера.

    Пример кода для его использования:

    Ниже перечислены некоторые переменные окружения, которые позволят скорректировать используемые MikoPBX порты и настройки.

    • SSH_PORT - порт для SSH (22)

    • WEB_PORT - порт для работы web интерфейса по протоколу HTTP (80)

    • WEB_HTTPS_PORT - порт для работы web интерфейса по протоколу HTTPS (443)

    Полный список всех возможных параметров настроек доступен в исходном коде .

    1С:Облачная инфраструктура

    Установка MikoPBX с помощью 1С:Облачная инфраструктура

    Для начала авторизуйтесь на сайте https://cloudinf.1c.ru

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

    Добавление локальной подсети

    1. Откройте Виртуальные сети / Сети

    2. На вкладке Сети выберите Создать

    3. Введите имя новой сети, например pbx_network

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

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

    1. Перейдите к своему аккаунту

    2. В выпадающем меню выберите Ключевые пары

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

    1. Выберите Импортировать ключ

    2. Введите название ключа и укажите ключ в поле Публичный ключ

    3. Нажмите кнопку Импортировать ключ

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

    1. Выберите Создать ключ

    2. Введите название ключа, например mikopbx_ssh_key

    3. Нажмите кнопку Создать ключ

    1. Откройте Облачные вычисления / Образы

    2. На вкладке Образы выберите Создать образ

    3. Укажите источник - Файл

    1. Откройте Облачные вычисления / Виртуальные машины

    2. На вкладке Виртуальные машины выберите Создать инстанс

    3. Введите имя виртуальной машины, например mikopbx_vm

    1. Укажите Тип диска - HDD

    2. В качестве Операционной системы выберите mikopbx_image

    1. Перейдите к следующему шагу Настройки сети

    2. Выберите созданную Сеть pbx_network

    3. Выберите созданный Ключ виртуальной машины mikopbx_ssh_key

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

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

    3. Как только инстанс будет создан, сразу остановите его запуск

    1. Откройте Облачные вычисления / Диски

    2. На вкладке Диски выберите Создать диск

    3. Введите название диска, например mikopbx_storage_disk

    1. Включите переключатель Подключить диск к инстансу

    2. Выберите созданный инстанс mikopbx_vm

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

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

    1. Откройте Облачные вычисления / Виртуальные машины

    2. Запустите созданный инстанс mikopbx_vm

    1. Откройте Виртуальные сети / Настройки firewall

    2. На вкладке Настройки firewall выберите Добавить

    3. Введите имя группы правил, например mikopbx_rules

    1. На открытой вкладке в разделе Входящий трафик выберите Добавить правило

    2. Выберите Тип - Все протоколы и все порты

    3. Укажите Удаленный адрес - Все IP-адреса

    1. В разделе Виртуальные машины с группой правил mikopbx_rules выберите Добавить виртуальную машину

    2. Выберете созданную виртуальную машину mikopbx_vm и нажмите Добавить группу правил

    1. Дождитесь запуска созданного инстанса, обычно первый запуск занимает 6-8 минут

    2. Откройте Облачные вычисления / Виртуальные машины

    3. Перейдите к созданной виртуальной машине mikopbx-vm

    4. На открытой вкладке перейдите в раздел Логи

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные во вкладке Серийная консоль логин и пароль

    Google Cloud подробная инструкция

    Установка MikoPBX в облако Google Cloud с помощью произвольного образа

    Авторизуйтесь на платформе https://console.cloud.google.com/

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

    Для быстрого и удобного поиска на платформе Google Cloud используйте панель поиска

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

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

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

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

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

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

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

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

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

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

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

    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 для создания нового образа

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

    2. Укажите Targets

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

    1. В разделе Protocols and ports установите флажок TCP (Ports - 0-65535) и флажок UDP (Ports - 0-65535)

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

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

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

    2. Перейдите к созданной виртуальной машине mikopbx-vm

    3. На открытой вкладке перейдите к Logs / Serial port 1 (console)

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные в Serial port 1 (console) логин и пароль

    VK Cloud

    Установка MikoPBX с помощью VK Cloud

    Для начала авторизуйтесь на сайте https://cloud.vk.com

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

    Добавление локальной подсети

    1. Откройте Виртуальные сети / Сети

    2. На вкладке Сети выберите Создать

    3. Введите имя новой сети, например pbx_network

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

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

    1. Перейдите к своему аккаунту

    2. В выпадающем меню выберите Ключевые пары

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

    1. Выберите Импортировать ключ

    2. Введите название ключа и укажите ключ в поле Публичный ключ

    3. Нажмите кнопку Импортировать ключ

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

    1. Выберите Создать ключ

    2. Введите название ключа, например mikopbx_ssh_key

    3. Нажмите кнопку Создать ключ

    1. Откройте Облачные вычисления / Образы

    2. На вкладке Образы выберите Создать образ

    3. Укажите источник - Файл

    1. Откройте Облачные вычисления / Виртуальные машины

    2. На вкладке Виртуальные машины выберите Создать инстанс

    3. Введите имя виртуальной машины, например mikopbx_vm

    1. Укажите Тип диска - HDD

    2. В качестве Операционной системы выберите mikopbx_image

    1. Перейдите к следующему шагу Настройки сети

    2. Выберите созданную Сеть pbx_network

    3. Выберите созданный Ключ виртуальной машины mikopbx_ssh_key

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

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

    3. Как только инстанс будет создан, сразу остановите его запуск

    1. Откройте Облачные вычисления / Диски

    2. На вкладке Диски выберите Создать диск

    3. Введите название диска, например mikopbx_storage_disk

    1. Включите переключатель Подключить диск к инстансу

    2. Выберите созданный инстанс mikopbx_vm

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

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

    1. Откройте Облачные вычисления / Виртуальные машины

    2. Запустите созданный инстанс mikopbx_vm

    1. Откройте Виртуальные сети / Настройки firewall

    2. На вкладке Настройки firewall выберите Добавить

    3. Введите имя группы правил, например mikopbx_rules

    1. На открытой вкладке в разделе Входящий трафик выберите Добавить правило

    2. Выберите Тип - Все протоколы и все порты

    3. Укажите Удаленный адрес - Все IP-адреса

    1. В разделе Виртуальные машины с группой правил mikopbx_rules выберите Добавить виртуальную машину

    2. Выберете созданную виртуальную машину mikopbx_vm и нажмите Добавить группу правил

    1. Дождитесь запуска созданного инстанса, обычно первый запуск занимает 6-8 минут

    2. Откройте Облачные вычисления / Виртуальные машины

    3. Перейдите к созданной виртуальной машине mikopbx-vm

    4. На открытой вкладке перейдите в раздел Логи

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные во вкладке Серийная консоль логин и пароль

    Подключение S3 хранилища AWS

    Инструкция по подключению AWS S3 в качестве облачного хранилища для автоматической выгрузки записей разговоров из MikoPBX

    Создание бакета

    1. Перейдите в консоль AWS (ссылка). Перейдите в раздел "Все сервисы" -> "Storage" -> "S3".

    Раздел "S3" в AWS
    1. Нажмите "Create bucket".

    Кнопка для создания бакета
    1. Укажите произвольное название для бакета (поле "Bucket name"). Все остальные параметры оставьте по умолчанию, нажмите "Create bucket".

    1. Перейдите в раздел "Все сервисы" -> "Security, Identity, & Compliance" -> "IAM".

    1. Далее необходимо создать нового IAM пользователя. Для этого перейдите во вкладку "Access Management", далее "Users". Нажмите "Create user".

    1. Укажите имя создаваемого IAM пользователя в поле "User name".

    Нажмите "Next".

    1. Выберите "Attach policies directly" в качестве "Permissions options". Пролистайте страницу.

    1. В разделе "Permissions policies" нажмите "Create policy".

    1. В открывшейся вкладке, в окне "Policy editor", выберите "JSON" в качестве формата и вставьте следующий контекст в поле с параметрами:

    Нажмите "Next".

    1. Далее укажите произвольное название для создаваемой политики.

    Нажмите "Next".

    1. Вернитесь на вкладку создания пользователя, обновите список политик и выберите ранее созданную policy (в этой инструкции - "access-mikopbx").

    Нажмите "Next".

    1. Подтвердите создание пользователя: нажмите "Create user".

    1. Откройте страницу созданного пользователя, нажав на его имя.

    1. Перейдите в раздел "Security credentials". Нажмите "Create access key".

    1. Выберите "Application running outside AWS". Нажмите "Next".

    1. Введите описание ключа для того, чтобы идентифицировать его в будущем. Нажмите "Create access key".

    Будет отображены access key и secret access key ключи. Сохраните их, они понадобятся далее для настройки внутри MikoPBX.

    1. Перейдите во вкладку "Обслуживание" -> "Хранилище".

    1. Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:

    • Автоматическая загрузка записей в облачное хранилище — включите переключатель.

    • URL точки доступа S3 — введите адрес доступа к S3 AWS, в зависимости от региона Вашего бакета (на таблицу со всеми url). В этой инструкции - https://s3.ap-southeast-1.amazonaws.com

    • Регион S3 — укажите регион Вашего бакета, в этой инструкции - ap-southeast-1

    Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.

    Нажмите «Сохранить».

    После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Подключено к S3» и начнется синхронизация записей телефонных разговоров.

    Подключение S3 хранилища Wasabi

    Инструкция по подключению Wasabi Cloud Storage в качестве S3-хранилища

    Создание бакета и ключей

    1. Перейдите в консоль Wasabi (ссылка).

    2. В левом меню выберите раздел "Buckets" и нажмите кнопку "Create Bucket".

    Создание нового бакета
    1. На странице создания бакета укажите:

    • Bucket Name - произвольное уникальное имя для бакета (например, mikopbx-s3-storage).

    • Region - выберите регион, ближайший к станции MikoPBX.

    Нажмите "Create Bucket".

    1. После создания бакета необходимо создать политику доступа. Перейдите в раздел "Policies" в левом меню и нажмите "Create Policy".

    1. Задайте название для создаваемой политики (Policy Name), придумайте ее описание для будущей идентификации (Description). В поле "Policy Editor" вставьте следующий набор правил:

    1. Перейдите в раздел "Users" в левом меню (блок "Users & Groups") и нажмите "Create User".

    1. На первом шаге "Details" заполните параметры:

    • UserName - укажите произвольное имя пользователя (например, mikopbx-user).

    • Type of Access - отметьте только "Programmatic (create API keys)".

    • Require MFA - оставьте выключенным.

    Нажмите "Next".

    1. На шаге Groups - пропустите, нажмите "Next".

    1. На шаге Policies — выберите политику, созданную ранее (например, mikopbx-access в этой инструкции), и нажмите "Next".

    1. На шаге Review проверьте параметры и нажмите "Create User".

    После создания пользователя будут отображены Access Key и Secret Key. Сохраните эти значения, они понадобятся для настройки внутри MikoPBX. Secret Key показывается только один раз.

    1. Перейдите во вкладку "Обслуживание" -> "Хранилище".

    1. Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:

    • Автоматическая загрузка записей в облачное хранилище — включите переключатель.

    • URL точки доступа S3 — введите endpoint Вашего региона из таблицы ниже. Например, для региона eu-central-1: https://s3.eu-central-1.wasabisys.com

    • Регион S3 — укажите регион Вашего бакета в Wasabi (например, eu-central-1

    Нажмите «Сохранить».

    Регион
    Endpoint URL

    После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Соединение с S3 успешно» и начнётся синхронизация записей телефонных разговоров.

    Настройка Microsoft Outlook (oAuth2)

    Настройка почты для сервиса Outlook (outlook.com; hotmail.com)

    Настройки внутри Microsoft Entra

    Регистрация приложения

    1. Войдите в центр администрирования Microsoft Entra.

    Главная страница центра администрирования Microsoft Entra
    1. Перейдите в раздел "Entra ID" -> "App registrations". Далее нажмите "New registration" для регистрации нового приложения.

    Регистрация нового приложения
    1. Выберите следующие параметры для Вашего приложения:

    • Name - укажите название для Вашего приложения.

    • Supported account types - выберите параметр "Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)".

    1. Укажите Redirect URl:

    • Select a platform - выберите "Web".

    • URl:

    Замените 192.168.100.71 на адрес Вашей MikoPBX.

    Далее нажмите "Register".

    1. Будет созданно приложения. Сохраните client ID, в будущем он понадобится для настройки внутри веб-интерфейса MikoPBX.

    1. Из главной страницы приложения перейдите в "Manage" -> "API permissions".

    1. Нажмите "Add a permission".

    1. В разделе "Microsoft Graph" выберите "Delegated Permissions". В поиске введите "SMTP". Поставьте галочку напротив "SMTP.Send".

    1. Так же в поиске введите "offline". Поставьте галочку напротив "offline_access".

    Нажмите "Add permissions".

    1. Далее перейдите в раздел "Certificates & secrets" -> "Client secrets". Нажмите "New client secret".

    1. Задайте необходимые параметры:

    • Description - произвольное описание.

    • Expires - срок на который Вы выпускаете этот client secret. Он понадобится нам для аутентификации приложения в MikoPBX.

    Нажмите "Add".

    1. Скопируйте "Value" (не SecretID!). Он понадобится для настройки в веб-интерфейсе MikoPBX.

    Для корректной работы приложения, Вам необходимо выдать разрешение на использования SMTP протокола для пользователя, чью почту Вы авторизовываете в ходе текущей насройки. Для этого выполните следующие шаги:

    1. Перейдите в центр администрирования организации ().

    1. Перейдите в раздел "Users" -> "Active Users". Нажмите на имя пользователя, под учетной записью которого произодится создание приложения.

    1. В учетной записи, перейдите в раздел "Mail" и выберите "Manage email apps".

    1. Убедитесь, что "Authenticated SMTP" разрешен. Сохраните изменения, нажав "Save changes".

    1. Перейдите в Web-интерфейс MikoPBX. Далее "Система" -> "Почта и уведомления" -> "Настройки SMTP".

    Заполните все необходимые данные:

    • Адрес отправителя, Имя отправителя - Ваша почта и от какого имени будут отправляться письма.

    • Тип аутентификации - OAuth2.

    • SMTP логин - Ваша почта.

    Все остальные настройки оставьте по умолчанию. Более подробное описание Вы можете найти в главное статье о параметрах почты ().

    После этого нажмите "Сохранить"!

    1. Нажмите "Подключить через OAuth2". Войдите в Ваш аккаунт Microsoft. Далее подтвердите выдачу всех запрошенных разрешений.

    При успешной авторизации Вы увидите соответствующее окно.

    Доступ к AMI

    Настройка доступа к AMI

    Asterisk Manager Interface (AMI) - мощный и удобный программный интерфейс (API) Asterisk для управления системой из внешних программ. Благодаря AMI внешние программы могут осуществлять соединения с Asterisk посредством TCP протокола, инициировать выполнение команд, считывать результат их выполнения, а так же получать уведомления о происходящих событиях в реальном времени. AMI часто используют для интеграции с бизнес-процессами и системами, программным обеспечением CRM (Customer Relationship Managment — управление взаимодействия с клиентами). Управление Asterisk часто осуществляется из консоли CLI, но при использовании AMI не требуется прямой доступ к серверу, на котором запущен Asterisk. AMI — это наиболее простой инструмент, который в руках разработчика может оказаться очень мощным и гибким средством для интеграции с другими программными продуктами. Он дает возможность разработчикам использовать информацию, генерируемую Asterisk, в реальном масштабе времени.

    Первое что необходимо сделать, это включить AMI и завести пользователя, с помощью которого клиентская программа будет аутентифицироваться. «Система» - «Доступ к AMI»

    Раздел "Доступ к AMI"

    Для добавления новой учетной записи необходимо указать Имя пользователя и Пароль. Кроме того, необходимо задать Сетевой фильтр, т.е. из какой подсети разрешено подключение к пользователю AMI. Вы можете разрешить подключения с любых адресов, либо указать конкретную сеть, настройку который Вы произвели в разделе "Сеть и Firewall" → "".

    Права пользователя AMI, устанавливаемые в секции [user] конфигурационного файла /etc/asterisk/manager.conf

    Идентификатор прав
    Чтение
    Запись

    VirtualBOX

    Установка MikoPBX с помощью VirtualBox

    1. Скачайте программу VirtualBox по и установите ее.

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

    3. Укажите Имя и Папку машины.

    Тип - Linux.

    Версия - Other Linux (64Bit).

    Vultr

    Установка MikoPBX с помощью сервиса Vultr

    В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы Vultr.

    Перед началом Вам необходимо скачать актуальный образ MikoPBX с расширением .iso. Сделать это можно на .

    Для начала необходимо загрузить образ в облачную платформу.

    1. Перейдите в раздел "Cloud Storage" -> "Object Storage":

    Диагностика системы

    Описание функций раздела

    Раздел «Диагностика системы» в MikoPBX — это инструмент для мониторинга и анализа состояния телефонной системы. Использование этого раздела помогает своевременно обнаруживать и устранять технические проблемы, обеспечивая стабильную и эффективную работу MikoPBX.

    Расположение раздела: "Обслуживание" -> "Системные логи"

    Содержит 3 вкладки: просмотр логов, информация о системе, захват сетевых пакетов. Далее в статье будет подробно разобрана каждая из них.

    Раздел позволяет просмотреть файлы логов для детального анализа работы АТС

    Исходящие маршруты

    Описание и настройка исходящей маршрутизации

    Исходящие маршруты в MikoPBX — это набор правил и настроек, определяющих, как система обрабатывает исходящие звонки от сотрудников к внешним номерам. С их помощью администраторы могут управлять направлением вызовов через различные провайдеры телефонии или линии связи в зависимости от определенных условий, таких как набранный номер, префиксы, время суток или права доступа пользователя. Это позволяет оптимизировать затраты на связь, распределять нагрузку между каналами и применять политики безопасности, ограничивая или разрешая определенные типы вызовов. Настройка исходящих маршрутов обеспечивает гибкость и контроль над исходящей телефонной связью, способствуя эффективной работе коммуникационной системы компании.

    В данной статье Вы найдете подробную документацию по настройке исходящей маршрутизации.

    Вы можете создавать неограниченное количество правил исходящей маршрутизации. Для одного провайдера можно создать несколько правил.

    Чтобы добавить новое правило исходящей маршрутизации нажмите на кнопку Добавить новое правило.

    Подключение S3 хранилища MinIO (self-hosted)

    Инструкция по развертыванию и подключению локального MinIO S3 к MikoPBX

    В данной инструкции описан процесс развёртывания локального S3-хранилища MinIO и его подключения к MikoPBX. Все действия выполняются на macOS - для других операционных систем официальная документация доступна .

    1. Откройте терминал и выполните команду:

    По завершении установки терминал отобразит подтверждение:

    1. Создайте директорию для данных.

    для хранения записей разговоров

    Log

    Предоставляет пользователю доступ к чтению логов

    Только чтение

    Verbose

    Предоставляет пользователю доступ к чтению подробных логов

    Только чтение

    Agent

    Чтение событий статуса агентов из app_queue и chan_agent модулей

    Позволяет пользователю выполнять действия для управления и получения состояния очередей и агентов

    User

    Доступа к пользовательским событиям, а также событиям Jabber / XMPP пользователей

    Позволяет пользователю выполнять команду UserEvent, для создания пользовательских событий

    Config

    Только для записи

    Позволяет пользователю получать, обновлять и перегружать файлы конфигурации

    Command

    Только для записи

    Позволяет пользователю выполнять команды Asterisk CLI из AMI

    Dtmf

    Позволяет пользователю получать события DTMF

    Только чтение

    Reporting

    Доступ к событиям качества звонка, таким как jitterbuffer или RTCP

    Позволяет пользователю выполнять ряд действий для получения статистики и информации о состоянии всей системы

    Cdr

    Чтение событий записи данных в CDR

    Только чтение

    Dialplan

    Чтение событий установки переменных диалплана, создания "экстенов"

    Только чтение

    Originate

    Только для записи

    Разрешение пользователю выполнять команду Origitate, которая отправляет запрос на создание нового звонка

    System

    Чтение общей информации о системе, например, уведомления о перезагрузке конфигурации

    Позволяет пользователю выполнять Asterisk системы управления такими командами, как Restart, Reload, или Shutdown. Это разрешение также предоставляет пользователям возможность запускать системные команды за пределами Asterisk. Предоставление такого разрешения эквивалентно предоставлению доступа к командной оболочке, с правами пользователя / группы, под которыми запущен процесс Asterisk

    Call

    Чтение события о каналах в системе

    Опции и права пользователя AMI

    Сетевой экран
    Параметры нового AMI пользователя

    Позволяет пользователю устанавливать информация на каналах

  • Имя бакета S3 — укажите имя бакета, созданного в AWS (например, aws-s3-mikopbxstorage в этой инструкции)

  • Ключ доступа и Секретный ключ — вставьте значения, полученные при создании access ключа сервисного аккаунта.

  • Создание IAM пользователя и ключей доступа

    Замените "имя-вашего-бакета" на название созданого ранее бакета (в этой инструкции - "aws-s3-mikopbxstorage").

    Только сейчас можно просмотреть или загрузить секретный ключ доступа. Восстановить его позже будет невозможно.

    Подключение к MikoPBX

    Более короткое локальное хранение быстрее освобождает дисковое пространство.

    ссылка
    Параметры создаваемого бакета
    Раздел "IAM"
    Создание нового IAM пользователя
    Вкладка "Specify user details"
    Выбор "Permissions options"
    Кнопка "Create policy"
    Создание новой политики. Шаг 1
    Создание новой политики. Шаг 2
    Выбор ранее созданной политики
    Подтверждение создания пользователя
    Переход на страницу созданного пользователя
    Создание access ключа
    Выбор параметров при создании ключа
    Описание ключа
    Access key и Secret access key
    Раздел "Облсуживание" -> "Хранилище"
    Параметры подключения облачного хранилища S3 в MikoPBX
    Успешное подключение
    ).
  • Имя бакета S3 — укажите имя бакета, созданного в Wasabi (например, mikopbx-s3-storage).

  • Ключ доступа и Секретный ключ — вставьте значения, полученные при создании Access Key.

  • Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.

  • eu-central-1 (Amsterdam)

    https://s3.eu-central-1.wasabisys.com

    eu-central-2 (Frankfurt)

    https://s3.eu-central-2.wasabisys.com

    eu-west-1 (London)

    https://s3.eu-west-1.wasabisys.com

    eu-west-2 (Paris)

    https://s3.eu-west-2.wasabisys.com

    ap-northeast-1 (Tokyo)

    https://s3.ap-northeast-1.wasabisys.com

    ap-northeast-2 (Osaka)

    https://s3.ap-northeast-2.wasabisys.com

    ap-southeast-1 (Singapore)

    https://s3.ap-southeast-1.wasabisys.com

    ap-southeast-2 (Sydney)

    https://s3.ap-southeast-2.wasabisys.com

    us-east-1 (N. Virginia)

    https://s3.wasabisys.com

    us-east-2 (N. Virginia)

    https://s3.us-east-2.wasabisys.com

    us-west-1 (Oregon)

    https://s3.us-west-1.wasabisys.com

    Запомните название Вашего региона (например, ap-southest-1), оно понадобится при настройке внутри MikoPBX.

    Замените "YOUR-BUCKET-NAME" на название ранее созданного бакета (mikopbx-s3-storage в этой инструкции)

    Подключение к MikoPBX

    Параметры создаваемого бакета
    Создание новой политики доступа
    Параметры создаваемой политики
    Создание нового пользователя
    Вкладка "Details" при создании пользователя
    Вкладка "Groups" при создании пользователя
    Вкладка "Policies" при создании пользователя
    Вкладка "Review" при создании пользователя
    Access Key и Secret Key
    Раздел "Хранилище" в MikoPBX
    Параметры для подключения S3 Wasabi
    Успешное подключение
    Провайдер OAuth2 - Microsoft/Outlook.
  • Идентификатор приложения (Client ID), Секретный ключ (Client Secret) - данные из Microsoft Entra.

  • Выдача разрешений и создание Client secret

    После истечения срока, созданный client secret перестанет функционировать и необходимо будет повторить процесс создания нового ключа и подключения к MikoPBX.

    После создания, значение Client Secret будет показано всего один раз. Не забудьте скопировать его в Web-интерфейс MikoPBX.

    Выдача разрешений пользователю

    Настройки внутри MikoPBX

    ссылка
    ссылка
    Параметры приложения
    Параметры Redirect URl
    Главная страница созданного приложения
    Раздел "API permissions"
    Добавление разрешения
    Выдача разрешения "SMTP.Send"
    Выдача разрешения "offline_access"
    Создание нового Secret ID
    Параметры для создания нового client secret
    Копирование Value созданного ранее Client secret
    Главная страница Microsoft Admin Center
    Раздел "Active Users" в Microsoft Admin Center
    Раздел "Mail" в учетной записи пользователя
    Разрешение Authenticated SMTP для выбранного пользователя
    Настройки SMTP в Web-интерфейсе MikoPBX
    Выдача запрошенных разрешений
    Успешная OAuth2 авторизация (Microsoft/Outlook)
    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "s3:PutObject",
            "s3:GetObject",
            "s3:DeleteObject",
            "s3:ListBucket"
          ],
          "Resource": [
            "arn:aws:s3:::имя-вашего-бакета",
            "arn:aws:s3:::имя-вашего-бакета/*"
          ]
        }
      ]
    }
    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "s3:PutObject",
            "s3:GetObject",
            "s3:DeleteObject",
            "s3:ListBucket"
          ],
          "Resource": [
            "arn:aws:s3:::YOUR-BUCKET-NAME",
            "arn:aws:s3:::YOUR-BUCKET-NAME/*"
          ]
        }
      ]
    }
    https://192.168.100.71/pbxcore/api/v3/mail-settings/oauth2-callback
    Флаг --net=host указывает на то, что NAT между хостом и контейнером не будет использоваться. MikoPBX будет подключена напрямую к сети хостовой машины. Все порты, которые должен занять контейнер будут заняты и на хост машине. Если на хост машине, какой-то из портов недоступн, то при загрузке MikoPBX возникнут ошибки. Подробнее в документации к Docker...
  • При необходимости можно скорректировать стандартный набор портов, которые использует MikoPBX. Это можно сделать, объявляя переменные окружения при запуске контейнера.

  • SIP_PORT - порт для подключения SIP клиента (5060)

  • TLS_PORT - порт для подключения SIP клиента с шифрованием (5061)

  • RTP_PORT_FROM - начало диапазона RTP портов, передача голоса (10000)

  • RTP_PORT_TO - конец диапазона RTP портов, передача голоса (10800)

  • IAX_PORT - порт для подключения IAX клиентов (4569)

  • AMI_PORT - порт AMI (5038)

  • AJAM_PORT - порт AJAM используется для подключения панели телефонии для 1С (8088)

  • AJAM_PORT_TLS - порт AJAM используется для подключения панели телефонии для 1С (8089)

  • BEANSTALK_PORT - порт для сервера очередей Beanstalkd (4229)

  • REDIS_PORT - порт для сервера Redis (6379)

  • GNATS_PORT - порт для сервера gnatsd (4223)

  • ID_WWW_USER - идентификатор пользователя www-user (можно задать выражением $(id -u www-user), где www-user имя НЕ root пользователя)

  • ID_WWW_GROUP - идентификатор группы www-user (можно задать выражением $(id -g www-user), где www-user имя НЕ root группы)

  • WEB_ADMIN_LOGIN - логин для доступа в Web интерфейс

  • WEB_ADMIN_PASSWORD - пароль для доступа в Web интерфейс

  • sudo docker logs mikopbx
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    |               All services are fully loaded welcome                |
    |                         MikoPBX 2026.1.223                         |
    |       built on Tue Apr 7 03:39:14 UTC 2026 (arm64) in Docker       |
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    |                        Web Interface Access                        |
    |                                                                    |
    | Local Network Address:                                             |
    | https://192.168.65.3                                               |                                             |
    |                                                                    |
    | Web credentials:                                                   |
    |    Login: admin                                                    |
    |    Password: admin                                                 |
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    | SSH access disabled!                                               |
    |                                                                    |
    ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
    # Загружаем образ из tar архива (Необходимо заранее его загрузить!)
    sudo docker load -i mikopbx-2026.1.223-x86_64-docker.tar
    
    # Запускаем созданный контейнер
    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:2026.1.223

    Шаг 2: Просмотр логов контейнера

    Шаг 3: Проверка доступа к веб-интерфейсу

    Особенности работы контейнизированной MikoPBX

    Создание контейнера из tar архива

    Переменные окружения для конфигурирования MikoPBX

    по ссылке
    Модуль резервного копирования
    Выберите файл из дистрибутива MikoPBX с расширением
    .raw
  • Введите название образа, например mikopbx_image

  • Завершив ввод значений, нажмите кнопку Создать образ

  • В поле Категория виртуальной машины выберите Все актуальные типы виртуальных машин
  • Укажите Тип виртуальной машины, исходя из ожидаемой нагрузки на АТС. Для тестовой машины можно указать STD2-1-1

  • Выберите Зону доступности

  • Включите переключатель Назначить внешний IP
    Укажите Источник - Пустой диск
  • Укажите Тип диска - Сетевой HDD-диск (ceph-hdd)

  • Выберите Зону доступности такую же, как и у инстанса

  • Укажите размер диска не менее 50Гб

  • Нажмите кнопку Создать группу
    Нажмите кнопку Сохранить правило

    Добавление ssh-rsa ключа

    Загрузка образа MikoPBX

    Создание инстанса

    Диск для хранения данных

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб для хранения записей разговоров

    Firewall

    Обязательно выполните настройку Firewall на самой АТС MikoPBX

    Запуск АТС MikoPBX

    Дождитесь окончания загрузки файла
    Введите имя образа (Name), например mikopbx-new-image
  • Укажите тип источника (Source) - Virtual disk (VMDK, VHD)

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

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

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

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

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

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

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

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

    Проверьте роли учетной записи службы Cloud Build, для этого

    1. Откройте страницу IAM https://console.cloud.google.com/projectselector2/iam-admin/iam

    2. Выберите свой проект Google Cloud

    3. Установите флажок Include Google-provided role grants

    4. В таблице найдите строку с адресом электронной почты, заканчивающимся на @cloudbuild.gserviceaccount.com

    5. Выберите Править (Edit principal)

    6. Роли, которые должны быть предоставлены учетной записи службы Cloud Build, - Сompute Admin и Service Account User

    Если нужных ролей нет, добавьте и нажмите SAVE

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

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

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

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб для хранения записей разговоров

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

    Обязательно выполните настройку Firewall на самой АТС MikoPBX

    Запуск АТС MikoPBX

    Выберите файл из дистрибутива MikoPBX с расширением
    .raw
  • Введите название образа, например mikopbx_image

  • Завершив ввод значений, нажмите кнопку Создать образ

  • В поле Категория виртуальной машины выберите Все актуальные типы виртуальных машин
  • Укажите Тип виртуальной машины, исходя из ожидаемой нагрузки на АТС. Для тестовой машины можно указать STD2-1-1

  • Выберите Зону доступности

  • Включите переключатель Назначить внешний IP
    Укажите Источник - Пустой диск
  • Укажите Тип диска - Сетевой HDD-диск (ceph-hdd)

  • Выберите Зону доступности такую же, как и у инстанса

  • Укажите размер диска не менее 50Гб

  • Нажмите кнопку Создать группу
    Нажмите кнопку Сохранить правило

    Добавление ssh-rsa ключа

    Загрузка образа MikoPBX

    Создание инстанса

    Диск для хранения данных

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб для хранения записей разговоров

    Firewall

    Обязательно выполните настройку Firewall на самой АТС MikoPBX

    Запуск АТС MikoPBX

    для хранения записей разговоров
    для хранения записей разговоров
    Нажмите Далее.
    1. Укажите размер основной памяти - 1024 МБ, а так же количество процессоров - 2

    Нажмите Далее.

    5. Выберите Создать новый виртуальный жесткий диск. Введите размер диска 700 МБ, а так же поставьте галочку у пункта "Выделить место в полном размере"

    Нажмите Создать.

    6. Подтвердите создание виртуальной машины: нажмите кнопку Готово.

    1. Перейдите к настройкам созданной виртуальной машины.

    Для этого нажмите Настроить.

    2. Перейдите на вкладку Носители. Добавьте новый жёсткий диск для хранения записей разговоров.

    3. В появившемся окне нажмите Создать.

    4. Формат жёсткого диска выберите - VDI (VirtualBox Disk Image).

    Нажмите Далее.

    5. Жёсткий диск должен быть фиксированного размера.

    Поставьте галочку рядом с пунктом "Выделить место в полном размере"

    Нажмите Далее.

    6. Укажите Имя создаваемого диска.

    Установите Размер диска порядка 50 ГБ.

    Нажмите Готово.

    7. Выделите вновь созданный диск и нажмите Выбрать.

    8. Созданный диск появиться в списке носителей.

    9. Смонтируйте на оптический диск образ MikoPBX. Для этого в разделе Носители выделите оптический диск и в разделе Атрибуты нажмите кнопку выбора файла образа.

    10. В появившемся меню нажмите Выбрать файл диска...

    11. Выберите скачанный ISO-образ диска и нажмите Открыть.

    12. Перейдите на вкладку «Сеть». Установите Тип подключения в значение Сетевой мост.

    Нажмите ОК для сохранения всех произведенных настроек.

    1. Запустите созданную виртуальную машину.

    2. Откроется командный интерфейс АТС. АТС начнет загружаться.

    На данном этапе MikoPBX загружается с оптического диска, на который записан ISO-образ. На это нам указывает строчка: "The system is loaded in Recovery mode".

    3. Переключите язык интерфейса на русский. Для этого выполните Change Language -> Русский. Меню примет вид.

    4. Произведите установку MikoPBX.

    Нажмите Выполнить установку.

    5. Отобразится информация о всех доступных дисках (в данном примере: sdb, sdc).

    6. Введите с клавиатуры имя диска, который вы подразумевали под "системный", в текущем случае sdb и нажмите Enter (Если он выбран по умолчанию можно просто нажать Enter).

    7. Система запросит подтверждение. Введите - y и нажмите Enter.

    8. После выполнения установки будет предложено выбрать диск для хранения записей разговоров.

    Введите имя диска (в данном примере - единственный доступный диск sdc) и нажмите Enter.

    9. После завершения установки система перезагрузится.

    Теперь MikoPBX будет запускаться с диска sdb, на который вы ее установили. Увидим, что строчка «The system is loaded in Recovery mode» отсутствует.

    На этом установка MikoPBX завершена.

    Для того, чтобы открыть панель управления вам надо вбить в строку браузера IP-адрес вашей виртуальной машины.

    Логин и пароль по умолчанию - admin

    На этом установка MikoPBX на завершена.

    Используйте для установки на VirtualBOX версии АТС MikoPBX ниже 2024.1.114

    Версия 2024.1.114 временно не поддерживает установку на VirtualBOX

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

    ссылке

    Настройка виртуальной машины

    Установка MikoPBX

    Перемещаться по пунктам меню можно .

    Выбрать пункт меню - клавиша Enter.

    Также можно выбирать пункт меню нажав на соответствующую пункту цифру.

    Все данные на диске, куда устанавливается MikoPBX, будут потеряны.

    Диск, на который будет установлена MikoPBX, называется системным (SYSTEM). В качестве системного диска можно выбрать диск, размер которого превышает 500 Мб.

    Ориентировочно, 1 час разговора занимает 14Мб места на диске.

    Первый вход в MikoPBX

    Необходимо создать новое хранилище. Для этого нажмите "Add Object Storage":

    Элемент "Add Object Storage"
    1. Выберите тип хранилища (рекомендуется использовать самый базовый, так как он нужен только для хранения файла образа диска). Так же укажите название.

    2. Перейдите в созданное хранилище, нажав на его название:

    Название хранилища
    1. Перейдите во вкладку "Buckets" и создайте новый Bucket с произвольным названием.

    Новый Bucket
    1. В информации о хранилище, будут указаны данные для S3 подключения.

    Данные для S3-подключения
    1. Далее необходимо подключиться к хранилищу через WinSCP. Для этого, перейдем в его интерфейс. Выберите "New Site":

    "New Site"
    1. Укажите следующие параметры:

    • "File protocol" - Amazon S3.

    • "Encryption" - TLS/SSL Implict encryption.

    • "Port number" - 443.

    • "Host Name", "Access key ID", "Secret access key" - параметры из информации о хранилище.

    Нажмите "Login".

    Параметры авторизации
    1. Загрузите файл образа диска в хранилище.

    Загрузка файла в хранилище
    1. Вернитесь в интерфейс Vultr, перейдите в директорию Вашего Bucket'а.

    Директория Bucket'а
    1. Нажмите на три точки справа от названия файла. Перейдите в раздел "Change Access". Разрешите доступ, переключив тумблер.

    Разрешение доступа
    1. Нажмите на три точки справа от названия файла. Скопируйте URL.

    Элемент "Copy URL"
    1. Перейдите в раздел "Orchestration" -> "ISOs":

    Раздел "ISOs"
    1. Нажмите "Add ISO":

    Элемент "Add ISO"
    1. Вставьте ссылку на ранее загруженный файл, нажмите "Upload".

    1. Перейдите в раздел "Account" -> "SSH Keys". Нажмите "Add SSH Key"

    Элемент "Add SSH Key"
    1. Сгенерируйте пару SSH ключей по инструкции.

    2. В интерфейсе добавления пары SSH-ключей введите произвольное название, а так же вставьте сгенерированный ключ.

    Нажмите "Add SSH Key".

    Добавление связки
    1. Перейдите в раздел "Products" -> "Compute":

    Раздел "Compute"
    1. Нажмите "Deploy Server":

    Элемент "Deploy Server"
    1. В открывшемся разделе выберите регион и конфигурацию вашей виртуальной машины.

    Параметры ВМ №1
    1. Перейдите далее.

    • Выберите "ISO/iPXE" -> Ранее загрузочный образ.

    • Так же выберите ранее созданную пару SSH-ключей.

    Нажмите "Deploy".

    Параметры ВМ №2

    После создания сервера, остановите его запуск.

    1. Перейдите в раздел "Cloud Storage" -> "Block Storage":

    Раздел "Block Storage"
    1. Нажмите "Add Block Storage":

    Элемент "Add Block Storage"
    1. Выберите тип диска, регион (такой же как у ранее созданной виртуальной машины), размер, а так же укажите произвольное название.

    1. Перейдите в раздел управления созданным диском. Прикрепите диск к созданной виртуальной машине используя пункт "Attach to:"

    Элемент "Attach to"
    1. Перейдите в меню управления виртуальной машиной.

    Меню управления виртуальной машиной
    1. Перейдите в консоль, нажав на соответствующий элемент.

    Элемент для открытия консоли
    1. Вы попадете во встроенную консоль.

    Встроенная консоль
    1. Перейдите в "[8] Install".

    2. Выберите диск, который будет использован в качестве системного. Подтвердите действия - введите "y" и нажмите "Enter":

    Выбор системного диска
    1. Выберите диск для хранения записей разговоров. Система перезагрузится.

    2. Перейдите в настройки виртуальной машины "Settings", далее в "Custom ISO". Нажмите "Remove ISO".

    Элемент "Remove ISO"

    На данном этапе система установлена и готова к работе!

    1. В адресную строку введите IP-адрес Вашей виртуальной машины. Найти его Вы можете в консоли MikoPBX.

    IP-адрес станции
    1. Введите следующие данные для авторизации:

    • Логин - admin

    • Пароь - ID-виртуальной машины. Оно имеет вид "150dd137-a0e2-45f6-baf9-ddc15a600d60", найти его Вы можете в адресной строке (скриншот ниже)

    ID виртуальной машины
    web-Интерфейс MikoPBX

    Инструкция актуальна для версии 2024.2.138 и новее!

    Загрузка образа в Vultr

    Загрузка файла в хранилище

    github MikoPBX
    Раздел "Object Storage"

    Импорт образа

    Добавление связки SSH-ключей

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

    Создание второго диска

    Рекомендуемый размер диска для хранения записей разговоров - не менее 50Гб.

    Установка системы

    Подключение к WEB-интерфейсу

    Для начала работы - выберите файл.

  • Установите лимит строк для выборки.

  • Установите офсет - значение сдвига в выборке.

  • Установите фильтр по вхождению строки в выборку.

  • Вкладка "Просмотр логов"

    Доступны следующие возможности:

    1. Cкачать полученную выборку в виде файла

    2. Обновить выборку

    3. Автоматическое обновление выборки

    Фильтры для просмотра логов

    Допустим необходимо проанализировать прохождение исходящего звонка на номер 74952293042

    1. Выберите файл для анализа asterisk/verbose.

    2. В качестве фильтра установите номер телефона 74952293042.

    3. В поле лимит укажите значение с запасом, к примеру 2000, иначе могут быть выданы не все записи лога.

    4. В последней строке выборке следует найти идентификатор:

    В данном примере ID = C-0000000f.

    1. Повторяем запрос лога, но уже с фильтром C-0000000f.

    2. Будет получен весь лог прохождения dialplan.

    3. Полученные данные можно отправить специалисту технической поддержки.

    В лог звонка также можно перейти из интерфейса истории звонков:

    После перехода по иконке "Лист" будет открыт интерфейс "Системные логи" с файлом "asterisk/verbose" и отбором по ID звонка:

    Данная вкладка отображает следующую информацию:

    • Сетевые настройки

    • Нагрузка на CPU

    • Потребляемая оперативная память

    • Настройки iptables

    Вкладка "Информация о системе"

    Данный раздел позволяет произвести детальный анализ ошибок в работе АТС.

    Вкладка "Захват сетевых пакетов"

    Вы можете запустить сбор сетевых пакетов, проходящих через сетевой интерфейс.

    1. Для запуска процесса нажмите кнопку "Старт".

    Элемент для начала фиксации сетевых пакетов
    1. Воспроизведите вашу проблему: совершите звонок или иное действие, приводящее к сбою / ошибке.

    2. Нажмите кнопку "Остановить и скачать".

    Кнопка остановки захвата сетевых пакетов

    Сетевые пакеты будут автоматически сохранены в архив MikoPBXLogs_log-tcpdump-XXXXXXXXXX. Также они должны автоматически сохраниться в папку Загрузки вашего браузера.

    Место сохранения сетевых пакетов

    Если в папке Загрузки архив найти не удалось , можете подключиться к АТС через WinSCP и скачать его из директории /storage/usbdisk1/mikopbx/tmp - файл log-tcpdump-XXXXXXXXXX.zip

    Вы можете скачать все накопленные на АТС системные логи. Для этого нажмите кнопку "Скачать все системные логи".

    Элемент для скачивания всех системных логов

    Системные логи будут автоматически сохранены в архив MikoPBXLogs_log-sys-XXXXXXXXXX.zip. Логи автоматически должны сохраниться в папку Загрузки вашего браузера. Так же данный архив с логами можно получить из каталога /storage/usbdisk1/mikopbx/tmp, подключившись к АТС при помощи WinSCP. Файл - log-sys-XXXXXXXXXX.zip

    • С помощью SSH-клиента

    • С помощью утилиты Wireshark

    • C помощью Sngrep (дамп звонка)

    • С помощью (дамп сетевого трафика)

    Просмотр логов

    Раздел "Диагностика системы" в MikoPBX
    3 вкладки в разделе
    [2023-03-18 16:28:17] VERBOSE[21654][C-0000000f] app_stack.c: Spawn extension (SIP-1676196499-22-outgoing, 74952293042, 13) exited non-zero on 'PJSIP/302-0000001a'

    Пример. Анализ звонка

    Информация о системе

    Захват сетевых пакетов

    Сбор сетевых пакетов

    Существует возможность воспользоваться поиском в WinSCP: в поле имени искомого файла ввести "log-tcpdump*", а в каталоге поиска ввести "/storage".

    Скачать все системные логи

    Будьте внимательны! При большом объеме звонков или прочей сетевой «нагрузки» на АТС логи могут занять довольно много места на диске.

    Другие способы снятия лога:

    Название правила можно задавать произвольным.

    В заметке можно описать маршрут звонка, который хотите реализовать, в дальнейшем это может помочь вам в отладке.

    Названия правила и заметка

    Задайте шаблон для исходящих звонков. Подробнее про шаблоны номеров в следующем параграфе.

    Указания шаблона номеров, попадающих под правило

    Приведенный на картинке выше пример означает следующее: если набранный номер начинается с "7" или "8", и остальная часть номера состоит 10 цифр.

    Преобразовать номер - данная настройка предназначена для удаления префикса номера и замены его на нужный префикс.

    Настройки преобразования номера

    В приведенном примере в начале номера не отсекаются цифры и не добавляются цифры.

    Выберите из списка провайдера, для которого настроили исходящую маршрутизацию и сохраните изменения.

    Выбор провайдера для правила
    Номер начинается с
    Остальная часть номера состоит из указанного количества цифр
    Примеры номеров

    [7-8]{1}

    10

    79257184255, 84952293042

    7925

    Например, номер +74952293042 должен быть преобразован к номеру 84952293042.

    Реализация правила выглядит следующим образом:

    Шаблон для замены +7 -> 8

    Например, номера 84952293042 и 74952293042 должны быть преобразованы к номеру +74952293042.

    Реализация правила выглядит следующим образом:

    Шаблон для замены 7,8 -> +7

    Например, номера 4952293042 и 4996382584 должны быть преобразованы к номеру 84952293042 и 84996382584 соответственно.

    Реализация правила выглядит следующим образом:

    Шаблон для преобразования номера

    Например, номера 84952293042 и 74996382584 должны быть преобразованы к номеру 2293042 и 6382584 соответственно.

    Реализация правила выглядит следующим образом:

    Шаблон для преобразования номера

    Создание правила

    Дополнительные примеры настройки исходящей маршрутизации доступны в разделе FAQ.

    Шаг 1. Добавление нового правила

    Раздел "Исходящие маршруты" в MikoPBX

    Шаг 2. Название и заметка

    Шаг 3. Задание шаблона номеров

    Если набираемый номер подходит под правила нескольких маршрутов, то вызов будет производится в порядке описания маршрутов, поочередно, пока вызов не будет отвечен, или пока подходящие маршруты не закончатся.

    Шаг 4. Преобразование номера

    Примеры преобразования номеров приведены , а так же .

    Шаг 5. Выбор провайдера

    Примеры

    Примеры шаблонов номеров

    Примеры изменения префиксов номеров

    Пример 1. Необходимо заменить префиксы номеров "+7" на "8".

    Пример 2. Необходимо заменить префиксы номеров "8", "7" на "+7".

    Пример 3. Необходимо добавить префикс "8" к номеру.

    Пример 4. Необходимо удалить код города "8495" или "7495", или "8499", или "7499" и оставлять 7-значный номер.

    Элемент для добавления нового правила исходящей маршрутизации

    Запустите сервер:

    Вы увидите следующий вывод с полезной информацией; в том числе адрес WebUI для дальнейшей удобной работой с хранилищем.

    После запуска оставьте окно терминала открытым — закрытие остановит сервер.

    Чтобы MinIO запускался автоматически при старте системы, выполните:

    brew services start minio/stable/minio
    1. Откройте браузер и перейдите по адресу WebUI.

    Введите учётные данные:

    • Username: minioadmin

    • Password: minioadmin

    Веб-интерфейс MiniO
    1. Нажмите "Create Bucket" в левом меню.

    Кнопка "Create Bucket" в Web-интерфейсе MiniO
    1. Введите имя бакета, например mikopbx-recordings.

    Нажмите "Create Bucket".

    Указание имени для создаваемого бакета

    Для создания access key и настройки прав доступа потребуется консольная утилита mc.

    Установите MinIO Client:

    После установки проверьте версию:

    Добавьте локальный MinIO-сервер как alias:

    Проверьте подключение:

    Если подключение выполнено успешно, в терминале появится информация о MinIO-сервере.

    Информация о MinIO-сервере

    Не рекомендуется использовать root-пользователя MinIO для подключения внешних приложений.

    1. Создайте отдельного пользователя для MikoPBX:

    1. Создайте файл политики:

    1. Добавьте в него содержимое:

    1. Сохраните файл:

    1. Создайте политику в MinIO:

    1. Назначьте политику пользователю:

    Создайте access key для пользователя mikopbx-user:

    В ответе MinIO отобразит данные доступа:

    Сохраните Access Key и Secret Key. Они понадобятся для подключения MinIO к MikoPBX.

    Secret Key отображается только при создании.

    1. Перейдите во вкладку "Обслуживание" -> "Хранилище".

    Раздел "Хранилище" в Web-интерфейсе MikoPBX
    1. Перейдите на вкладку "Облачное хранилище S3" и заполните следующие поля:

    • Автоматическая загрузка записей в облачное хранилище — включите переключатель.

    • Провайдер S3-хранилища — MinIO

    • URL точки доступа S3 — http://192.168.64.1:9000

    • Регион S3 — оставьте us-east-1 или введите любое значение (если не указали иное в параметрах MiniO)

    • Имя бакета S3 — укажите имя бакета, созданного в MiniO (mikopbx-recordings в этой инструкции)

    • Ключ доступа и Секретный ключ — вставьте значения, полученные в предедущей части этой инструкции (связка ключей).

    Настройте ползунок «Локальное хранение (режим S3)» — выберите, как долго записи будут храниться локально до удаления после выгрузки в облако.

    Нажмите «Сохранить».

    Параметры для подключения S3 MiniO

    После сохранения настроек нажмите "Проверить соединение". При успешном подключении появится сообщение «Соединение с S3 успешно» и начнется синхронизация записей телефонных разговоров.

    Успешное подключение к S3 бакету
    brew install minio/stable/minio
    🍺  /opt/homebrew/Cellar/minio/RELEASE.2025-09-06T17-38-46Z_1: 4 files, 108.2MB, built in 3 seconds
    mkdir -p ~/minio-data

    Установка MinIO на MacOS

    по ссылке
    MINIO_ROOT_USER=minioadmin MINIO_ROOT_PASSWORD=minioadmin \
      minio server ~/minio-data --console-address ":9001"
    MinIO Object Storage Server
    Copyright: 2015-2026 MinIO, Inc.
    License: GNU AGPLv3 - https://www.gnu.org/licenses/agpl-3.0.html
    Version: RELEASE.2025-09-06T17-38-46Z (go1.24.6 darwin/arm64)
    
    API: http://192.168.100.114:9000  http://192.168.64.1:9000  http://127.0.0.1:9000
       RootUser: minioadmin
       RootPass: minioadmin
    
    WebUI: http://192.168.100.114:9001 http://192.168.64.1:9001 http://127.0.0.1:9001
       RootUser: minioadmin
       RootPass: minioadmin
    
    CLI: https://docs.min.io/community/minio-object-store/reference/minio-mc.html#quickstart
       $ mc alias set 'myminio' 'http://192.168.100.114:9000' 'minioadmin' 'minioadmin'
    
    Docs: https://docs.min.io
    brew install minio/stable/mc
    mc --version
    mc alias set local http://127.0.0.1:9000 minioadmin minioadmin
    mc admin info local
    mc admin user add local mikopbx-user 'strong-password'
    nano mikopbx-recordings-policy.json
    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "s3:ListBucket",
            "s3:GetBucketLocation"
          ],
          "Resource": [
            "arn:aws:s3:::mikopbx-recordings"
          ]
        },
        {
          "Effect": "Allow",
          "Action": [
            "s3:PutObject",
            "s3:GetObject",
            "s3:DeleteObject"
          ],
          "Resource": [
            "arn:aws:s3:::mikopbx-recordings/*"
          ]
        }
      ]
    }
    Ctrl + O
    Enter
    Ctrl + X
    mc admin policy create local mikopbx-recordings-rw mikopbx-recordings-policy.json
    mc admin policy attach local mikopbx-recordings-rw --user mikopbx-user
    mc admin accesskey create local/ mikopbx-user
    Access Key: A6FMEQOVJAK7K6TUI5O4
    Secret Key: HuKLsNh7hmS+3xdLzlpYaFjxu5wVxLPkM8XUTgsj
    Expiration: NONE
    Name: 
    Description: 

    Создания бакета в MinIO

    Подключение MinIO Client к локальному серверу

    Параметры здесь:

    • local — произвольное имя подключения

    • http://127.0.0.1:9000 — API-адрес MinIO.

    Создание пользователя и политики доступа к бакету

    Замените strong-password на надёжный пароль.

    Создание Access Key для MikoPBX

    Подключение к MikoPBX

    Более короткое локальное хранение быстрее освобождает дисковое пространство.

    клавишами управления курсором
    буквенно-цифровом блоке клавиатуры

    AWS Подробная инструкция

    Установка MikoPBX в AWS с помощью произвольного образа

    Авторизуйтесь в сервисе Amazon Web Services

    Для выполнения инструкций установите утилиту командной строки Amazon, для этого откройте Терминал и введите в командной строке

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

    1. Перейдите к своему аккаунту

    2. В выпадающем меню выберите Security credentials

    Alibaba cloud

    Установка MikoPBX с помощью сервиса Alibaba cloud

    В данной инструкции мы пошагово произведем установку MikoPBX с помощью облачной платформы Alibaba cloud.

    Перед началом Вам необходимо скачать актуальный образ MikoPBX с расширением .raw. Сделать это можно на .

    Для начала необходимо создать bucket для хранения образа. Для этого необходимо перейти в "OSS Management Console" ().

    1. Перейдите в раздел "Buckets".

    Кастомизация системных файлов

    Описание возможностей раздела "Кастомизация системных файлов"

    Раздел «Кастомизация системных файлов» в MikoPBX предоставляет администраторам возможность напрямую изменять или дополнять стандартные конфигурационные файлы системы. Здесь вы можете внести индивидуальные настройки, которые не доступны через стандартный веб-интерфейс, и адаптировать поведение системы под специфические требования вашей организации.

    С его помощью можно:

    • Редактировать конфигурационные файлы: вносить изменения в существующие файлы или добавлять новые параметры.

    • Переопределять стандартные настройки

    приложения tcpdump

    оставьте поле пустым

    79257184255, 7925, 7925718…

    7ХХ

    0

    700, 701, 702…

    74952293042

    0

    74952293042

    74(95|99)

    7

    74952293042, 74996382584…

    (7|8)0{1}

    1

    700, 701, 802, 803…

    (25|26)

    0

    25, 26

    [0-9]{1}

    0

    цифра от 0 до 9-ти, вхождение один раз

    [1-5]{2}

    0

    12, 15, 14, 25 цифра от 1 до 5-ти, вхождение два раза

    [8-9]+

    0

    8899, 888, 988888 цифра от 8 до 9-ти, вхождение от одного и более раз

    в следующем параграфе
    в разделе FAQ

    minioadmin — root-пользователь

  • minioadmin — root-пароль

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

    1. В таблице Access keys выберите Create access key

    2. Скопируйте Access key и Secret access key

    Если у вас есть ключ доступа, скопируйте Access key и Secret access key

    1. Откройте Services / Storage / S3

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

    3. Введите уникальное имя бакета (Bucket name)

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

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

    1. Откройте созданный бакет и выберите Upload

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

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

    4. Нажмите кнопку Upload

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

    Если для данного облака не выполнялось, сделайте один раз

    1. Создайте отдельную папку для файлов на компьютере

    2. Создайте в папке файл trust-policy.json

      1. Откройте Терминал и перейдите к созданной папке

      2. Выполните команду vi trust-policy.json

      3. Перейдите в режим редактирования, нажав i, вставьте текст

      4. Нажмите ESC и напишите :wq, чтобы записать файл

    1. Аналогично создайте файл role-policy.json, измените значение имени бакета в тексте на имя созданного вами бакета

    1. Аналогично создайте файл import-image.sh, измените значения параметра DEFAULT_BUCKET на имя созданного вами бакета и параметра DEFAULT_IMAGE на имя образа, загруженного в бакет

    1. Выполните команду aws configure, укажите регион и скопированные ключи Access key и Secret access key

    1. Выполните команду

    1. Выполните команду

    1. Выполните команду

    В случае успешного выполнения команды будет сформирован уникальный идентификатор образа AMI

    1. Откройте Services / Compute / EC2 и перейдите в раздел Images / AMIs

    2. Выберите созданный образ и нажмите кнопку Launch an instance form AMI для создания виртуальной машины

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

    1. Укажите тип машины (Instance type) - t3.micro

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

    1. Укажите SSH ключ в поле Key pair

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

    1. Выберите Create new key pair и укажите имя пары ключей (Key pair name), например mikopbx_key

    Следуйте дальше по инструкции

    1. В разделе Network settings установите флажки Allow SSH traffic и Allow HTTPS traffic

    1. При необходимости измените размер диска для хранения данных в разделе Configure storage, по умолчанию его размер - 50Гб

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

    2. Нажмите кнопку Launch instance

    1. Перейдите к созданной виртуальной машине mikopbx-vm

    2. На открытой вкладке выберите Connect / EC2 serial console, дождитесь полной загрузки системы, пока не отобразятся параметры авторизации

    1. Скопируйте внешний адрес созданной виртуальной машины и введите его в строке браузера

    2. Для входа используйте указанные в EC2 serial console логин и пароль

    curl "https://awscli.amazonaws.com/AWSCLIV2.pkg" -o "AWSCLIV2.pkg" 
    sudo installer -pkg AWSCLIV2.pkg -target /

    Для быстрого и удобного поиска в сервисе Amazon используйте панель поиска

    Копирование ключей доступа

    https://aws.amazon.com
    vi trust-policy.json
    {
    "Version": "2012-10-17",
        "Statement":
        [
            {
                "Effect": "Allow",
                "Principal": { "Service": "vmie.amazonaws.com" },
                "Action": "sts:AssumeRole",
                "Condition": {
                    "StringEquals":{"sts:Externalid": "vmimport"}
                }
            }
        ]
    }
    {
        "Version":"2012-10-17",
        "Statement":
        [
            {
            "Effect": "Allow",
            "Action": [
                "s3:GetBucketLocation",
                "s3:GetObject",
                "s3:ListBucket"
                ],
            "Resource": [
                "arn:aws:s3:::mikopbx-bucket",
                "arn:aws:s3:::mikopbx-bucket/*"
                ]
            },
            {
            "Effect": "Allow",
            "Action": [
                "ec2:ModifySnapshotAttribute",
                "ec2:CopySnapshot",
                "ec2:RegisterImage",
                "ec2:Describe*"
            ],
            "Resource": "*"
            }
        ]
    }
    #!/bin/bash
    
    # Определение переменных по умолчанию
    DEFAULT_IMAGE="mikopbx-2024.1.40-dev-x86_64.raw"
    DEFAULT_BUCKET="mikopbx-bucket"
    DEFAULT_DESCRIPTION="MikoPBX the best open source PBX on asterisk"
    DEFAULT_NAME="MikoPBX 2024.1.40-dev"
    
    # Переопределение переменных значениями переменных окружения, если они установлены
    IMAGE="${IMAGE:-$DEFAULT_IMAGE}"
    BUCKET="${BUCKET:-$DEFAULT_BUCKET}"
    DESCRIPTION="${DESCRIPTION:-$DEFAULT_DESCRIPTION}"
    NAME="${NAME:-$DEFAULT_NAME}"
    
    # Файл JSON для команды import-snapshot
    JSON_FILE="disk_container.json"
    
    # Создание файла JSON
    cat <<EOF> ${JSON_FILE}
    {
      "Description": "${DESCRIPTION} image",
      "Format": "raw",
      "UserBucket": {
    	"S3Bucket": "${BUCKET}",
    	"S3Key": "${IMAGE}"
      }
    }
    EOF
    
    # Импорт снимка
    IMPORT_TASK_ID=$(aws ec2 import-snapshot --description "${DESCRIPTION} image" --disk-container "file://${JSON_FILE}" --query 'ImportTaskId' --output text)
    
    echo "Import task started with ID: $IMPORT_TASK_ID"
    
    # Ожидание завершения импорта снимка
    while true; do
    	STATUS=$(aws ec2 describe-import-snapshot-tasks --import-task-ids $IMPORT_TASK_ID --query 'ImportSnapshotTasks[0].SnapshotTaskDetail.Status' --output text)
    	echo "Current status: $STATUS"
    	if [ "$STATUS" == "completed" ]; then
    		break
    	fi
    	sleep 30
    done
    
    # Получение SnapshotId
    SNAPSHOT_ID=$(aws ec2 describe-import-snapshot-tasks --import-task-ids $IMPORT_TASK_ID --query 'ImportSnapshotTasks[0].SnapshotTaskDetail.SnapshotId' --output text)
    
    # Регистрация AMI
    AMI_ID=$(aws ec2 register-image \
    	  --name "$NAME" \
    	  --description "$DESCRIPTION" \
    	  --architecture x86_64 \
    	  --sriov-net-support simple \
    	  --virtualization-type hvm \
    	  --ena-support \
    	  --boot-mode legacy-bios \
    	  --root-device-name "/dev/sda1" \
    	  --block-device-mappings "[{\"DeviceName\": \"/dev/sda1\", \"Ebs\":{\"DeleteOnTermination\":true, \"VolumeSize\":1, \"SnapshotId\":\"$SNAPSHOT_ID\"}}, {\"DeviceName\": \"/dev/sdb\", \"Ebs\":{\"VolumeSize\":50}}]" \
    	  --query 'ImageId' \
    	  --output text)
    
    echo "AMI created with ID: $AMI_ID"
    aws configure
    aws iam create-role --role-name vmimport --assume-role-policy-document "file://trust-policy.json"
    aws iam put-role-policy --role-name vmimport --policy-name vmimport --policy-document "file://role-policy.json"
    sh import-image.sh

    Создание бакета

    Добавление прав и прикрепление политик

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

    По умолчанию весь входящий трафик к EC2 в AWS запрещен, в том числе и SIP трафик. После создания ВМ не забудьте настроить security group к которой она прикреплена (разрешить необходимый трафик).

    Для развертывания АТС используйте два диска:

    • диск объемом 1 Гб для основной системы

    • диск объемом 50+ Гб

    Запуск АТС MikoPBX

    Обязательно выполните настройку Firewall на самой АТС MikoPBX

  • Нажмите "Create Bucket" для создания нового Bucket'а:

  • Элемент "Create bucket"
    1. Заполните следующие данные:

    • "Bucket name" - произвольное название для хранилища.

    • "Region" - выберите регион, где будет храниться ваш образ

    Нажмите "OK".

    Параметры Bucket'а
    1. Перейдите в созданный bucket, нажав на его название в разделе "Buckets":

    Созданный bucket
    1. Нажмите "Upload object" и загрузите ранее скаченный файл образа диска в формате .raw (все параметры оставьте по умолчанию).

    Элемент "Upload object"
    1. После того, как файл образа диска будет загружен, Вам необходимо скопировать ссылку на него. Для этого нажмите "View Details" справа от названия файла, в открывшемся меню скопируйте ссылку из поля "URL".

    Ссылка на файл образа диска
    1. Вернитесь в ECS Console (ссылка). Перейдите в раздел "Images".

    Раздел "Images"
    1. Нажмите "Import Image" для испорта образа из хранилища (Bucket):

    Элемент "Import Image"
    1. В открывшейся вкладке выберите "Linux Operating System" и нажмите "Next".

    2. Введите/выберите следующие параметры для образа:

    • "Image File URL" - вставьте ранее скопированную ссылку на загруженный файл образа диска.

    • "Image Name" - введите произвольное, уникальное название для Вашего образа.

    • "OS Type" - linux

    • "OS Version" - Others Linux

    • "Architecture" - 64-bit OS

    • Уберите галочку с чек-бокса "Check After Import".

    Нажмите "OK" для создания образа. Дождитесь его создания (при завершении в поле Status вы увидите надпись Available)

    Параметры импорта образа

    Далее необходимо создать и добавить связку SSH ключей в Alibaba Cloud.

    1. В ESS Консоли перейдите в раздел "Network Security" -> "Key Pairs":

    Раздел "Key Pairs"
    1. Нажмите "Create SSH Key Pair".

    Элемент "Create SSH Key Pair"
    1. Далее необходимо сгенерировать пару SSH-ключей. Про то как это сделать - Вы можете прочитать здесь. Далее заполните все необходимые данные:

    • "Name" - произвольное название для создаваемой связки ключей

    • "Creation Mode" - Import

    • "Public Key" - вставьте Ваш публичный ключ, сгенерированный ранее

    • "Resource Group" - выберите Вашу ресурсную группу в облаке

    Нажмите "OK" для создания связки ключей в облаке

    Параметры создаваемой связки ключей

    Перед созданием виртуальной машины так же нужно создать и группу правил (firewall).

    1. Перейдите в раздел "Network & Security" -> "Security Groups"

    Раздел "Security Groups"
    1. Нажмите "Create Security Group":

    Элемент для создания новой группы правил
    1. Укажите следующие параметры для группы правил:

    • "Security Group" - введите произвольное название для группы правил.

    • "Network" - выберите вашу сеть. Если она не созданна - нажмите "Create VPC" справа от поля.

    • "Security Group" - Basic Security Group.

    • "Resource Group" - выбрите Вашу группу ресурсов.

    • Разрешите все входящие подключения (пример на скриншоте ниже). Все исходящие подключения разрешены по умолчанию.

    Нажмите "Create Security Group".

    Параметры группы правил
    1. Перейдите в раздел "Instances & Images" -> "Instances":

    Раздел "Instances"
    1. Нажмите "Create Instance" для создания новой виртуальной машины.

    Элемент "Create Instance"
    1. Выберите параметры для вашей виртуальной машины:

    • "Billing Method" - выберите вариант оплаты ВМ.

    • "Region", "Network and Zone" - выберите параметры региона и зоны, подходящие Вам.

    • "Instance" - выберите конфигурацию Вашей виртуальной машины.

    Параметры виртуальной машины №1
    1. Выберите параметры для вашей виртуальной машины:

    • "Image" - выберите "Custom Images" -> Загруженный ранее образ

    • "Storage" - выберите тип и размер "System Disk". 20 Гб - минимально возможный в Alibaba Cloud.

    • Добавьте второй диск, нажав "Add Data Disk". Укажите его тип и размер.

    Параметры виртуальной машины №2
    1. Выберите параметры сети для Вашей ВМ. Группа правил будет назначена автоматически (ранее созданная):

    Параметры сети
    1. Нажмите "Create Order".

    Элемент "Create Order"

    В разделе "Instances" перейдите к созданной виртуальной машине, нажав на ее название.

    Переход к созданной виртуальной машине
    1. Нажмите "Connect".

    Элемент "Connect"
    1. Выберите "VNC". Произойдет подключение в новой вкладке Вашего браузера.

    VNC консоль

    Введите следующую команду для SSH-подключения:

    Замените C:\Users\username\.ssh\id_ed25519 на путь к ssh-ключам; root- на Ваше имя для ssh-авторизации (если оно было изменено при создании ВМ); ip-adress - на Внешний адрес MikoPBX.

    Команда для ssh-подключения

    Произойдет подключение по SSH:

    SSH-подключение

    На главной странице виртуальной машины находятся несколько важных параметров для авторизации в WEB-интерфейсе.

    Важные параметры для авторизации в web-интерфейс

    Вставьте IP-адрес в адресную строку браузера - Вы попадете на страницу авторизации в web-интерфейс MikoPBX.

    WEB-интерфейс MikoPBX

    Инструкция актуальна для версии 2024.2.135 и новее!

    Загрузка образа в Alibaba cloud

    Создание Bucket

    github MikoPBX
    ссылка
    OSS Консоль
    Раздел "Buckets"
    ssh -i C:\Users\username\.ssh\id_ed25519 root@ip-adress

    Регион у хранилища для образа и регион виртуальной машины должны совпадать!

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

    Создание пары SSH-ключей

    Создание группы правил

    Обязательно настройте firewall в самой MikoPBX как можно раньше после создания виртуальной машины. Подробнее про то как это сделать, Вы можете прочитать .

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

    Рекомендуемый размер диска для хранения записей разговора - не менее 50ГБ. В данной инструкции, в качестве примера, используется диск размером 30ГБ.

    Подключение к консоли MikoPBX

    Подключение из встроенной в облако консоли

    Подключение по SSH

    Подробнее про SSH-подключения Вы можете узнать . В данной документации, в качестве примера будет продемонстрировано подключение по SSH через PowerShell.

    Первая авторизация в WEB-интерфейсе

    Данные для входа:

    • Username - admin

    • Password - ID Вашей виртуальной машины

    : изменять значения по умолчанию для определенных функций или модулей.
  • Добавлять собственные скрипты или модули: расширять функциональность системы путем интеграции пользовательских решений.

  • Он находится в Система -> Кастомизация системных файлов:

    Раздел "Кастомизация системных файлов"

    Важно отметить, что неправильное изменение системных файлов может привести к нестабильной работе или сбоям системы. Поэтому рекомендуется создавать резервные копии перед внесением изменений и тщательно проверять корректность настроек.

    Мы рекомендуем использовать возможности данного раздела только опытным администраторам Asterisk. В MikoPBX есть возможность из web-интерфейса изменять следующие конфигурационные файлы:

    Наименование файла

    Описание

    asterisk.conf

    Общие (глобальные) настройки Asterisk. В файле конфигурации asterisk.conf Вы определяете следующее: -Местоположение, права доступа и владельца сокета, которые используется для подключения удаленной консоли управления сервером. Местоположение различных директорий, используемых сервером Asterisk для определения местоположения файлов конфигурации, библиотек, скриптов и место, где будут создаваться лог фалы. Параметры командной строки запуска сервера, используемые по умолчанию.

    cel.conf

    Лог событий канала. В отличии от CDR, сохраняет все события имевшие место в канале.

    extensions.conf

    План набора (dialplan) Asterisk. В нем определяется обработка и маршрутизация входящих и исходящих вызовов. Этот файл управляет поведением всех соединений, проходящих через Вашу АТС.

    Для редактирования конфигурационного файла воспользуйтесь кнопкой:

    Перед Вами будет открыта форма редактирования конфигурационного файла:

    Меню кастомизации системного файла /acl.conf (пример)

    Выберите один из четырех возможных вариантов редактирования:

    • «Не менять» - не позволяет вносить изменения в файл, только чтение файла.

    • «Добавлять в конец файла» - в конец выбранного конфигурационного файла будут добавлены (рекомендуемый).

    • «Заменять полностью» - все Ваши изменения переопределят конфигурационный файл.

    • Режим "Script" - читайте далее.

    Существуют сценарии, когда нужно выполнить более сложные модификации системных файлов, чем простое добавление текста в конец конфигурационного файла. Например, нужно выполнить переопределение параметров PJSIP учетных записей, но хочется сохранить возможность настройки системы через веб интерфейс.

    Реализован новый подход к кастомизации. Можно описать bash скрипт, который будет выполняться каждый раз после того, как система сформирует конфигурационный файл. В итоге интегратор сможет делать очень тонкие изменения конфигурационных файлов без разработки дополнительных модулей.

    Например, мы хотим поменять значение max_contacts у всех сотрудников, кроме одного.

    Кастомизация файлов "скриптом"

    Добавить параметры к существующей секции возможно используя конструкцию (+):

    Описать новую секцию можно в произвольной форме, единственное, не следует допускать повторения имен секций: Пример:

    Существует возможность перехватить выполнения dialplan. Для этого необходимо описать custom контексты. На текущий момент можно перехватить выполнения в следующих контекстах:

    • internal-originate-custom - контекст используется при звонках из панели телефонии для 1С

    • <ID-ПРОВАЙДЕРА>-incoming-custom - контекст предназначен для обработки входящих вызовов через провайдера

    • <ID-ПРОВАЙДЕРА>-outgoing-custom - контекст предназначен для обработки исходящих вызовов через провайдера

    • all_peers-custom - контекст используется при прямом исходящем звонке с телефона

    • outgoing-custom - контекст используется при наборе внешнего номера, ДО выбора исходящего маршрута

    • add-trim-prefix-clid-custom - этот контекст используется при обработке входящих вызовов, лучшим образом подходит для нормализации входящего номера телефона, добавить / отсечь префикс

    • internal-users-custom - в этом контексте обрабатываются вызовы на внутренние номера

    • public-direct-dial-custom - контекст обработки входящих вызовов БЕЗ авторизации

    Пример контекста:

    Обязательно следует в конце вызывать метод «return».

    [general](+)
    allowtransfer=yes
    [user2_pingtel]
    type=friend
    username=user2_pingtel
    secret=blah
    host=dynamic
    qualify=1000 ; Рассматриваем клиента как неработающего,
    ; если ответ от него идет более 1 сек.
    callgroup=1,3-4 ; Клиент является членом групп вызовов: 1, 3 и 4
    pickupgroup=1,3-4 ; Мы можем совершать "pick-up" вызовов, нажатием *8,
    ; для вызовов из групп 1, 3 и 4
    defaultip=192.168.0.60
    disallow=all
    allow=ulaw
    allow=alaw
    allow=g729
    [outgoing-custom]
    exten => _X!,1,NoOp(--- hangup - ${CHANNEL} ---)
    	same => n,return

    Кастомизация системных файлов скриптом

    sip.conf

    extensions.conf

    Дорабатывайте dialplan с осторожностью - есть большая вероятность нарушить работу АТС!

    Некоторые примеры использования custom-контекстов:

    • Настройка исходящего AOH для сотрудника

    клавишами управления курсором
    буквенно-цифровом блоке клавиатуры

    Очереди вызовов

    Создание и настройка очередей вызовов.

    Очереди позволяют:

    1. Распределять телефонные звонки между группой сотрудников (агентов): Вы можете создать очередь вызовов и добавить в нее несколько сотрудников. Когда поступает звонок, система автоматически направляет его к доступному сотруднику в очереди, обеспечивая более равномерное распределение нагрузки и повышая эффективность обработки вызовов.

    2. Удерживать клиента на линии, если все сотрудники заняты: Если все сотрудники в очереди заняты обработкой других вызовов, клиент будет удерживаться на линии, пока не освободится один из сотрудников. Это помогает избежать потери вызовов и обеспечивает более качественное обслуживание клиентов.

    3. Оповещать клиента о позиции в очереди и приблизительном времени ожидания: При нахождении клиента в очереди система может предоставлять информацию о его текущей позиции в очереди и ориентировочное время ожидания. Это помогает удержать клиента в курсе ситуации и улучшает его опыт общения.

    4. Передавать на телефон сотрудника имя очереди, вместе с номером клиента: Когда сотрудник принимает вызов из очереди, на его телефоне отображается не только номер клиента, но и имя соответствующей очереди. Это помогает сотруднику более эффективно обрабатывать вызовы и предоставлять персонализированное обслуживание.

    Для настройки очередей вызовов в MikoPBX следует перейти в раздел "Телефония" и выбрать "Очереди вызовов". Здесь вы сможете создать и настроить свои очереди в соответствии с требованиями вашего бизнеса и потребностями обслуживания клиентов.

    Для добавления новой очереди выполните действие Создать новую очередь.

    • Укажите Название очереди - при настройке маршрутизации вы будете ориентироваться на него.

    • Заполните описание в поле Заметка - оно будет доступно в списке очередей.

    В разделе Операторы очереди можно добавить произвольное число сотрудников (агентов очереди) и указать стратегию распределения вызовов.

    "Вызов поступает на любого свободного участника очереди кроме участника, обработавшего последний вызов" - эта стратегия также именуется как "rrmemory" - Round Robin Memory.

    АТС помнит, кому был направлен последний вызов, и следующий вызов отправляется следующему оператору в списке.

    Порядок списка сотрудников можно определить в разделе "Операторы очереди", перетаскиванием можно переместить оператора вверх или вниз.

    Пример:

    Если у вас описаны: Оператор1, Оператор2, Оператор3, и последний вызов был направлен Оператор2, то следующий вызов пойдёт Оператор3, потом Оператор1, и т.д. — в цикле, не с начала, а с "места остановки".

    "Время попытки дозвона операторам" - для данной стратегии параметр определяет длительность попытки звонка оператору. Если оператор не ответил, то АТС пытается звонить следующему доступному согласно условиям стратегии.

    Вызов поступает одновременно на всех участников очереди, включая тех, кто занят (по умолчанию) - также эта стратегия именуется как "ringall"

    АТС будет инициировать вызов всем оператором очереди одновременно. Следует учитывать, что скорость поступления вызову оператору зависит от сети предприятия. Пример:

    Если в очереди определены операторы

    • Оператор с внутренним номером, подключен стационарный IP телефон в локальной сети - вызов поступит мгновенно

    • Оператор с внутренним номером, подключен софтфон на смартфон через LTE - вызов поступит с задержкой

    • Оператор с мобильным номером - вызов поступит со значительной задержкой 5-8 секунд

    Задержка поступления вызова связана с особенностями внешних сетей (относительно предприятия), но начало вызова происходит одновременно.

    "Время попытки дозвона операторам" - спустя это время вызов всем операторам завершится и инициируется новый вызов.

    Вызов поступает на участника очереди, который дольше всех не принимал звонки - также эта стратегия именуется как "leastrecent"

    Каждый новый вызов направляется оператору, который дольше всех не принимал вызовов, анализируется только последний отвеченный вызов.

    Пример:

    • 101 — последний вызов: 10:00

    • 102 — последний вызов: 10:05

    • 103

    Как "Время попытки дозвона операторам" = 20 влияет на вызов:

    1. АТС набирает номер 103 (он дольше всех не принимал вызов).

    2. Проходит 20 секунд → оператор не ответил.

    3. АТС считает, что агент недоступен, и НЕ обновляет время последнего вызова (вызов не был принят!)

    4. Очередь выбирает снова 103 (он дольше всех не принимал вызов).

    ⚠️ Ключевой момент: если агент не ответил — он всё ещё считается "не занятым", и может быть выбран снова в ближайшем будущем, потому что его "время последнего вызова" не обновилось.

    Счетчик отвеченных вызовов сбрасывается при перегрузке АТС.

    Вызов поступает на участника очереди, который обработал меньше всего звонков - также эта стратегия именуется как "fewestcalls"

    Каждый новый вызов направляется оператору, который меньше всех принимал вызовов, анализируется только количество отвеченных вызов.

    Пример:

    • 101 — всего вызов: 1 ← меньше всего вызовов

    • 102 — всего вызов: 5

    Счетчик отвеченных вызовов сбрасывается при перегрузке АТС.

    Как "Время попытки дозвона операторам" = 20 влияет на вызов:

    1. АТС выбирает 101 (меньше всех обработал вызов).

    2. Проходит 20 секунд → оператор не ответил.

    3. АТС считает, что агент недоступен, и НЕ обновляет количество вызовов (вызов не был принят!),

    4. Очередь выбирает снова 101 (меньше всех обработал вызов).

    ⚠️ Ключевой момент: если агент не ответил — он всё ещё считается "не занятым", и может быть выбран снова в ближайшем будущем, потому что его "количество отвеченных вызовов" не обновилось.

    Вызов поступает на любого свободного участника очереди - также эта стратегия именуется как "random" - вызов случайного оператора.

    "Время попытки дозвона операторам" - спустя это время вызов оператору завершится и инициируется вызов на следующего произвольного сотрудника

    Также эта стратегия именуется как "linear".

    Пример операторов:

    • 101 ← вызов всегда будет поступать сперва на этого сотрудника

    • 102 - спустя "Время попытки дозвона операторам" вызов оператору завершится и инициируется вызов на следующего

    • 103

    Также эта стратегия именуется как "linear_progressive".

    Вызов начинает поступать первому участнику очереди. Через интервал, указанный в поле Время попытки дозвона операторам, к вызову добавляется следующий участник, при этом предыдущие продолжают звонить. Так очередь постепенно расширяет круг операторов, пока кто-либо не ответит или не сработает общий таймаут из Сценария 1.

    Пример:

    • 101 - звонит сразу;

    • 102 - начинает звонить через 20 секунд;

    • 103 - начинает звонить через 40 секунд.

    В этом разделе можно дополнительно указать:

    • Номер телефона для этой очереди - по этому номеру можно позвонить на очередь с любого внутреннего номера сотрудника. Также на этот номер можно перевести вызов.

    • Краткое название очереди - для отображения перед CallerID абонента на телефонном аппарате, например consult.

    • Время попытки дозвона агенту - время в секундах, в течение которого вызов будет идти на одного агента очереди. По завершении этого времени вызов агенту сохраняется в историю звонков как пропущенный. По завершении времени попытки дозвона до одного агента вызов направится на следующего агента согласно выбранной стратегии.

    • Время отдыха агента после обработки вызова, перед тем как начать принимать новые звонки - время в секундах, которое отсчитывается с момента завершения разговора агентом очереди до момента поступления нового телефонного звонка агенту.

    • Получать новые звонки во время разговора

    • Что абонент слышит во время ожидания - во время ожидания ответа на свой звонок клиент может слышать музыку на удержании или сигнал вызова.

    • Фоновая музыка (MOH) - можно указать уникальный звуковой файл для воспроизведения клиенту во время ожидания, к примеру рекламные материалы.

    • Оповещать о текущей позиции в очереди - если все операторы (агенты очереди) заняты, то включив этот переключатель, можно оповестить клиента о его позиции в очереди. Если активирована опция Дополнительный звуковой анонс, то этот анонс дополнит информацию о позиции.

    • Сценарий 1 - в данном сценарии можно настроить максимально допустимое время ожидания клиента в очереди. Если в течение заданного времени никто из агентов очереди не смог ответить клиенту, вызов будет перенаправлен на выбранный номер. Если номер переадресации не выбран, общий таймаут очереди не применяется.

    • Сценарий 2 - если в очереди нет агентов (то есть в данный момент ни один агент не зарегистрирован на АТС), то можно указать номер, на который будет переведен вызов клиента.

    Внешний файрвол для Docker

    ℹ️ Возможность доступна начиная с версии MikoPBX 2026.2.76. На более ранних версиях LAPI-эндпоинт firewall-bouncer, баннер на странице файрвола и кнопка «Токен для bouncer» отсутствуют.

    В Docker-режиме MikoPBX внутренние правила файрвола и fail2ban не защищают веб-интерфейс:

    • Контейнер не управляет iptables хоста.

    Провайдеры телефонии

    Подключение и настройка провайдеров телефонии в MikoPBX

    «Провайдеры телефонии» в MikoPBX — это раздел системы, где настраиваются подключения к внешним операторам связи через интернет-протоколы для IP-телефонии. Здесь администраторы могут добавлять и настраивать учетные записи SIP-транков или других типов соединений, которые позволяют системе совершать и принимать звонки с городских и мобильных номеров.

    Чтобы совершать или принимать внешние телефонные звонки по телефонной сети общего пользования или Интернет, вы должны создать, по крайней мере, одну учетную запись провайдера. Каждая технология имеет свой тип учетной записи. Для добавления новой учетной записи или изменения существующей, перейдите в "Маршрутизация" -> "Провайдеры телефонии":

    Обзор провайдеров содержит список всех доступных поставщиков услуг. Зеленый значок перед именем поставщика означает, что MikoPBX зарегистрировала этого провайдера, и Вы можете начать работу с этим провайдером. С помощью переключателя слева можно включать использование провайдера и отключать соответственно:

    Приложения диалпланов

    Создание и настройка приложений диалплана

    Приложения диалпланов - это программируемые голосовые приложения на PHP и Asterisk Dialplan. MikoPBX поставляется с несколькими предварительно сконфигурированными приложениями. С некоторыми базовыми знаниями планов набора Asterisk можно легко создавать дополнительные приложения. Как и учетная запись телефона, приложения могут иметь внутренний номер, присвоенный в настройках.

    Ниже вы увидите описание базовых приложений, включенных в MikoPBX:

    Номер приложения
    Описание приложения

    Эндпоинт firewall-export

    ℹ️ Эндпоинт доступен начиная с версии MikoPBX 2026.1.76.

    Техническая страница для разработчиков своих bouncer'ов и для интеграций с edge-провайдерами (Cloudflare, AWS WAF, кастомные nftables-генераторы).

    • Базовый URL: https://<MIKOPBX-HOST>/pbxcore/api/v3/firewall-bouncer/

    — последний вызов:
    09:50
    ← самый старый
    103
    — всего вызов:
    3
    - переключатель включает / отключает возможность принятия новых звонков во время текущего разговора.
  • Оповещать о расчетном времени ожидания - если все операторы (агенты очереди) заняты, то включив этот переключатель, можно оповестить клиента о примерном времени ожидания ответа на вызов. Если активирована опция Дополнительный звуковой анонс, то этот анонс дополнит информацию о расчетном времени.

  • Дополнительный звуковой анонс - звуковое сообщение проигрывается только если все участники очереди заняты.

  • Время в секундах для периодического повтора всех оповещений - описывает c каким интервалом произносить оповещение о позиции в очереди, времени ожидания и анонс.

  • Если в Сценарии 1 не указан резервный номер, общий таймаут ожидания в очереди не задается: вызов остается в очереди до ответа оператора или завершения звонка абонентом. Чтобы ограничить время ожидания, задайте длительность в Сценарии 1 и выберите номер для переадресации.

    Основные параметры

    Стратегия и операторы очереди

    Вызов на любого свободного

    Вызов одновременно на всех

    Вызов на того, кто дольше не принимал вызовы

    Вызов на того, кто меньше отвечал на вызовы

    Вызов на любого свободного

    Вызов поступает на каждого участника очереди по порядку

    После сохранения очереди MikoPBX пересоздает конфигурацию очередей и применяет изменения автоматически. Перезапуск Asterisk вручную для смены стратегии не требуется.

    Линейная с накоплением

    Для этой стратегии важно, чтобы время в Сценарии 1 было больше расчетного времени подключения всех операторов. Если таймаут очереди меньше, последние участники могут не успеть принять вызов.

    Расширенные настройки

    Настройки очереди для операторов

    Настройки очереди для вызывающего абонента

    Маршрутизация звонков при сбоях

    В данных сценариях в качестве номера переадресации можно выбрать не только внутренний номер, а также конференцию, очередь, IVR, приложение диалплана служебный номер.

    В Сценарии 1 указывайте и время ожидания, и номер переадресации. Если заполнить только время без резервного номера, MikoPBX не передаст общий таймаут в приложение очереди, чтобы не завершать звонок без маршрута продолжения.

    Раздел "Очереди вызовов"
    Элемент "Создать новую очередь"
    Параметры для новой очереди вызовов
    Раздел "Операторы очереди"
    Расширенные настройки очереди
    Раздел "Настройки очереди для операторов"
    Настройки очереди для вызывающего абонента
    Раздел "Маршрутизация звонков при сбоях"
    для хранения записей разговоров

    features.conf

    В файле назначаются пользовательские коды и опции абонентских функций Asterisk, такие как: перевод вызова (transfer); перехват вызова (pickup); запись по требованию (record on demand); таймауты набора и переадресации (digit timeout); паркинг (park) и др.

    http.conf

    Встроенный http сервер Asterisk

    iax.conf

    В файле Вы описываете ваши соединения по протоколу IAX.

    indications.conf

    Национализация тональных сигналов

    logger.conf

    Настройка логов Asterisk. В данном файле настраивается логирование событий Asterisk в файлы, консоль и syslog linux. Для применения настроек выполните команду «logger reload» в консоли (CLI) Asterisk.

    manager.conf

    Настройка интерфейса AMI (Asterisk Manager Interface)

    modules.conf

    Параметры загрузки модулей Asterisk.

    musiconhold.conf

    Параметры музыки на удержание в IVR

    queues.conf

    Очередь входящих вызовов Asterisk. Подробное описание стратегии вызовов. Penalty, timeout, member и все доступные параметры.

    rtp.conf

    Глобальные настройки RTP - медиа-портов и протокола

    sip.conf

    Файл отвечает за настройку внутренних и внешних каналов SIP в Asterisk.

    voicemail.conf

    Настройки уведомлений по E-mail

    jail.local

    Настройки Fail2ban

    msmtp.conf

    Настройки SMTP-клиента

    Звонок через определённого провайдера
    При userland-proxy=true (поведение Docker по умолчанию) контейнер видит HTTP-клиента как docker0-шлюз (например 172.17.0.1), а не как реальный IP атакующего. ACL уровня Nginx и fail2ban-jail для веб-формы блокируют только этот шлюз — то есть никого.

    SIP-защита при этом работает: UDP-DNAT сохраняет source IP, Asterisk видит реальный адрес, fail2ban пишет блокировку в Redis и module reload acl отбивает дальнейшие REGISTER. Сломан именно HTTP-сегмент.

    Решение — экспортировать решения о блокировке наружу и применять их в настоящем файрволе хоста (или edge-CDN, или security-group облака) при помощи внешнего обработчика правил.

    На странице Безопасность → Доступ к веб-интерфейсу есть жёлтый баннер «Docker bridge: требуется внешний обработчик правил». Если он показан — этот документ для вас.

    Баннер «требуется внешний файрвол» на странице файрвола в Docker bridge

    Кнопка Проверить видимость моего IP запросит эндпоинт system:checkClientIpVisibility и покажет три значения:

    • ip_visible — реальный IP клиента виден, ничего не требуется.

    • ip_not_visible — IP клиента подменён на шлюз Docker bridge: правила HTTP-файрвола работать не будут.

    • proxy_detected — перед АТС стоит reverse-proxy, и АТС намеренно не доверяет proxy-заголовкам. Настройте прокси на отображение реального IP или разверните внешний bouncer.

    Если хост — выделенный сервер для АТС и нет конфликтов портов, переключите контейнер в host-режим:

    В этом режиме контейнер использует сетевой namespace хоста, Asterisk и Nginx видят реальные source-IP, а внутренний файрвол работает «как на bare metal». Подходит лучше всего для SIP-нагруженных инсталляций.

    Ограничения: один host-режим на хост, нельзя поднять рядом несколько копий АТС, конфликты с другими процессами на стандартных портах.

    Контейнер MikoPBX остаётся в bridge-режиме. На Linux-хосте ставится cs-firewall-bouncer (open-source, проект CrowdSec), который поллит эндпоинт MikoPBX каждые 10 секунд и переносит решения в iptables/nftables хоста.

    Это рекомендуемый вариант для большинства инсталляций.

    1. Откройте Система → API-ключи.

    2. Нажмите кнопку Токен для bouncer (предзаполняет правильное ограничение пути).

    3. Откроется форма создания ключа. Описание («Внешний firewall bouncer (CrowdSec-совместимый)») и API-ключ уже подставлены — при необходимости выберите Сетевой фильтр, чтобы ограничить source-IP, с которого можно опрашивать эндпоинт. Тумблер «Полные права доступа» оставьте выключенным: кнопка Токен для bouncer уже выставила нужное ограничение пути /api/v3/firewall-bouncer.

    Форма создания токена с предзаполненными описанием и ключом
    1. Сохраните. Откроется модальное окно с готовой конфигурацией cs-firewall-bouncer.yaml — скопируйте её сразу, API-ключ показывается только один раз.

    Модалка с пресет-конфигом cs-firewall-bouncer после создания токена

    Откройте /etc/crowdsec/bouncers/cs-firewall-bouncer.yaml и замените api_url / api_key на значения из шага 1:

    📌 api_url — это базовый URL. cs-firewall-bouncer сам дописывает /v1/decisions/stream и отправляет токен в заголовке X-Api-Key. Не указывайте полный путь к decisions/stream в api_url и не добавляйте префикс Bearer к ключу — bouncer всё делает сам.

    ⚠️ Если ваш MikoPBX слушает HTTPS с self-signed сертификатом, добавьте insecure_skip_verify: true или установите CA-сертификат на хост.

    🚨 iptables_chains: [INPUT, FORWARD, DOCKER-USER] — это не дефолт CrowdSec (по умолчанию там только INPUT). Без DOCKER-USER трафик, который Docker маршрутизирует в контейнер, идёт через цепочку DOCKER и не доходит до DROP-правила bouncer'а — бан виден в iptables, но в реальности не работает. Это самая частая ловушка при подключении CrowdSec к Docker-развёрнутой АТС.

    • В логах bouncer должно появиться received N new decisions, 0 deleted.

    • sudo iptables -L CROWDSEC -n (или crowdsec-firewall-bouncer-iptables-v6 для IPv6) покажет добавленные блокировки.

    • Заблокируйте тестовый IP вручную через раздел Файрвол → Сети или спровоцируйте fail2ban-блокировку и убедитесь, что строка появилась в iptables хоста в течение 30 секунд.

    Bouncer'ы CrowdSec блокируют на уровне IP, а не протокола — одна запись в ipset дропает все TCP- и UDP-пакеты с забаненного адреса. В том числе порт 22. Если IP оператора по ошибке попадёт в бан-лист (скажем, fail2ban зафиксировал три неудачных auth:login с NAT-IP офиса), то SSH тоже отрежется, и админ запрётся снаружи хоста.

    Вставьте высокоприоритетный ACCEPT для админ-порта до DROP-правила bouncer'а, чтобы административный доступ оставался жив даже если IP самого оператора попадёт в бан:

    Повторите для любых других портов, через которые вы администрируете машину (Wireguard, serial-консоль провайдера и т.д.) — для всего, что не должно падать под bouncer'а.

    Для инсталляций, где потеря доступа к хосту дорого стоит, добавьте systemd-timer, периодически чистящий ipset bouncer'а. Bouncer перезальёт текущие баны на следующем poll'е, так что это безопасный safety-net с ограниченным blast radius, а не отключение функции:

    30 минут — разумный дефолт: короче, чем время остывания кофе оператора, если он случайно себя забанит, и длинее, чем нужно реальной атаке, чтобы заметно ущербнуть.

    CrowdSec мапит решения в один ipset на IP-семейство. Правила iptables дропают весь трафик с перечисленных IP, независимо от протокола и порта. Бан mikopbx/http (HTTP-брутфорс) автоматически отрезает тому же IP и SIP / IAX / AMI / SSH — и наоборот: бан mikopbx/sip (fail2ban-jail Asterisk) тоже дропнет HTTP и AMI от того же IP. MikoPBX отдаёт в bouncer-стрим все четыре категории банов (sip, http, ami, iax) одинаково, так что после подключения bouncer'а любая блокировка становится IP-wide.

    Для большинства инсталляций это правильное поведение — если IP агрессивен к HTTP, в SIP его пускать тоже незачем, и наоборот. Но если нужно по-протокольное разделение (например, блокировать HTTP-брутфорсеров, не трогая их SIP), bouncer для этой АТС поднимать не нужно. Существующий путь защиты SIP внутри Docker'а (fail2ban → Redis → pjsip ACL внутри Asterisk) изолирует SIP-баны именно потому, что они не уходят в host ipset — а bouncer ровно это поведение и меняет.

    GET /pbxcore/api/v3/firewall-bouncer/v1/decisions/stream возвращает снимок текущих решений в виде, который ожидает стоковый cs-firewall-bouncer — {new, deleted} на верхнем уровне, без обёртки MikoPBX:

    Массив new[] всегда содержит полный снимок текущих банов — bouncer обновляет таймауты своих ipset/nftables-записей до значения duration на каждом poll'е, поэтому активный бан живёт ровно столько, сколько указал источник. Массив deleted[] считается per-token (MikoPBX хранит прошлый снимок по id'у ApiKey) и содержит решения, которые исчезли с предыдущего опроса. Снятие бана оператором доходит до ipset bouncer'а за один poll-цикл (≈ 5–10 секунд), а не ждёт естественного истечения TTL.

    ?startup=true на первом poll'е после рестарта bouncer'а сбрасывает per-token cursor и возвращает deleted: [] — свежезапущенный bouncer не получит фантомных удалений для состояния, которое он никогда не отслеживал.

    Оба варианта заголовков аутентифицируют один и тот же токен:

    GET /pbxcore/api/v3/firewall-bouncer/v1/whitelist возвращает whitelist оператора как плоский JSON-массив:

    Этот эндпоинт — специфика MikoPBX. Стоковый cs-firewall-bouncer его не опрашивает (в CrowdSec LAPI нет типа решения «allow», bouncer ведёт собственный whitelists.yaml). Предоставлен для MikoPBX-aware интеграций, которым нужна согласованность whitelist с NetworkFilters АТС на стороне сервера.

    Детальный формат, query-параметры и сопоставление категорий MikoPBX с полями CrowdSec описаны в разделе Эндпоинт firewall-export.

    Проблема

    services:
      mikopbx:
        image: mikopbx/mikopbx:latest
        network_mode: host
        # удалите все `ports:`
    # Debian / Ubuntu
    curl -s https://install.crowdsec.net | sudo sh
    sudo apt-get install -y crowdsec-firewall-bouncer-iptables
    api_url: http://<MIKOPBX-HOST>/pbxcore/api/v3/firewall-bouncer/
    api_key: <token-from-modal>
    update_frequency: 10s
    mode: iptables
    log_mode: stdout
    log_level: info
    
    # КРИТИЧНО для Docker-развёртываний: правило ОБЯЗАНО быть в цепочке
    # DOCKER-USER, иначе трафик, который Docker пробрасывает в контейнер,
    # обходит INPUT/FORWARD полностью, и бан в iptables есть, а атакующий
    # проходит как ни в чём не бывало.
    iptables_chains:
      - INPUT
      - FORWARD
      - DOCKER-USER
    
    # Отключите IPv6, если Docker без IPv6-bridge'а. На хостах без Docker
    # IPv6 в ip6tables нет цепочки DOCKER-USER, и bouncer падает с
    # fatal-ошибкой при запуске.
    disable_ipv6: true
    sudo systemctl restart crowdsec-firewall-bouncer.service
    sudo systemctl status crowdsec-firewall-bouncer.service
    # Always-accept SSH (port 22) — переживает любые изменения bouncer'а
    sudo iptables -I INPUT 1 -p tcp --dport 22 -j ACCEPT \
      -m comment --comment "admin-protect"
    
    # Сохранить между ребутами (Debian / Ubuntu)
    sudo apt-get install -y iptables-persistent
    sudo netfilter-persistent save
    # /etc/systemd/system/crowdsec-safety-flush.service
    [Unit]
    Description=Safety net - flush crowdsec ipset to prevent lockout
    After=crowdsec-firewall-bouncer.service
    
    [Service]
    Type=oneshot
    ExecStart=/usr/sbin/ipset flush crowdsec-blacklists
    # /etc/systemd/system/crowdsec-safety-flush.timer
    [Unit]
    Description=Run crowdsec ipset flush every 30 minutes
    
    [Timer]
    OnBootSec=30min
    OnUnitActiveSec=30min
    Unit=crowdsec-safety-flush.service
    
    [Install]
    WantedBy=timers.target
    sudo systemctl daemon-reload
    sudo systemctl enable --now crowdsec-safety-flush.timer
    {
      "new": [
        {
          "id": 12345,
          "origin": "mikopbx-fail2ban",
          "type": "ban",
          "scope": "Ip",
          "value": "203.0.113.7",
          "duration": "3600s",
          "scenario": "mikopbx/sip"
        }
      ],
      "deleted": []
    }
    # Стоковый cs-firewall-bouncer (соглашение CrowdSec):
    curl -H "X-Api-Key: <token>" \
         "http://<MIKOPBX-HOST>/pbxcore/api/v3/firewall-bouncer/v1/decisions/stream?startup=true"
    
    # Эквивалент для ручных проб curl/Postman/Insomnia:
    curl -H "Authorization: Bearer <token>" \
         "http://<MIKOPBX-HOST>/pbxcore/api/v3/firewall-bouncer/v1/decisions/stream"
    ["10.0.0.0/8", "192.168.1.0/24"]

    Шаг 1. Проверьте, ваш ли это случай

    Шаг 2. Выберите подход

    Вариант A — network_mode: host (минимум усилий)

    Вариант B — cs-firewall-bouncer apt-пакетом на хосте

    1. Создайте API-токен

    2. Установите bouncer на хосте

    3. Настройте

    4. Проверьте

    Замечания по production-развёртыванию

    Защита SSH (и других админ-портов) от bouncer'а

    Опционально: safety-net на systemd-timer

    Bouncer-баны покрывают все протоколы — by design

    Формат ответа эндпоинта

    Сосуществующий эндпоинт whitelist (кастомный)

    Технические подробности

    Для подключения новой учетной записи провайдера нажмите Подключить SIP или Подключить IAX в зависимости по типа подключаемой учетной записи:
    Опции подключения нового провайдера
    Общие настройки SIP-провайдера

    В общих настройках SIP провайдера укажите следующие настройки:

    Название провайдера - произвольное удобное вам наименование. Оно будет отображаться в списках выбора в соответствующих меню.

    Тип учетной записи - тип регистрации учетной записи провайдера. Подробнее про тип регистрации.

    Хост или IP адрес - может быть либо URL либо IP-адресом

    Логин и Пароль, который предоставляет ваш провайдер

    Режим DTMF - определяет, как DTMF сигналы передаются через SIP. Cуществуют различные стандарты, используемые для передачи DTMF SIP-провайдерам. Попробуйте использовать различные стандарты для того, чтобы найти режим, который подойдет вам. inband передает нажатия клавиш в качестве «тона». Для использования этого стандарта вам необходим аудио кодек высокого качества. Auto, rfc и info передают нажатия клавиш в SIP кодирование.

    Вкладка "Расширенные настройки" SIP провайдера
    Поле "Дополнительные адреса провайдера"

    В этом разделе следует перечислить все адреса поставщика услуг связи, с которых могут приходит входящие звонки. Доступ для этих адресов к портам SIP и RTP будет автоматически открыт на firewall.

    Поле "Порт соединения SIP"

    По умолчанию принимает значение 5060. SIP протокол описывает, каким образом клиентское приложение (например, софтфон) может запросить начало соединения у другого, возможно, физически удалённого клиента, находящегося в той же сети, используя его уникальное имя. Протокол определяет способ согласования между клиентами об открытии каналов обмена на основе других протоколов, которые могут использоваться для непосредственной передачи информации (например, RTP).

    Поле "Транспортный протокол"

    Позволяет указать используемый транспортный протокол для данной учетной записи провайдера.

    Поле "outbound proxy"

    Это SIP прокси сервер провайдера для обработки запросов. Реальный SIP сервер, может отличаться от этого адреса. Outbound proxy принимает на себя первичные запросы и перенаправляет на нужный сервер.

    Режим NAT

    Режим NAT - Это механизм в сетях TCP/IP, позволяющий преобразовывать IP-адреса транзитных пакетов.

    • force_rport,comedia опция заменяющая nat=yes;

    • force_rport даже если ни одного параметра rport не было указано, действовать, так, как если бы он был;

    • comedia отправлять RTP пакеты обратно к порту с которого они были получены, игнорируя требуемый порт в SDP заголовке;

    • auto_comedia если Asterisk сможет определить, что устройство находится за NAT, установить опцию comedia;

    • no не выполнять никакой специальной обработки NAT, кроме той что указана в RFC 3581.

    Подраздел "Поддерживать NAT сессию"

    При включение этой опции Asterisk будет отправлять SIP Options пакеты. Это необходимо для поддержки NAT туннелирования на вашем маршрутизаторе.

    Укажите частоту, с которой Asterisk будет отправлять SIP сообщение типа OPTIONS для проверки, что данное устройство работает и доступно для совершения вызовов.

    Если данное устройство, не ответит в течение заданного периода (60 секунд по умолчанию), тогда Asterisk рассматривает это устройство как выключенное и недоступное для совершения вызовов.

    Можно отключить использование поля fromuser заголовка SIP-пакета.

    Подраздел "Переопределение SIP заголовка FROM"

    Параметры файла pjsip.conf fromuser и fromdomain используются для вызовов исходящих от Asterisk в сторону SIP устройства.

    Можно переопределить:

    • имя пользователя в поле From в SIP пакетах (fromuser);

    • имя домена в поле From в SIP пакетах (fromdomain).

    Для этого служат поля User и Domain соответственно.

    Поля "User" и "Domain"
    Дополнительные параметры провайдера

    В этом поле вы можете изменять конфигурационные файлы Asterisk.

    Переопределять можно практически все параметры. К примеру при использовании chan_pjsip провайдер описывается следующими секциями:

    Для переопределения полей в секциях следует заполнить поле Дополнительные параметры следующим образом:

    Для завершения настройки нажмите Сохранить.

    Кнопка "Сохранить"

    Бывают случаи, когда необходимо подключить несколько учетных записей одного поставщика услуг связи. В этом случае настройки Хост или IP адрес и Порт соединения SIP могут оказаться одинаковыми для всех учетных записей.

    Asterisk такую ситуацию обыгрывает по-своему. АТС не сможет корректно «приземлить» вызов на нужного провайдера и вызов оборвется.

    В качестве решения, в старых версиях АТС можно было для какой учетной записи описать дополнительные входящие маршруты и заполнить поле Дополнительный номер (DID) значением Логин. И так для каждой учетной записи требовалось создать некоторое количество дополнительных маршрутов, равное количеству аккаунтов провайдера.

    Альтернатива инструкции Регистрация нескольких учетных записей от одного провайдера. Такой подход был не очевиден.

    Поле Логин в большинстве случаев при входящем звонке будет использоваться в качестве номера назначения Дополнительный номер (DID). И, учитывая, что выходящие маршруты для всех Логин будут описаны, вызов будет корректно обработан телефонной станцией.

    Этот вариант используется при подключении большинства провайдеров.

    Необходимость регистрации возникает в случае, когда провайдер не может знать, с какого IP-адреса будет подключаться клиент, к примеру, когда АТС расположена за NAT. Сервер провайдера обычно на публичном IP-адресе.

    Входящая регистрация

    Этот вариант актуален для работы некоторых FXO / GSM шлюзов - когда внешнее устройство должно подключиться к вашей АТС по логину и паролю.

    Также этот вариант актуален, когда удаленное устройство находится за NAT и MikoPBX не может знать его IP адрес.

    Аутентификация по IP адресу, без пароля

    Актуально для безопасных частных сетей. Так к примеру Ростелеком часто ведет свой сетевой кабель и подключает клиента к своей локальной сети.

    АТС и провайдер в данном случае должны находиться в одной и той же сети.

    Раздел "Провайдеры телефонии"
    Переключение статуса провайдера
    [REG-AUTH-***]
    type = auth
    ; ----
    
    [REG-***] 
    type = registration
    transport = transport-udp
    ; ----
    
    [***-OUT]
    type = auth
    ; ----
    
    [***]
    type = aor
    max_contacts = 1
    ; ----
    
    [***]
    type = identify
    ; ----
    
    [***]
    type = endpoint
    context = incoming
    ; ----
    [registration-auth]
    ; описываем параметры авторизации для [REG-AUTH-***]
    
    [registration]
    ; описываем параметры регистрации на удаленном сервере [REG-***]
    
    [endpoint-auth]
    ; описываем параметры авторизации для исходящих звонков через провайдера
    
    [identify]
    ; Секция отвечает за сопоставление регистрации и endpoint. При поступлении входящего звонка 
    ; согласно INVITE будет проведена проверка соответствия identify параметров с endpoint. 
    
    [aor]
    ; Правка секции AOR для endpoint
    
    [endpoint]
    ; Правка параметров endpoint

    Настройка SIP провайдера

    Общие настройки

    Инструкции по подключению наиболее популярных поставщиков услуг можно найти в .

    Расширенные настройки SIP провайдера

    Дополнительные адреса провайдера

    Порт соединения SIP

    Транспортный протокол

    Outbound proxy

    Режим NAT

    Поддерживать NAT сессию

    Переопределение SIP заголовка "From"

    Дополнительные параметры

    Несколько провайдеров на одном IP

    Подробнее про тип регистрации

    Исходящая регистрация

    000063

    Приложение считывает внутренний номер сотрудника, используемое для вызова приложения, и озвучивает его сотруднику, т.е. сотруднику озвучивается его внутренний номер на АТС

    000064

    0000MILLI - Генерирует постоянный звуковой сигнал частотой 1000 Гц. Используется для проверки качества соединения.

    10003246

    Приложение Echo посылает полученные аудиосигналы обратно пользователю, чтобы можно было определить длительность задержки. В общем, Вы слышите, что Вы говорите. Приложение в основном используется для тестирования.

    Приложения MikoPBX создаются из нескольких планов набора Asterisk приложений. В системе есть много примеров готовых к выполнению приложений. Для добавления нового приложения MikoPBX нажмите на "Добавить новое" в меню приложений.

    Элемент для создания нового приложения диалплана

    Всего в несколько шагов Вы сможете создать свои собственные приложения. Во-первых, определите Название и Номер вызова для приложения, при необходимости заполните поле Комментарий. Возможный тип кода приложения:

    • PHP-AGI скрипт - AGI - это встроенный в Asterisk метод выполнения внешних скриптов (по аналогии с CGI для http серверов), который может расширить функциональность asterisk при помощи других языков программирования, в частности PHP. AGI скрипты могут управлять вызовом в плане набора, вызываются из файла: extensions.conf

    • Диалплан Asterisk - конфигурация плана набора содержится в файле конфигурации Asterisk - extensions.conf. Это один из самых важных конфигурационных файлов. В нем определяется обработка и маршрутизация входящих и исходящих вызовов. Этот файл управляет поведением всех соединений проходящих через Вашу АТС.

    Раздел конфигурации нового приложения диалплана

    Внесем ясность: мы будем называть MikoPBX приложения - приложениями, планы набора Asterisk -функциями. Например, Answer(), NoOP(), Set() and Wait() - это функции. Эти отдельные целевые функции Asterisk, которые затем объединяются в MikoPBX для создания более мощных MikoPBX приложений. Опишите логические операции в текстовом поле Программный код. Обратите внимание, что в одной строке одновременно допускается только одна команда, например:

    Вкладка "Программный код"

    На рисунке пример простейшего приложения для номера 000063. После набора номера, вы услышите, как робот озвучивает Ваш внутренний номер.

    Описание Asterisk функций, которые Вы можете использовать в своих приложениях:

    Наименование команды
    Описание

    answer

    Перевести вызов в отвеченное состояние.

    channel status

    Возвращает статус подключенного канала.

    control stream file

    Нажмите Сохранить для завершения настройки.

    Встроенные приложения диалпланов

    Создание приложений

    MikoPBX будет проверять используемые команды. Не исключено, что неправильно запрограммированные операции могут повлиять на работоспособность вашей телефонной системы.

    Эндпоинты:
    • GET /v1/decisions/stream — полный snapshot решений в формате CrowdSec LAPI. Стоковый cs-firewall-bouncer дописывает этот путь к api_url сам.

    • GET /v1/whitelist — allow-list оператора как плоский JSON-массив (расширение MikoPBX, см. Whitelist).

  • Аутентификация: bouncer-токен принимается в двух заголовках:

    • X-Api-Key: <token> — соглашение CrowdSec, шлёт стоковый cs-firewall-bouncer.

    • Authorization: Bearer <token> — удобен для curl, Postman и кастомных HTTP-клиентов. Оба варианта валидируют одну и ту же строку в ApiKeys, path-restriction и ACL действуют одинаково.

  • Permission scope: firewall_bouncer. Создавайте токен с allowed_paths: {"/api/v3/firewall-bouncer": "read"} — пресет в UI ApiKeys уже делает это правильно.

  • Совместимость: тело ответа decisions/stream повторяет shape CrowdSec LAPI один-в-один — {new, deleted} на верхнем уровне, без обёртки. Существующие CrowdSec bouncer'ы (cs-firewall-bouncer, cs-cloudflare-bouncer, cs-nginx-bouncer и десятки community-плагинов) работают «из коробки».

  • GET /pbxcore/api/v3/firewall-bouncer/v1/decisions/stream

    Поле
    Тип
    Описание

    id

    int

    Стабильный положительный 32-битный ID — crc32(value + scenario) & 0x7fffffff.

    origin

    string

    mikopbx-fail2ban (Redis) или mikopbx-networkfilters (БД оператора).

    MikoPBX
    CrowdSec
    Источник

    mikopbx-fail2ban

    aggregated origin

    Redis-ключи firewall:<cat>:<ip>

    mikopbx-networkfilters

    aggregated origin

    Таблица m_NetworkFilters.deny

    • На каждый poll возвращается полный snapshot текущих банов в массиве new. Bouncer'ы обновляют таймауты своих ipset / nftables- записей при каждом появлении IP, поэтому активный бан живёт ровно столько, сколько указал источник в поле duration.

    • Массив deleted содержит per-bouncer дифф с прошлого poll'а. MikoPBX хранит последний выданный snapshot per-ApiKey id (Redis-ключ _PH_REDIS_CLIENT:fwbouncer:cursor:<token-id>, TTL 1 ч, обновляется на каждом poll'е — курсор истекает только после часа молчания bouncer'а). Решения, исчезнувшие между двумя опросами — снятие бана оператором, истечение TTL, удаление записи NetworkFilters — попадают в deleted полными объектами на следующем poll'е, и bouncer удаляет запись из своего локального стора немедленно, не дожидаясь естественного истечения таймаута ipset.

    • update_frequency: 5–10s — рекомендованная частота опроса.

    Поведение query-параметров от bouncer'а:

    Параметр
    Поведение

    startup

    startup=true игнорирует сохранённый cursor только для текущего poll'а — полный snapshot в new, пустой deleted — после чего записывает свежий snapshot в cursor. СЛЕДУЮЩИЙ poll уже диффится с этим свежим snapshot'ом штатно. Bouncer'ы посылают это на первом poll'е после рестарта. Прочие значения (включая false) трактуются как обычные опросы.

    scopes

    Принимается, но игнорируется. MikoPBX отдаёт только scope=Ip и scope=Range; server-side фильтрация не выполняется.

    origins

    Принимается, но игнорируется. Оба origin (mikopbx-fail2ban, mikopbx-networkfilters) всегда присутствуют в ответе. Bouncer'ы, желающие фильтровать, делают это на своей стороне.

    Изоляция курсоров позволяет нескольким независимым bouncer'ам (например, один работает локально с nftables, второй гонит правила в Cloudflare) каждому вести свой дифф — выдавайте один ApiKey на bouncer. Совместное использование одного ApiKey несколькими bouncer'ами заставляет их делить один курсор: poll'ы разных bouncer'ов будут чередовать записи snapshot'а, давая недетерминированные тайминги deleted[] и пропущенные eviction-события для короткоживущих банов.

    Обратите внимание: JSON-тело — это LAPI shape на верхнем уровне, без обёртки {result, data, ...} вокруг new/deleted.

    GET /pbxcore/api/v3/firewall-bouncer/v1/whitelist возвращает allow-list оператора как плоский JSON-массив:

    Источники, объединённые в ответ:

    • NetworkFilters с признаком newer_block_ip = '1',

    • Fail2BanRules.whitelist.

    Эндпоинт — специфика MikoPBX. Стоковый cs-firewall-bouncer его не опрашивает: в CrowdSec LAPI нет типа решения «allow», bouncer ведёт собственный whitelists.yaml. Предоставлен для MikoPBX-aware интеграций, которым нужна согласованность whitelist на стороне сервера.

    MikoPBX дополнительно проверяет whitelist на write-side (в DockerNetworkFilterService::isIpWhitelisted), но это защита в глубину — ваш bouncer всё равно должен вычитать whitelist из new перед применением блокировок.

    • Эндпоинт whitelist отдаёт операторские allow-list сети. Никогда не выставляйте его без аутентификации.

    • Bouncer-токен оптимально привязывать к NetworkFilter, разрешающему только IP хоста bouncer'а. При несовпадении источника API вернёт 403.

    • После compromise — отзовите токен через UI ApiKeys; bouncer перестанет получать новые решения и через 30 секунд начнут истекать его локальные блокировки (если такой режим включён).

    Базовая информация

    {
      "new": [
        {
          "id": 12345,
          "origin": "mikopbx-fail2ban",
          "type": "ban",
          "scope": "Ip",
          "value": "203.0.113.7",
          "duration": "3600s",
          "scenario": "mikopbx/sip"
        },
        {
          "id": 678901,
          "origin": "mikopbx-networkfilters",
          "type": "ban",
          "scope": "Range",
          "value": "198.51.100.0/24",
          "duration": "8760h",
          "scenario": "mikopbx/manual"
        }
      ],
      "deleted": []
    }
    # API-ключ bouncer-а читайте из переменной окружения / менеджера
    # секретов на хосте, где выполняется команда — никогда не вставляйте
    # ключ открытым текстом в скрипты, которые попадают в git.
    TOKEN=$BOUNCER_API_KEY
    
    # Стиль CrowdSec:
    curl -H "X-Api-Key: $TOKEN" \
      "https://pbx.example.com/pbxcore/api/v3/firewall-bouncer/v1/decisions/stream?startup=true" \
      | jq
    
    # Стиль Bearer (эквивалентен):
    curl -H "Authorization: Bearer $TOKEN" \
      "https://pbx.example.com/pbxcore/api/v3/firewall-bouncer/v1/decisions/stream" \
      | jq
    import requests, time
    
    BASE = "https://pbx.example.com/pbxcore/api/v3/firewall-bouncer"
    HEADERS = {"X-Api-Key": TOKEN}
    
    # Локальный whitelist bouncer'а (обновляется реже, чем решения).
    whitelist = set(requests.get(f"{BASE}/v1/whitelist", headers=HEADERS).json())
    
    while True:
        resp = requests.get(f"{BASE}/v1/decisions/stream", headers=HEADERS).json()
        bans = {d["value"] for d in resp["new"]}
        apply_iptables(bans - whitelist)
        time.sleep(10)
    ["10.0.0.0/8", "192.168.1.0/24"]

    Decisions stream

    Поля решения

    Сопоставление с CrowdSec

    Семантика опроса

    Примеры

    curl

    Минимальный кастомный bouncer (Python)

    Whitelist

    Безопасность

    здесь
    в этом блоке статей

    type

    string

    Всегда "ban".

    scope

    string

    "Ip" для одиночного адреса или "Range" для CIDR.

    value

    string

    IP-адрес или CIDR.

    duration

    string

    Оставшееся время до истечения, например "3600s" или "8760h".

    scenario

    string

    mikopbx/sip, mikopbx/http, mikopbx/ami, mikopbx/iax, mikopbx/manual.

    mikopbx/sip

    scenario tag

    Категория sip в Redis

    mikopbx/http

    scenario tag

    Категория http в Redis

    mikopbx/ami

    scenario tag

    Категория ami в Redis

    mikopbx/iax

    scenario tag

    Категория iax в Redis

    mikopbx/manual

    scenario tag

    Записи оператора в UI «Файрвол»

    нашем FAQ

    Отправка в канал заданного звукового файла, с возможностью управления его проигрывания (пауза/перемотка/возобновление проигрывания) с помощью получаемых от абонента DTMF цифр, если заданы. (Asterisk 1.2)

    database del

    Удаление ключа/значения из базы данных.

    database deltree

    Удаление дерева ключей/значений из базы данных.

    database get

    Получить значение из базы данных.

    database put

    Добавление/изменение значения в базе данных.

    exec

    Выполнение заданной Команды. (Команды - это функции, которые Вы используете при описании плана набора в файле extensions.conf ).

    get data

    Получить данные из канала.

    get option

    Ведет себя аналогично команде «STREAM FILE», но используется с заданным значением для таймаута. (Asterisk 1.2)

    get variable

    Получить значение переменной канала.

    hangup

    Разорвать соединение (Hangup) на текущем канале.

    noop

    Пустая команда. Ничего не делает.

    receive char

    Принимает один символ из канала, если он поддерживает эту возможность.

    receive text

    Принимает текстовую строку из канала, если он поддерживает эту возможность.

    record file

    Производит запись в заданный файл.

    say alpha

    Проговаривает заданную строку символов. (Asterisk 1.2)

    say date

    Проговаривает дату. (Asterisk 1.2)

    say datetime

    Проговаривает дату и время, согласно заданному формату. (Asterisk 1.2)

    say digits

    Проговаривает заданную строку цифр.

    say number

    Проговаривает заданный номер.

    say phonetic

    Проговаривает заданную строку символов.

    say time

    Проговаривает время.

    send image

    Отправляет изображение в канал, если он поддерживает эту возможность.

    send text

    Отправляет текст в канал, если он поддерживает эту возможность.

    set autohangup

    Автоматическое завершение соединение (Autohangup) на канале в заданное время.

    set callerid

    Установка callerid для текущего канала.

    set context

    Установка контекста для текущего канала.

    set extension

    Изменение екстеншена для текущего канала.

    set music

    Включение/Выключение музыки ожидания (Music on hold), например: «SET MUSIC ON default».

    set priority

    Установка значения приоритета для следующей выполняемой команды для канала.

    set variable

    Установка переменной канала.

    stream file

    Отправка звукового файла в канал.

    tdd mode

    Установка режима TDD для канала, который может его поддерживать, для включения возможности взаимодействия с TDD.

    verbose

    Запись сообщения в verbose log сервера asterisk.

    wait for digit

    Ожидание нажатия DTMF кнопки

    Запуск MikoPBX с помощью docker compose

    Установка MikoPBX с помощью docker compose

    Для работы с MikoPBX в контейнере необходимо установить docker и docker compose, а также создать пользователя и папки для хранения настроек конфигурации и записей разговоров по инструкции

    Установка докера и cоздание пользователя и каталогов

    Запуск с помощью docker compose

    Вот пример файла docker-compose.yml, который может быть использован для управления вашим контейнером MikoPBX через Docker Compose:

    docker-compose.yml
    services:
      mikopbx:
        container_name: "mikopbx"
        image: "ghcr.io/mikopbx/mikopbx:latest"
        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}
          # Изменение имени станции через переменные окружения
          - PBX_NAME=MikoPBX-in-Docker
          # Изменение стандартного порта SSH на 23
          - SSH_PORT=23
          # Изменение стандартного порта WEB на 8080
          - WEB_PORT=8080
          # Изменение стандартного порта WEB HTTPS на 8443
          - WEB_HTTPS_PORT=8443

    Сохраните содержимое в файл docker-compose.yml, выполните необходимые корректировки и запускайте MikoPBX коммандой:

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

    Запуск нескольких MikoPBX на одном хосте

    Режим без изоляции сети хоста от контейнеров (–net=host)

    Также можно оганизовать запуск нескольких контенеров MikoPBX на одном хосте, но здесь надо учитывать особенности работы Docker с портами, если не использовать режим –net=host то это приведет к высокой нагрузке на процессор хостовой системы, т.к. Docker создает для каждого выделенного порта отдельное правило в Iptables.

    С включенным режимом –net=host вам необходимо вручную следить за распределением доступных портов между запускаемыми контейнерами и встроенными приложениями. Например, для запуска двух контейнеров с MikoPBX на одном хосте, можно использовать следующий конфигурационный файл:

    Сохраните содержимое в файл docker-compose.yml, выполните необходимые корректировки и запускайте MikoPBX коммандой:

    Существует вариант запуска контейнеров с MikoPBX в режиме –net=bridge, но как описано выше для использования этого режима необходимо или существенно ограничить диапазон RTP портов, или открывать к ним доступ на хостовой машине не используя возможности Docker.

    Для этого вам необходимо написать небольшой скрипт, для определения имени текущего мостового интерфейса и IP адреса каждого контейнера, и после запуска docker compose добавить необходимые правила iptables для диапазона RTP портов следующим образом:

    Опишем несколько контейнеров в файле docker-compose.yaml, определим разные порты для веб интерфейса, SIP портов и диапазоны RTP портов, чтобы они не пересекались.

    Создаем папку для скриптов

    Сохраняем файлы start-multiple-mikopbx.sh и docker-compose.yaml в эту папку.

    Устанавливаем необходимые зависимости для работы скрипта.

    Переходим в нашу папку, добавляем права на выполнение и запускаем наш скрипт.

    Пока ожидаем запуск контейнеров, проверяем настройки брендмауера на хосте, при необходимости открваем те порты, которые указаны в нашем docker-compose.yaml файле, а именно:

    • TCP/UDP порты 5060 и 6060 для SIP

    • UDP диапазоны 10000-10800 и 20000-20800 для передачи звука по RTP

    • TCP порты 8443 и 9443 для HTTPS протокола, для работы Web интерфейса.

    Входим по очереди на каждую из станций по адресам:

    • https://<IP хостовой машины>:8443

    • https://<IP хостовой машины>:9443

    Для входа в веб-интерфейс первой АТС MikoPBX используйте логин admin и пароль mikopbx-first-password

    Для входа в веб-интерфейс второй АТС MikoPBX используйте логин admin и пароль mikopbx-second-password

    В каждой машине должен быть включен режим NAT, указывая что контейнер находится за маршрутизатором в настройках сетевого интерфейса. Если станции будут использоваться внутри локальной сети, то в поле внешнего IP прописваем локальный IP адрес хостовой машины, в противном случе ее публичный IP адрес.

    На этом настройка завершена, можно настраивать учетные записи и выполнять звонки.

    Ниже перечислены некоторые переменные окружения, которые позволят скорректировать используемые MikoPBX порты и настройки.

    • SSH_PORT - порт для SSH (22)

    • WEB_PORT - порт для работы web интерфейса по протоколу HTTP (80)

    • WEB_HTTPS_PORT - порт для работы web интерфейса по протоколу HTTPS (443)

    Полный список всех возможных параметров настроек доступен в исходном коде .

    Общие настройки

    Описание настроек основных параметров системы

    В этом разделе настраиваются основные параметры системы. Рекомендуется выполнить эти настройки сразу после установки АТС.

    Раздел "Система" -> "Общие настройки" в веб-интерфейсе MikoPBX

    Основные

    • Название PBX системы — отображается на главной странице MikoPBX.

    • Дополнительное описание — видно только администраторам системы.

    • Язык звуковых сообщений системы — язык голосовых оповещений.

    • Максимальная длина внутренних номеров — максимальная длина внутреннего номера сотрудника.

    • Разрешить входящие звонки с любых серверов - разрешает принимать SIP звонки от неавторизованных устройств и серверов без регистрации.

    • Перезапуск PBX каждую ночь — автоматический рестарт Asterisk в ночное время (в 01:00 ночи по системному времени).

    • Отправлять разработчикам информацию о сбоях — при возникновении ошибки её описание отправляется разработчикам (требуется доступ в интернет).

    Нажмите "Сохранить".

    • Запись разговоров — включить или отключить запись всех разговоров.

    • Запись внутренних разговоров — включить или отключить запись звонков между сотрудниками.

    Ниже можно выбрать звуковые файлы, которые будут использоваться в качестве предупреждения о записи разговора (для входящих и исходящих звонков могут быть выбраны разные звуковые файлы).

    Телефонные звонки сохраняются в формате WebM с кодеком Opus. Размер файла зависит от качества звонка: если хотя бы один из участников разговора использует качественный кодек (например, G.722 или Opus), запись сохраняется с повышенным битрейтом — это занимает больше места на диске, но улучшает качество распознавания речи.

    Парковка — способ временно поставить клиента на удержание, пока вы уточняете информацию. Во время ожидания клиенту воспроизводится мелодия.

    В MikoPBX доступны два способа парковки:

    1. Введите *2 во время разговора — вызов будет поставлен на удержание, а вам сообщат номер парковочного слота. Любой сотрудник может забрать вызов, набрав этот номер.

    2. В настройках задайте номер для парковки — при переадресации вызова на этот номер MikoPBX поставит звонок на удержание и сообщит номер слота. Вызов также может забрать любой сотрудник.

    Диапазон парковочных слотов и номер для парковки настраиваются в этом же разделе:

    • Номер для парковки вызова — номер, на который нужно перевести вызов для постановки на удержание, по умолчанию 800.

    • Диапазон слотов для парковки — диапазон номеров парковочных слотов, по умолчанию 801–820.

    MikoPBX поддерживает два вида переводов:

    • Консультативный (условный) перевод — вы можете предварительно поговорить с коллегой, прежде чем переключить на него вызов. Клиент в это время находится на удержании. Перевод завершается после того, как вы кладёте трубку.

    • Безусловный (слепой) перевод — вызов переводится сразу, без предварительного разговора с коллегой. Удобно, когда поступает второй звонок, а вы уже заняты — вызов можно мгновенно перевести на свободного сотрудника.

    Комбинации клавиш для переводов можно изменить в этом же разделе:

    • Комбинация для консультативного перевода — по умолчанию ##.

    • Комбинация для безусловного перевода — по умолчанию **.

    • Время возврата вызова — если после консультативного перевода никто не ответил, вызов вернётся обратно. Задаётся в секундах, по умолчанию 45 сек.

    • Максимальный таймаут между цифрами при вводе добавочного номера — время ожидания следующей цифры при наборе номера. Задаётся в миллисекундах, по умолчанию 2500 мс.

    Если звонит телефон коллеги, вы можете перехватить вызов, не вставая с места:

    • *8<НомерКоллеги> — перехватить вызов конкретного сотрудника.

    • *8 — перехватить любой входящий вызов, если номер коллеги неизвестен.

    Комбинацию для перехвата можно изменить в поле «Комбинация для перехвата входящих вызовов», по умолчанию *8.

    Session Initiation Protocol (SIP) — сигнальный протокол, используемый большинством VoIP-телефонов. Вы можете изменить SIP-порт (по умолчанию 5060) для повышения безопасности.

    RTP (Real-time Transport Protocol) определяет стандартный формат передачи аудио и видео по IP-сетям. По умолчанию используется диапазон портов 10000–10800. Для некоторых маршрутизаторов и брандмауэров может потребоваться дополнительная настройка диапазона. Ещё одна причина для его расширения — большое количество параллельных звонков: каждый активный вызов использует два RTP-порта, то есть при 200 портах возможно не более 100 одновременных звонков. Если нагрузка выше — расширьте диапазон.

    • Порт SIP — порт для регистрации телефонов на станции, по умолчанию 5060. Изменение порта может повысить безопасность системы.

    • Порт SIP TLS — порт для шифрованных звонков, по умолчанию 5061.

    • Диапазон RTP портов — диапазон портов для передачи аудио, по умолчанию 10000–10800.

    • Адрес STUN сервера — помогает при работе АТС за NAT, в том числе при использовании WebRTC.

    • Префикс Auth Username — по умолчанию имя пользователя (username) для авторизации на SIP-аккаунте соответствует внутреннему номеру сотрудника (пример — 101). При заполнении этой настройки к имени авторизации будет добавляться указанный префикс: username останется 101, а AuthUsername станет 101MIKO. Такой подход значительно усложняет подбор пароля для SIP-аккаунта.

    Некоторые брандмауэры закрывают порты после периода неактивности — в таких случаях стоит уменьшить таймаут регистрации. Также разные SIP-провайдеры могут требовать различные значения тайм-аутов.

    • Стандартное время Keep-alive — интервал отправки keep-alive пакетов в секундах, по умолчанию 120 секунд.

    • Минимальное время регистрации (SIPMiniExpiry) — по умолчанию 60 секунд.

    • Максимальное время регистрации (SIPMaxExpiry) — по умолчанию 3600 секунд.

    В этом разделе настраиваются разрешённые аудио и видео кодеки для всей АТС.

    Asterisk Manager Interface (AMI) — мощный и удобный программный интерфейс (API) Asterisk для управления системой из внешних программ. Благодаря AMI внешние программы могут осуществлять соединения с Asterisk посредством TCP-протокола, инициировать выполнение команд, считывать результат их выполнения, а также получать уведомления о происходящих событиях в реальном времени. AMI часто используют для интеграции с бизнес-процессами и системами, программным обеспечением CRM (Customer Relationship Management — управление взаимоотношениями с клиентами).

    Asynchronous Javascript Asterisk Manager (AJAM) — технология, которая позволяет веб-браузерам или другим приложениям с поддержкой HTTP напрямую обращаться к интерфейсу Asterisk Manager (AMI) через HTTP/HTTPS.

    Asterisk REST Interface (ARI) — RESTful API с поддержкой WebSocket, который даёт полный контроль над каналами, мостами и медиапотоками Asterisk в реальном времени. Предназначен для разработки собственных телефонных приложений.

    • Использовать AMI интерфейс — включить или отключить AMI.

    • Порт AMI — порт для подключения внешних программ к AMI, по умолчанию 5038. Клиентская программа подключается к AMI через этот порт и аутентифицируется, после чего Asterisk отвечает на запросы и отправляет извещения об изменениях состояния заданных подсистем.

    • HTTP порт (AJAM и ARI) — порт для подключения по HTTP, по умолчанию 8088.

    • HTTPS порт (AJAM и ARI) — порт для подключения по HTTPS, по умолчанию 8089.

    • Использовать AJAM интерфейс — включить или отключить AJAM.

    • Использовать ARI интерфейс — включить или отключить ARI. По умолчанию отключён.

    • Разрешённые источники CORS — домены, с которых разрешены запросы к ARI. CORS — механизм безопасности браузера, ограничивающий кросс-доменные запросы к API.

    SSH (Secure Shell) — зашифрованный протокол, который часто используется для взаимодействия и удалённого управления серверами. SSH-сервер может выполнять аутентификацию пользователей с помощью различных алгоритмов. Самый популярный — аутентификация по паролю. Он достаточно прост, но не очень безопасен: пароли передаются по безопасному каналу, однако недостаточно сложны для противостояния попыткам перебора. Вычислительная мощность современных систем в сочетании со специальными скриптами делает перебор очень простым.

    Существует более безопасный способ аутентификации — SSH-ключи. Каждая пара состоит из открытого и закрытого ключа: закрытый хранится у клиента, открытый загружается на сервер в файл ~/.ssh/authorized_keys. При подключении сервер отправляет сообщение, зашифрованное открытым ключом — если клиент расшифровывает его закрытым и возвращает правильный ответ, аутентификация считается пройденной.

    • SSH порт — порт для подключения по SSH, по умолчанию 22.

    • Логин для SSH консоли — имя пользователя для подключения.

    • Отключить авторизацию по паролю — по умолчанию включено в MikoPBX (авторизация по паролю отключена).

    Для повышения безопасности можно изменить HTTP-порт (по умолчанию 80) или активировать режим HTTPS. HTTPS шифрует трафик между браузером и АТС с помощью протоколов SSL/TLS. По умолчанию используется TCP-порт 443.

    • HTTP порт — порт для доступа к веб-интерфейсу по HTTP, по умолчанию 80.

    • HTTPS порт — порт для доступа к веб-интерфейсу по HTTPS, по умолчанию 443.

    • Редирект на HTTPS — при открытии веб-интерфейса по HTTP пользователь будет автоматически перенаправлен на HTTPS.

    SSL/TLS сертификат — цифровой документ, подтверждающий подлинность сервера и обеспечивающий шифрование данных между браузером и АТС. В MikoPBX сертификат используется для:

    • HTTPS доступа к веб-интерфейсу

    • WebRTC соединений (обязательно для браузерных звонков)

    • Безопасных AJAM и ARI подключений через HTTPS

    • Защищённого REST API для интеграций

    Сертификат должен быть в формате PEM — начинается с -----BEGIN CERTIFICATE----- и заканчивается -----END CERTIFICATE-----. Если у вас есть промежуточные сертификаты (intermediate), добавьте их после основного в том же поле.

    Способы получения сертификата:

    • Модуль Let's Encrypt — автоматическое получение и обновление бесплатных сертификатов. Рекомендуемый способ.

    • Покупка у центра сертификации (DigiCert, Comodo, GlobalSign и др.)

    • Самоподписанный сертификат — генерируется автоматически при первом запуске АТС, но вызывает предупреждения в браузерах.

    Секретный ключ для расшифровки SSL/TLS соединений. Должен точно соответствовать публичному сертификату — при несоответствии HTTPS работать не будет.

    Ключ должен быть в формате PEM — начинается с -----BEGIN RSA PRIVATE KEY----- или -----BEGIN PRIVATE KEY-----.

    Рекомендации по безопасности:

    • Храните резервную копию ключа в защищённом месте.

    • Используйте ключи длиной минимум 2048 бит (рекомендуется 4096).

    • Регулярно обновляйте сертификаты и ключи.

    В этом разделе можно изменить логин и пароль для входа в веб-интерфейс, а также настроить вход с помощью Passkeys.

    • Логин — имя пользователя для входа в веб-интерфейс.

    • Пароль — пароль для входа в веб-интерфейс.

    Passkeys — современный способ входа без пароля с использованием биометрии или аппаратного ключа безопасности: Face ID, Touch ID, Windows Hello или YubiKey. Это быстрее и безопаснее традиционных паролей.

    Чтобы добавить Passkey, нажмите кнопку «+ Добавить Passkey» и следуйте инструкциям браузера.

    Этот раздел позволяет полностью сбросить систему до заводского состояния. При удалении будут безвозвратно удалены все настройки, история вызовов, файлы записей разговоров и установленные модули расширений.

    Для подтверждения введите в поле ввода фразу удалить всё и нажмите «Сохранить».

    Доступ к ARI

    Короткое описание ARI (Asterisk REST Interface)

    ARI — это RESTful API с поддержкой WebSocket, который даёт полный контроль над каналами, мостами и медиапотоками Asterisk в реальном времени. В отличие от , ARI работает напрямую с ядром Asterisk и предназначен для разработки собственных телефонных приложений.

    По умолчанию отключён — включите при необходимости в разделе «Система» → «Общие настройки» → «AMI&ARI».

    ARI применяется когда стандартных возможностей АТС недостаточно и нужна собственная логика обработки звонков:

    • WebRTC приложения и софтфоны — веб-телефоны и мобильные клиенты с прямым управлением медиапотоками

  • Использовать WebRTC — будут произведены дополнительные настройки для работы с WebRTC-соединением. Например, для внутреннего номера 201 будет создан дополнительный endpoint, подключиться к которому можно по протоколу WebRTC с использованием URL sip:201-WS@IP_PBX.

  • SSH пароль — пароль для входа (доступен только если авторизация по паролю не отключена).
  • Авторизованные SSH ключи — добавьте сюда публичный SSH-ключ с помощью кнопки «+ Добавить ключ». Если ключей несколько - добавьте каждый отдельно.

  • Публичный SSH ключ системы — публичный SSH-ключ текущей АТС. Его можно скопировать в поле «Авторизованные SSH ключи» на другой станции — это позволит подключаться к удалённому серверу без дополнительной авторизации.

  • Включение этой опции может создать угрозу безопасности. Убедитесь, что ваша сеть надежно защищена и используются правила фильтрации!

    Запись разговоров

    Ориентировочно 1 час разговора занимает 14–28 МБ места на диске в зависимости от качества записи.

    Переводы вызовов

    Парковка (удержание)

    Переводы вызовов

    Комбинации вводятся с телефона во время активного разговора, после чего набирается внутренний номер сотрудника, на которого выполняется перевод.

    Таймауты

    Перехват вызова (Pickup)

    SIP

    Настройки портов для SIP сигнализации и диапазона RTP

    Дополнительные параметры

    Настройки продолжительности действия регистрации

    Аудио/видео кодеки

    AMI&ARI

    Настройки AMI

    Настройки HTTP сервера

    Настройки AJAM

    Настройки ARI

    Никогда не используйте * в продакшне. Указывайте только доверенные домены по HTTPS.

    SSH

    В MikoPBX аутентификация по паролю по умолчанию отключена — для подключения необходимо использовать SSH-ключи. Добавить его необходимо в данном разделе или при создании виртуальной машины в облаке (он автоматически будет подставлен при установке MikoPBX).

    Подробнее про подключение по SSH к MikoPBX Вы можете узнать здесь.

    Параметры раздела

    HTTP/HTTPS

    Публичный ключ HTTPS (SSL/TLS сертификат)

    Рекомендуем использовать модуль Let's Encrypt для автоматического управления сертификатами. Подробнее в этой статье.

    Приватный ключ HTTPS

    Никогда не передавайте приватный ключ третьим лицам. Компрометация ключа позволит злоумышленнику перехватывать зашифрованный трафик. При компрометации - немедленно замените пару ключей.

    Пароль WEB интерфейса

    Авторизация в MikoPBX по умолчанию:

    • Логин: admin

    • Пароль: admin — рекомендуется сразу изменить.

    Passkeys (биометрическая аутентификация)

    Подробнее Вы можете прочитать здесь.

    Удаление настроек системы

    Это действие необратимо. Перед очисткой системы убедитесь, что у вас есть резервная копия всех важных данных.

    Вкладка "Основные" в системных настройках
    Вкладка "Запись разговоров" в системных настройках
    Вкладка "Переводы вызовов" в системных настройках
    Вкладка "SIP" в системных настройках
    Раздел "Аудио/Видео кодеки" в системных настройках
    Вкладка "AMI&ARI" в системных настройках
    Вкладка "SSH" в системных настройках
    Вкладка "HTTP/HTTPS" в системных настройках
    Вкладка "Пароль WEB интерфейса" в системных настройках
    Раздел "Удаление настроек системы" в системных настройках

    SIP_PORT - порт для подключения SIP клиента (5060)

  • TLS_PORT - порт для подключения SIP клиента с шифрованием (5061)

  • RTP_PORT_FROM - начало диапазона RTP портов, передача голоса (10000)

  • RTP_PORT_TO - конец диапазона RTP портов, передача голоса (10800)

  • IAX_PORT - порт для подключения IAX клиентов (4569)

  • AMI_PORT - порт AMI (5038)

  • AJAM_PORT - порт AJAM используется для подключения панели телефонии для 1С (8088)

  • AJAM_PORT_TLS - порт AJAM используется для подключения панели телефонии для 1С (8089)

  • BEANSTALK_PORT - порт для сервера очередей Beanstalkd (4229)

  • REDIS_PORT - порт для сервера Redis (6379)

  • GNATS_PORT - порт для сервера gnatsd (4223)

  • ID_WWW_USER - идентификатор пользователя www-user (можно задать выражением $(id -u www-user), где www-user имя НЕ root пользователя)

  • ID_WWW_GROUP - идентификатор группы www-user (можно задать выражением $(id -g www-user), где www-user имя НЕ root группы)

  • WEB_ADMIN_LOGIN - логин для доступа в Web интерфейс

  • WEB_ADMIN_PASSWORD - пароль для доступа в Web интерфейс

  • Режим сетевого моста (–net=bridge)

    Важное замечание! Один из наших контейнеров использует проброс с SIP порта с изменением его значения 5060 -> 6060. В данном случае, для корректной работы системы, необходимо добавить внешнее значение SIP порта в настройках NAT в разделе сетевых интерфейсов MikoPBX. Эту настройку также можно сделать задав соответвующее значение переменной окружения EXTERNAL_SIP_PORT=6060 в файле docker-compose.

    Переменные окружения для конфигурирования MikoPBX

    В bridge-режиме (по умолчанию) внутренний файрвол MikoPBX не защищает веб-интерфейс — контейнер не управляет iptables хоста. См. Внешний файрвол для Docker.

    по ссылке
    docker-compose.yml
    services:
      mikopbx-first:
        container_name: "mikopbx-first"
        image: "ghcr.io/mikopbx/mikopbx:latest"
        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:latest"
        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
    
    export ID_WWW_USER=$(id -u www-user)
    export ID_WWW_GROUP=$(id -g www-user)
    sudo docker compose -f docker-compose.yml up
    start-multiple-mikopbx.sh
    #!/bin/bash
    
    COMPOSE_FILE="$1"
    
    if [ -z "$COMPOSE_FILE" ]; then
        echo "Usage: $0 path/to/docker-compose.yaml"
        exit 1
    fi
    
    # Получим идентификатор пользователя для запуска контейнера
    export ID_WWW_USER=$(id -u www-user)
    export ID_WWW_GROUP=$(id -g www-user)
    
    # Оставновим текущие контейнеры, если они запущены
    docker compose -f "$COMPOSE_FILE" down
    
    # Удалим их
    docker compose -f "$COMPOSE_FILE" rm
    
    # Запускаем контейнеры в фоне
    docker compose -f "$COMPOSE_FILE" up -d
    sleep 60
    
    # Создадим метку для правил IPTABLES
    IPTABLES_COMMENT="mikopbx-custom-rule"
    
    # Определим идентификатор проекта, он используется при создании сетевого моста
    project_prefix=$(cat "$COMPOSE_FILE" | yq e '.x-project-name' -)
    
    # Если префикс не задан, устанавливаем значение по умолчанию
    if [ -z "$project_prefix" ]; then
        project_prefix="default_prefix"
    fi
    
    # Функция для получения IP адреса контейнера
    function get_container_ip() {
        docker inspect -f '{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' "$1"
    }
    
    # Функция для получения имени мостового интерфейса
    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"
    # Удаляем все правила iptables промаркированные нашим комментарием
    iptables -S | grep "$IPTABLES_COMMENT" | sed 's/-A /-D /' | while read rule; do
            echo "Delete rule $rule"
            iptables $rule
    done
    
    # Удаляем все NAT правила iptables промаркированные нашим комментарием
    iptables -S -t nat | grep "$IPTABLES_COMMENT" | sed 's/-A /-D /' | while read rule; do
         echo "Delete rule $rule"
         iptables -t nat $rule
    done
    
    # Парсим docker-compose файл и получаем все необходимые параметры.
    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."
    docker-compose.yaml
    
    services:
      mikopbx-first:
        container_name: "mikopbx-first"
        image: "ghcr.io/mikopbx/mikopbx:latest"
        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 # UPD дипазон 10000-10800 на хосте будет направлен в контейнер
          - 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 порт 9443 на хосте направляется на порт 443 в контейнере
          - "5060:5060/udp"  # UDP порт 5060 на хосте направляется на порт 5060 в контейнере
      mikopbx-second:
        container_name: "mikopbx-second"
        image: "ghcr.io/mikopbx/mikopbx:latest"
        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 # UPD дипазон 20000-20800 на хосте будет направлен в контейнер
          - RTP_PORT_TO=20800
          - EXTERNAL_SIP_PORT=6060 # Расскажем MikoPBX какой у нее внешнить SIP порт
          - WEB_ADMIN_PASSWORD=mikopbx-second-password
          - ENABLE_USE_NAT=1
          - PBX_FIREWALL_ENABLED=1
          - PBX_FAIL2BAN_ENABLED=1
        ports:
          - "9443:443"  # TCP порт 9443 на хосте направляется на порт 443 в контейнере
          - "6060:5060/udp"  # UDP порт 6060 на хосте направляется на порт 5060 в контейнере
    x-project-name: mikopbx # Этот параметр обязательно должен присуствовать
    networks:
      network-bridge1:
        driver: bridge
      network-bridge2:
        driver: bridge
    mkdir -p /usr/src/mikopbx
    sudo apt-get update
    sudo apt-get install jq
    sudo snap install yq
    cd /usr/src/mikopbx
    sudo chmod +x start-multiple-mikopbx.sh
    sudo ./start-multiple-mikopbx.sh docker-compose.yaml

    Интерактивные голосовые меню (IVR) — кастомная логика меню, недоступная через стандартный диалплан

  • Конференц-связь — программное управление мостами и участниками

  • Запись и обработка звонков — перехват аудио в реальном времени для аналитики или транскрибации

  • Голосовые боты и ассистенты — интеграция с внешними AI-сервисами

  • Продвинутые очереди — собственная логика распределения звонков

  • ARI состоит из трёх компонентов:

    1. REST API — управление объектами Asterisk: каналами, мостами, записями

    2. WebSocket (/asterisk/ari/events) — получение асинхронных событий в реальном времени: входящий звонок, завершение звонка, нажатие DTMF и т.д.

    3. Stasis — приложение диалплана, которое передаёт канал под управление вашего ARI приложения

    Типичный сценарий: звонок попадает в диалплан → Stasis() передаёт канал вашему приложению → приложение управляет звонком через REST API и получает события через WebSocket.

    1. Перед началом, необходимо включить ARI интерфейс (по умолчанию он выключен). Для этого перейдите в раздел "Система" -> "Общие настройки".

    Раздел "Система" -> "Общие настройки" в MikoPBX
    1. Далее во вкладку "AMI&ARI", переключите тумблер "Использовать ARI интерфейс". В поле «Разрешённые источники CORS» укажите домены, с которых будут выполняться запросы к ARI. CORS — механизм безопасности браузера, который ограничивает кросс-доменные запросы к API.

    Значение
    Когда использовать

    (пусто)

    Доступ только с того же домена

    http://localhost:3000

    Локальная разработка

    https://app.mycompany.com

    Продакшн приложение

    Подключение ARI
    1. Перейдите в раздел «Система» → «Доступ к ARI».

    Раздел "Система" -> "Доступ к ARI" в MikoPBX
    1. Нажмите «Добавить пользователя».

    Кнопка "Добавить пользователя" в разделе "Доступ к ARI"
    1. Заполните следующие параметры:

    • Имя пользователя - логин для подключения, например ari_user.

    • Пароль - пароль для подключения.

    • Описание - описание для текущего пользователя, например "WebRTC Demo".

    • Приложения - укажите имена Stasis приложений, к которым имеет доступ пользователь. Оставьте поле пустым для доступа ко всем приложениям.

    Сохраните настройки.

    Параметры создаваемого ARI-пользователя
    Тип
    URL

    Обычный

    ws://your-mikopbx.com:8088/asterisk/ari/events

    Защищённый (TLS)

    wss://your-mikopbx.com:8089/asterisk/ari/events

    Замените [application] на имя вашего Stasis приложения.

    Тип
    URL

    HTTP

    http://your-mikopbx.com:8088/asterisk/ari

    HTTPS

    https://your-mikopbx.com:8089/asterisk/ari/

    Аутентификация: HTTP Basic Auth — логин и пароль ARI пользователя.

    Это минимальный пример работы с ARI — канал входит в Stasis приложение, приложение воспроизводит звуковой файл и завершает звонок.

    Пример взят из официальной документации Asterisk: Getting Started with ARI

    В MikoPBX перейдите в «Маршрутизация» → «Приложения диалплана», создайте приложение с типом «Диалплан Asterisk» и кодом:

    Назначьте приложение на нужный входящий маршрут.

    При входящем звонке WebSocket получит событие StasisStart:

    Откройте новое окно терминала и выполните следующую команду:

    При успешном проигрывании Вы увидите следующий вывод в терминал:

    После завершения звонка WebSocket пришлёт StasisEnd:

    Живая таблица статусов сотрудников в терминале — не требует настройки входящих маршрутов и Stasis приложений. Работает через подписку на все события станции.

    Установите зависимости:

    При совершении вызовов, информация в таблице будет обновляться:


    Полная документация по ARI — на сайте Asterisk: docs.asterisk.org

    Подробная документация по ARI доступна на официальном сайте Asterisk: Asterisk REST Interface

    Для чего используется?

    REST API MikoPBX
    # REST API запрос через curl
    curl -u username:password https://your-mikopbx.com:8089/asterisk/ari/asterisk/info
    wscat -c "wss://username:password@your-mikopbx.com:8089/asterisk/ari/events?app=hello-world"
    1,Answer()
    n,Stasis(hello-world)
    n,Hangup()
    {
      "type": "StasisStart",
      "timestamp": "2026-03-25T07:18:27.423+0300",
      "args": [],
      "channel": {
        "id": "mikopbx-1774412307.28",
        "name": "Local/10003258@internal-incoming-0000000a;2",
        "state": "Up",
        "protocol_id": "",
        "caller": {
          "name": "79257184275",
          "number": "79257184275"
        },
        "connected": {
          "name": "",
          "number": "252"
        },
        "accountcode": "",
        "dialplan": {
          "context": "internal",
          "exten": "10003258",
          "priority": 2,
          "app_name": "Stasis",
          "app_data": "hello-world"
        },
        "creationtime": "2026-03-25T07:18:27.371+0300",
        "language": "en-en"
      },
      "asterisk_id": "82:6a:9e:68:10:11",
      "application": "hello-world"
    }
    curl -u username:password -X POST \
      "https://your-mikopbx.com:8089/asterisk/ari/channels/mikopbx-1774412307.28/play?media=sound:/storage/usbdisk1/mikopbx/media/custom/miko_hello"
    {
      "id": "a0ee0d43-2af5-4250-a303-43825507a06c",
      "media_uri": "sound:/storage/usbdisk1/mikopbx/media/custom/miko_hello",
      "target_uri": "channel:mikopbx-1774412307.28",
      "language": "en-en",
      "state": "playing"
    }
    {
      "type": "StasisEnd",
      "timestamp": "2026-03-25T07:19:44.982+0300",
      "channel": {
        "id": "mikopbx-1774412307.28",
        "name": "Local/10003258@internal-incoming-0000000a;2",
        "state": "Up",
        "protocol_id": "",
        "caller": {
          "name": "79257184275",
          "number": "79257184275"
        },
        "connected": {
          "name": "",
          "number": "252"
        },
        "accountcode": "",
        "dialplan": {
          "context": "internal",
          "exten": "10003258",
          "priority": 2,
          "app_name": "Stasis",
          "app_data": "hello-world"
        },
        "creationtime": "2026-03-25T07:18:27.371+0300",
        "language": "en-en"
      },
      "asterisk_id": "82:6a:9e:68:10:11",
      "application": "hello-world"
    }
    pip install requests websockets
    import asyncio
    import websockets
    import json
    import os
    from datetime import datetime
    
    ARI_HOST = 'your-mikopbx.com'
    ARI_USER = 'ari_user'
    ARI_PASS = 'your-ari-password'
    
    peers = {}
    
    STATES = {
        'NOT_INUSE':   ('🟢', 'Свободен'),
        'BUSY':        ('🔴', 'Занят'),
        'UNAVAILABLE': ('⚫', 'Недоступен'),
    }
    
    def draw():
        print('\033[2J\033[H', end='')
        now = datetime.now().strftime('%H:%M:%S')
        print(f'MikoPBX — монитор присутствия [{now}]')
        print('─' * 50)
        print(f'  {"Номер":<10} {"Имя":<20} {"Статус":<15} {"Обновлён"}')
        print('─' * 50)
        for number, info in sorted(peers.items()):
            icon, label = STATES.get(info['state'], ('❓', info['state']))
            print(f'  {number:<10} {info["name"]:<20} {icon} {label:<12} {info["updated"]}')
        print('─' * 50)
        print(f'  Сотрудников: {len(peers)}')
    
    async def run():
        uri = (
            f"wss://{ARI_USER}:{ARI_PASS}@{ARI_HOST}:8089/asterisk/ari/events"
            f"?app=auto-receptionist&subscribeAll=true"
        )
        async with websockets.connect(uri) as ws:
            draw()
            async for message in ws:
                event = json.loads(message)
                etype = event.get('type')
    
                if etype == 'DeviceStateChanged':
                    ds     = event.get('device_state', {})
                    name   = ds.get('name', '')
                    state  = ds.get('state', '')
    
                    if not name.startswith('PJSIP/'):
                        continue
    
                    number = name.replace('PJSIP/', '')
    
                    if number not in peers:
                        peers[number] = {'name': number, 'state': state, 'updated': '—'}
    
                    peers[number]['state']   = state
                    peers[number]['updated'] = datetime.now().strftime('%H:%M:%S')
                    draw()
    
                elif etype == 'PeerStatusChange':
                    ep     = event.get('endpoint', {})
                    number = ep.get('resource', '')
                    state  = ep.get('state', '')
    
                    if not number:
                        continue
    
                    if number not in peers:
                        peers[number] = {'name': number, 'state': 'unknown', 'updated': '—'}
    
                    if state == 'online':
                        peers[number]['state'] = 'NOT_INUSE'
                    elif state == 'offline':
                        peers[number]['state'] = 'UNAVAILABLE'
    
                    peers[number]['updated'] = datetime.now().strftime('%H:%M:%S')
                    draw()
    
                elif etype == 'ContactStatusChange':
                    ep     = event.get('endpoint', {})
                    number = ep.get('resource', '')
                    ci     = event.get('contact_info', {})
                    status = ci.get('contact_status', '')
    
                    if not number:
                        continue
    
                    if number not in peers:
                        peers[number] = {'name': number, 'state': 'unknown', 'updated': '—'}
    
                    if status == 'Reachable':
                        peers[number]['state'] = 'NOT_INUSE'
                    elif status in ('Unreachable', 'NonQualified'):
                        peers[number]['state'] = 'UNAVAILABLE'
    
                    peers[number]['updated'] = datetime.now().strftime('%H:%M:%S')
                    draw()
    
    asyncio.run(run())
    MikoPBX — монитор присутствия [11:34:43]
    ──────────────────────────────────────────────────
      Номер      Имя                  Статус          Обновлён
    ──────────────────────────────────────────────────
      202        202                  🟢 Свободен     11:34:25
      243        243                  ⚫ Недоступен   11:34:43
      252        252                  🔴 Занят        11:34:41
    ──────────────────────────────────────────────────
      Сотрудников: 3

    Как это работает?

    Настройка ARI пользователя

    Никогда не используйте * в продакшне. Указывайте только доверенные домены по HTTPS.

    Распространенные приложения

    • ari-app: Основное приложение для ARI

    • stasis: Базовое Stasis приложение

    Параметры подключения

    WebSocket

    REST API

    Рекомендуется использовать защищённые подключения (wss:// и https://) с валидным SSL сертификатом. Обычные ws:// и http:// допустимы только в изолированной тестовой среде.

    Пример: Hello World

    Шаг 1 — подключитесь к WebSocket

    Шаг 2 — настройте входящий маршрут

    Шаг 3 — позвоните на номер

    Шаг 4 — воспроизведите звук через REST API

    Используйте id канала из события StasisStart!

    Шаг 5 — завершите звонок

    Пример: монитор присутствия

    external-media: Работа с внешними медиа-потоками

  • bridge-app: Управление мостами вызовов

  • channel-spy:Прослушивание каналов

  • *

    Все источники — только для тестов

    AWS terraform скрипт

    Инструкция по развёртыванию MikoPBX в AWS через Terraform скрипт

    Данное руководство описывает развёртывание MikoPBX в AWS по принципу Infrastructure as Code (IaC) с помощью Terraform. Вся инфраструктура: EC2-инстанс, сетевые правила, диски и IP-адрес - описывается декларативно в коде, что обеспечивает воспроизводимость, версионирование и возможность быстрого повторного развёртывания в любом окружении.

    Общий процесс:

    Скачать .raw  →  Загрузить в S3  →  Импортировать как AMI  →  Развернуть через Terraform

    Импорт образа в AMI нельзя выполнить средствами Terraform напрямую — AWS не поддерживает этот процесс через Terraform-провайдер. Для импорта используется отдельный bash-скрипт, после чего Terraform использует созданный AMI.

    Предварительные требования

    • Terraform >= 1.3.0

    • AWS CLI настроенный с ключами доступа (aws configure)

    • Bash (macOS / Linux)

    • Права IAM: ec2:*, s3:*, iam:CreateRole, iam:PutRolePolicy


    1. Перейдите на страницу релизов MikoPBX:

    Скачайте актуальный образ с расширением .raw

    1. Перейдите в Amazon Web Services.

    1. Далее перейдите в "Services" -> "Storage" -> "S3".

    1. Нажмите "Create bucket". Введите уникальное имя бакета (поле "Bucket name"). Для других полей используйте значения по умолчанию.

    Подтвердите создание бакета, нажав на "Create bucket".

    1. Перейдите в созданный бакет, нажав на его название. Далее нажмите на "Upload" и выберите файл образа диска с расширением ".raw".

    Для подтверждения, нажмите "Upload".


    AWS требует специальную IAM-роль vmimport для импорта образов. Выполните эти шаги один раз для аккаунта.

    Создайте файл trust-policy.json со следующим содержанием:

    Создайте файл role-policy.json со следующим содержанием:

    Замените mikopbx-bucket на имя вашего S3-бакета.

    Выполните следующие команды для применения описанных политик:


    Сохраните скрипт ниже как import-image.sh и отредактируйте переменные DEFAULT_BUCKET, DEFAULT_IMAGE, DEFAULT_NAME

    Запустите скрипт:

    После завершения, скрипт выведет AMI ID — запишите его, он понадобится для Terraform.


    Создайте все следующие файлы (структуру)

    Далее мы пройдемся по каждому файлу и контенту, который необходимо добавить в каждый из них:

    Основной файл конфигурации, описывает все создаваемые ресурсы AWS: EC2-инстанс, Security Group, EBS-диски и Elastic IP. По умолчанию Security Group открывает только порты, необходимые для работы MikoPBX: SSH, HTTP/HTTPS, SIP и RTP.


    Объявляет переменные с их типами, описанием и значениями по умолчанию. Сам по себе не содержит конкретных значений - только схему.


    Определяет, какие данные Terraform выведет после успешного apply: URL веб-интерфейса, логин и пароль для первой авторизации. Удобно для быстрого получения нужных реквизитов без входа в консоль AWS.


    Содержит конкретные значения переменных для вашего окружения: регион, AMI ID, тип инстанса и т.д. Именно этот файл меняется при переезде между окружениями (dev/staging/prod).


    Убедитесь, что все 4 файла созданы, после этого выполните следующие команды:

    После выполнения Вы получите следующий вывод:

    Выполните следующую команду для планирования конфигурации:

    После выполнения Вы увидите конфигурацию, который terraform увидел и собирается создавать. Проверьте все параметры и преступайте к выполнению следующей команды:

    Далее введите yes для подтверждения. В случае успешного создания инстанса с MikoPBX, будут выведены необходимые параметры:


    После успешного terraform apply:

    1. Скопируйте URL из выходных значений

    2. Откройте его в браузере: https://<URL>

    Для входа используйте данные, выведеные при создании инфраструктуры.

    ⚠️ После входа обязательно настройте Firewall в MikoPBX.


    ⚠️ AMI и S3-бакет с образом не удаляются автоматически — их нужно удалить вручную через AWS Console или CLI, если они больше не нужны.


    Причина: AMI существует в другом регионе. Решение: убедитесь, что регион в terraform.tfvars совпадает с регионом, в котором запускался скрипт импорта.

    Причина: роль vmimport не создана или не имеет нужных прав. Решение: повторите .

    Причина: повреждённый .raw-файл или неправильный формат. Решение: проверьте, что скачан оригинальный образ, и укажите правильное имя файла в DEFAULT_IMAGE.

    Импорт большого образа может занять 10–30 минут. Скрипт автоматически ожидает завершения, опрашивая статус каждые 30 секунд.


    Настройка AWS CLI

    Загрузка образа в S3 хранилище

    Настройка IAM-роли для импорта

    Импорт образа как AMI

    import-image.sh

    Развёртывание через Terraform

    main.tf

    Не забудьте настроить firewall в MikoPBX после первой авторизации в систему! Подробнее - здесь.

    variables.tf

    outputs.tf

    terraform.tfvars

    В этом файле укажите Ваши параметры: замените aws_region, instance_name, instance_type, storage_disk_size, allowed_ssh_cidr, create_key_pair, public_key_path если требуется. Обязательно поменяйте custom_ami_id на id Вашего AMI, созданного ранее.

    Запуск Terraform

    Подключение к MikoPBX

    Удаление ресурсов

    Возможные ошибки

    Ошибка: InvalidAMIID.NotFound

    Ошибка: OptInRequired при импорте

    Ошибка: статус импорта error

    Долгий импорт снапшота

    https://github.com/mikopbx/Core/releases
    консоль
    Шаг 2
    Консоль Amazon Web Services
    Раздел "S3" в консоли Amazon Web Services
    Создание бакета для хранения образа
    Загрузка файла в бакет
    Процесс выполенения скрипта по созданию AMI
    aws configure
    # AWS Access Key ID: ваш_ключ
    # AWS Secret Access Key: ваш_секретный_ключ
    # Default region name: us-southeast-1 (Ваш регион)
    # Default output format: json
    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Principal": { "Service": "vmie.amazonaws.com" },
          "Action": "sts:AssumeRole",
          "Condition": {
            "StringEquals": { "sts:Externalid": "vmimport" }
          }
        }
      ]
    }
    {
      "Version": "2012-10-17",
      "Statement": [
        {
          "Effect": "Allow",
          "Action": [
            "s3:GetBucketLocation",
            "s3:GetObject",
            "s3:ListBucket"
          ],
          "Resource": [
            "arn:aws:s3:::mikopbx-bucket",
            "arn:aws:s3:::mikopbx-bucket/*"
          ]
        },
        {
          "Effect": "Allow",
          "Action": [
            "ec2:ModifySnapshotAttribute",
            "ec2:CopySnapshot",
            "ec2:RegisterImage",
            "ec2:Describe*"
          ],
          "Resource": "*"
        }
      ]
    }
    # Создать роль
    aws iam create-role \
      --role-name vmimport \
      --assume-role-policy-document "file://trust-policy.json"
    # Привязать политику к роли
    aws iam put-role-policy \
      --role-name vmimport \
      --policy-name vmimport \
      --policy-document "file://role-policy.json"
    #!/bin/bash
    
    # -----------------------------------------------
    # Настройки — измените под ваши значения
    # -----------------------------------------------
    DEFAULT_IMAGE="mikopbx-2026.1.223-x86_64.raw"
    DEFAULT_BUCKET="mikopbx-bucket"
    DEFAULT_DESCRIPTION="MikoPBX PBX on Asterisk"
    DEFAULT_NAME="MikoPBX 2026.1.223"
    
    # Переопределение через переменные окружения (опционально)
    IMAGE="${IMAGE:-$DEFAULT_IMAGE}"
    BUCKET="${BUCKET:-$DEFAULT_BUCKET}"
    DESCRIPTION="${DESCRIPTION:-$DEFAULT_DESCRIPTION}"
    NAME="${NAME:-$DEFAULT_NAME}"
    
    # -----------------------------------------------
    # Импорт снапшота из S3
    # -----------------------------------------------
    JSON_FILE="disk_container.json"
    
    cat <<EOF > ${JSON_FILE}
    {
      "Description": "${DESCRIPTION} image",
      "Format": "raw",
      "UserBucket": {
        "S3Bucket": "${BUCKET}",
        "S3Key": "${IMAGE}"
      }
    }
    EOF
    
    echo "Запуск импорта снапшота..."
    IMPORT_TASK_ID=$(aws ec2 import-snapshot \
      --description "${DESCRIPTION} image" \
      --disk-container "file://${JSON_FILE}" \
      --query 'ImportTaskId' \
      --output text)
    
    echo "Задача импорта запущена: $IMPORT_TASK_ID"
    
    # Ожидание завершения импорта
    while true; do
      STATUS=$(aws ec2 describe-import-snapshot-tasks \
        --import-task-ids "$IMPORT_TASK_ID" \
        --query 'ImportSnapshotTasks[0].SnapshotTaskDetail.Status' \
        --output text)
      echo "Статус: $STATUS"
      if [ "$STATUS" == "completed" ]; then
        break
      elif [ "$STATUS" == "error" ]; then
        echo "Ошибка импорта!"
        exit 1
      fi
      sleep 30
    done
    
    # Получение ID снапшота
    SNAPSHOT_ID=$(aws ec2 describe-import-snapshot-tasks \
      --import-task-ids "$IMPORT_TASK_ID" \
      --query 'ImportSnapshotTasks[0].SnapshotTaskDetail.SnapshotId' \
      --output text)
    
    echo "Снапшот создан: $SNAPSHOT_ID"
    
    # -----------------------------------------------
    # Регистрация AMI из снапшота
    # -----------------------------------------------
    AMI_ID=$(aws ec2 register-image \
      --name "$NAME" \
      --description "$DESCRIPTION" \
      --architecture x86_64 \
      --sriov-net-support simple \
      --virtualization-type hvm \
      --ena-support \
      --boot-mode uefi \
      --root-device-name "/dev/sda1" \
      --block-device-mappings "[
        {\"DeviceName\": \"/dev/sda1\", \"Ebs\": {
          \"DeleteOnTermination\": true,
          \"VolumeSize\": 1,
          \"SnapshotId\": \"$SNAPSHOT_ID\"
        }},
        {\"DeviceName\": \"/dev/sdb\", \"Ebs\": {\"VolumeSize\": 50}}
      ]" \
      --query 'ImageId' \
      --output text)
    
    echo ""
    echo "=========================================="
    echo "AMI успешно создан: $AMI_ID"
    echo "Используйте этот ID в terraform.tfvars:"
    echo "  custom_ami_id = \"$AMI_ID\""
    echo "=========================================="
    
    # Удаление временного файла
    rm -f "$JSON_FILE"
    sh import-image.sh
    ==========================================
    AMI успешно создан: ami-0c8820696110d0613
    Используйте этот ID в terraform.tfvars:
      custom_ami_id = "ami-0c8820696110d0613"
    ==========================================
    mikopbx-aws-custom/
    ├── main.tf
    ├── variables.tf
    ├── outputs.tf
    ├── terraform.tfvars
    terraform {
      required_providers {
        aws = {
          source  = "hashicorp/aws"
          version = "~> 5.0"
        }
      }
      required_version = ">= 1.3.0"
    }
    
    provider "aws" {
      region = var.aws_region
    }
    
    # --------------------------------------------------
    # Security Group
    # --------------------------------------------------
    resource "aws_security_group" "mikopbx_sg" {
      name        = "${var.instance_name}-sg"
      description = "Security group for MikoPBX"
    
      ingress {
        from_port   = 22
        to_port     = 22
        protocol    = "tcp"
        cidr_blocks = [var.allowed_ssh_cidr]
        description = "SSH"
      }
    
      ingress {
        from_port   = 443
        to_port     = 443
        protocol    = "tcp"
        cidr_blocks = ["0.0.0.0/0"]
        description = "HTTPS web UI"
      }
    
      ingress {
        from_port   = 80
        to_port     = 80
        protocol    = "tcp"
        cidr_blocks = ["0.0.0.0/0"]
        description = "HTTP"
      }
    
      ingress {
        from_port   = 5060
        to_port     = 5060
        protocol    = "udp"
        cidr_blocks = ["0.0.0.0/0"]
        description = "SIP UDP"
      }
    
      ingress {
        from_port   = 5060
        to_port     = 5060
        protocol    = "tcp"
        cidr_blocks = ["0.0.0.0/0"]
        description = "SIP TCP"
      }
    
      ingress {
        from_port   = 10000
        to_port     = 10200
        protocol    = "udp"
        cidr_blocks = ["0.0.0.0/0"]
        description = "RTP media"
      }
    
      egress {
        from_port   = 0
        to_port     = 0
        protocol    = "-1"
        cidr_blocks = ["0.0.0.0/0"]
      }
    
      tags = {
        Name = "${var.instance_name}-sg"
      }
    }
    
    # --------------------------------------------------
    # SSH Key Pair (опционально)
    # --------------------------------------------------
    resource "aws_key_pair" "mikopbx_key" {
      count      = var.create_key_pair ? 1 : 0
      key_name   = "${var.instance_name}-key"
      public_key = file(pathexpand(var.public_key_path))
    }
    
    # --------------------------------------------------
    # EC2 Instance с кастомным AMI
    # --------------------------------------------------
    resource "aws_instance" "mikopbx" {
      # Используем AMI, созданный скриптом import-image.sh
      ami           = var.custom_ami_id
      instance_type = var.instance_type
    
      key_name               = var.create_key_pair ? aws_key_pair.mikopbx_key[0].key_name : var.existing_key_pair_name
      vpc_security_group_ids = [aws_security_group.mikopbx_sg.id]
    
      # Системный диск (1 ГБ)
      root_block_device {
        volume_size = 1
        volume_type = "gp3"
      }
    
      tags = {
        Name = var.instance_name
      }
    }
    
    # --------------------------------------------------
    # Диск для записей звонков (50+ ГБ)
    # --------------------------------------------------
    resource "aws_ebs_volume" "mikopbx_storage" {
      availability_zone = aws_instance.mikopbx.availability_zone
      size              = var.storage_disk_size
      type              = "gp3"
    
      tags = {
        Name = "${var.instance_name}-storage"
      }
    }
    
    resource "aws_volume_attachment" "storage_attach" {
      device_name = "/dev/sdc"
      volume_id   = aws_ebs_volume.mikopbx_storage.id
      instance_id = aws_instance.mikopbx.id
    }
    
    # --------------------------------------------------
    # Elastic IP
    # --------------------------------------------------
    resource "aws_eip" "mikopbx_eip" {
      instance = aws_instance.mikopbx.id
      domain   = "vpc"
    
      tags = {
        Name = "${var.instance_name}-eip"
      }
    }
    variable "aws_region" {
      description = "AWS регион"
      type        = string
      default     = "us-east-1"
    }
    
    variable "custom_ami_id" {
      description = "ID кастомного AMI, созданного скриптом import-image.sh"
      type        = string
      # Значение обязательно передать через terraform.tfvars
    }
    
    variable "instance_name" {
      description = "Имя EC2-инстанса"
      type        = string
      default     = "mikopbx-vm"
    }
    
    variable "instance_type" {
      description = "Тип EC2-инстанса"
      type        = string
      default     = "t3.micro"
    }
    
    variable "storage_disk_size" {
      description = "Размер диска для записей (ГБ)"
      type        = number
      default     = 50
    }
    
    variable "allowed_ssh_cidr" {
      description = "CIDR для SSH-доступа"
      type        = string
      default     = "0.0.0.0/0"
    }
    
    variable "create_key_pair" {
      description = "Создать SSH Key Pair (true) или использовать существующую (false)"
      type        = bool
      default     = true
    }
    
    variable "public_key_path" {
      description = "Путь к публичному SSH-ключу"
      type        = string
      default     = "~/.ssh/id_rsa.pub"
    }
    
    variable "existing_key_pair_name" {
      description = "Имя существующей Key Pair (если create_key_pair = false)"
      type        = string
      default     = ""
    }
    output "first_login" {
      description = "Данные для первого входа в веб-интерфейс MikoPBX"
      value = <<-EOT
    
        ======================================
         MikoPBX готова к работе!
        ======================================
         URL:      https://${aws_eip.mikopbx_eip.public_ip}
         Логин:    admin
         Пароль:   ${aws_instance.mikopbx.id}
        ======================================
    
      EOT
    }
    aws_region        = "ap-southeast-1"
    custom_ami_id     = "ami-0c8820696110d0613"   # <- ID из скрипта import-image.sh
    instance_name     = "mikopbx-vm"
    instance_type     = "t3.micro"
    storage_disk_size = 50
    allowed_ssh_cidr  = "0.0.0.0/0"
    create_key_pair   = true
    public_key_path   = "~/.ssh/id_rsa.pub"
    cd mikopbx-aws-custom #Перейдите в директорию с созданными файлами
    
    terraform init
    Terraform has been successfully initialized!
    
    You may now begin working with Terraform. Try running "terraform plan" to see
    any changes that are required for your infrastructure. All Terraform commands
    should now work.
    
    If you ever set or change modules or backend configuration for Terraform,
    rerun this command to reinitialize your working directory. If you forget, other
    commands will detect it and remind you to do so if necessary.
    terraform plan
    terraform apply
    ======================================
     MikoPBX готов к работе!
    ======================================
     URL:      https://52.221.99.139
     Логин:    admin
     Пароль:   i-007352c23fa6d3b01
    ======================================
    terraform destroy
    # Удалить AMI
    aws ec2 deregister-image --image-id ami-0a1b2c3d4e5f67890
    
    # Удалить снапшот (ID можно найти в AWS Console → EC2 → Snapshots)
    aws ec2 delete-snapshot --snapshot-id snap-xxxxxxxxxxxxxxxxx
    
    # Удалить файл из S3
    aws s3 rm s3://mikopbx-bucket/mikopbx-2026.1.223-x86_64.raw
    
    # Удалить бакет (если пустой)
    aws s3 rb s3://mikopbx-bucket
    Error: InvalidAMIID.NotFound: The image id 'ami-xxxx' does not exist
    Error: OptInRequired
    Статус: error
    Ошибка импорта!

    Сотрудники

    Настройка сотрудников и основных телефонных номеров

    Сотрудники в MikoPBX - это индивидуальные пользователи системы, которым назначены внутренние номера для совершения и приема звонков. Они имеют персональные учетные записи, позволяющие настроить права доступа, переадресацию вызовов и другие персональные настройки в системе.

    В разделе Сотрудники представлен список внутренних учетных записей сотрудников. Слева от сотрудника отображается статус авторизованного устройства. Если устройство успешно авторизовано под данной внутренней учетной записью, то кружок отображается зеленым цветом, иначе серым.

    В строке поиска можно найти необходимый контакт. Поиск можно осуществлять по имени сотрудника, внутреннему номеру, мобильному номеру, адресу электронной почты.

    На форме также есть возможность сортировки списка сотрудников по имени, внутреннему номеру, мобильному номеру, адресу электронной почты. Имеются кнопки копирования пароля для SIP учетной записи в буфер обмена, редактирования учетной записи и её удаления.

    Сортировка сотрудников и функции в главном меню

    Для добавления нового сотрудника необходимо нажать кнопку Добавить сотрудника.

    Элемент "Добавить нового сотрудника"

    Существует возможность экспорта и импорта сотрудников для удобства настройки. Для этого, нажмите для стрелочку справа от кнопки "Добавить нового сотрудника".

    Доступны 3 опции:

    1. Импорт из CSV - загрузить сотрудников из CSV файла в MikoPBX.

    2. Экспорт в CSV - загрузить сотрудников в CSV файл из MikoPBX (сотрудники не будут удалены со станции).

    3. Скачать шаблон - загрузить шаблон CSV таблицы для заполнения и дальнейшего импорта в MikoPBX.

    Возможности для группового импорта/экспорта сотрудников

    Нажмите на "Выбрать CSV файл" и выберите ранее оформленный файл с данными в таблице. Рекомендуется использовать шаблоны из вкладки "Шаблон".

    Раздел "Импорт"

    После выбора файла, будет отображена информация по всем обнаруженным пользователям в таблице. Выберите стратегию обработки дубликатов и нажмите "Подтвердить импорт" для начала процесса.

    Параметры импорта сотрудников

    После окончания процесса, Вы увидите статус создания сотрудников, а так же уведомление об окончании импорта.

    Нажмите "Назад к списку" для возвращения к списку сотрудников.

    Успешный импорт сотрудников

    Существует возможность экспорта CSV файла со всеми данными текущих сотрудников. Есть несколько форматов экспорта:

    Минимальный:

    • number - Внутренний номер (обязательное)

    • user_username - ФИО сотрудника (обязательное)

    • user_email - Email адрес

    • mobile_number - Мобильный номер

    • sip_secret - Пароль SIP (если не указать будет сгенерирован)

    • fwd_ringlength - Время звонка (секунды) до переадресации

    • fwd_forwarding - Номер переадресации если не ответил

    Стандартный:

    • Все параметры из Минимального.

    • mobile_dialstring - Номер для набора мобильного

    • sip_dtmfmode - DTMF режим (auto/rfc4733/info/inband/auto_info)

    • sip_transport - Транспорт (udp/tcp/tls), по умолчанию udp,tcp

    • sip_enableRecording - Запись разговоров (true/false)

    • fwd_forwardingonbusy - Номер переадресации если занят

    • fwd_forwardingonunavailable - Номер переадресации если недоступен

    Полный:

    • Все параметры из Минимального и Стандартного.

    • user_avatar - URL фотографии

    • sip_acceptMultipleCalls - Принимать несколько вызовов одновременно (true/false)

    • sip_manualattributes - Дополнительные SIP параметры

    Так же Вы можете указать диапазон внутренних номеров сотрудников, которых необходимо экспортировать (раздел "Фильтр по диапазону номеров").

    Нажмите "Экспортировать сотрудников". Файл будет загружен на Ваше устройство.

    Раздел "Экспорт"

    На этой вкладке Вы можете скачать шаблон пустого файла с указанными "столбцами" для заполнения и дальнейшего импорта в MikoPBX.

    Выберите формат шаблона (подробнее в разделе "Экспорт"), нажмите "Скачать CSV шаблон".

    Раздел "Шаблон"
    Вкладка параметров учетной записи сотрудника

    На вкладке Основные параметры задаются общие настройки внутренней учетной записи сотрудника:

    • ФИО пользователя - допускается использование кириллицы. Это значение будет использоваться при подстановке CALLERID(name) абонента, будет отображаться в соответствующем поле экрана телефона.

    • Внутренний номер - он же используется в качестве Логин при подключении телефона.

    • Мобильный номер - используется для дополнительной маршрутизации.

    • Адрес электронной почты - используется для email оповещений.

    • Пароль для SIP

    Открываются путем нажатия на раскрывающийся список Расширенные настройки.

    Вкладка расширенных настроек учетной записи

    В поле Переопределение строки набора введите правило набора мобильного номера для Вашего провайдера. Например, в основных настройках номер мобильного телефона указан в формате 89164577878, согласно правилам исходящей маршрутизации для провайдера звонок возможен только на номера, начинающиеся с 7. Следовательно в поле Переопределение строки набора следует указать номер 79164577878.

    Переключатель определяет поведение, когда сотруднику поступает новый вызов во время текущего разговора.

    • Если настройка выключена, сотрудник считается занятым уже при первом активном разговоре. Второй вызов пойдет по правилам переадресации по занятости.

    • Если настройка включена, телефон сотрудника может получить второй вызов в режиме ожидания вызова (call waiting). Сотрудник сможет принять его, удержать текущий разговор или отклонить новый вызов.

    Если нужно задать порог в три и более одновременных вызова, используйте поле Дополнительные атрибуты PJSIP, например:

    Настройка определяет, как DTMF-сигналы передаются через SIP.

    Позволяет указать используемый транспортный протокол для данной учетной записи.

    Подсеть, которая описана в разделе Cетевой экран. Указывает на разрешенную подсеть для этой учетной записи. Подключение из прочих подсетей будет вызывать ошибку авторизации.

    Дополнительные атрибуты PJSIP

    Данное поле служит для изменения или переопределения параметров PJSIP, которые MikoPBX генерирует для Asterisk.

    Переопределять можно практически все параметры. К примеру при использовании chan_pjsip SIP аккаунт сотрудника описывается следующими секциями:

    Для переопределения полей в секциях следует заполнить поле Дополнительные параметры следующим образом:

    Раздел "Настройки маршрутизации"

    На данной вкладке вы можете настроить правила переадресации вызовов в случае, если сотрудник не может ответить на звонок, занят или недоступен.

    Период времени в секундах определяет, сколько времени будет продолжаться попытка вызова на внутреннюю учетную запись сотрудника. Если в течение этого времени сотрудник не сможет ответить на вызов, вы можете указать на какой номер следует направить вызов дальше. По умолчанию, вызов будет переадресован на мобильный номер сотрудника.

    Кроме того, вы можете указать номера, на которые следует направить вызов в случае занятости и недоступности сотрудника. Таким образом, если сотрудник занят или недоступен, вызов будет переадресован на указанные номера.

    Вы можете настроить эти параметры в соответствии с вашими предпочтениями и требованиями.

    Список сотрудников

    Статусы сотрудников
    Поиск сотрудника по электронной почте
    [endpoint]
    device_state_busy_at = 3
    [***]
    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
    ; ----
    [acl]
    ; описываем параметры доступа из различных подсетей [acl_***]
    
    [auth]
    ; описываем параметры авторизации для исходящих звонков
    
    [aor]
    ; Правка секции AOR для endpoint
    
    [endpoint]
    ; Правка параметров endpoint

    Добавление сотрудника

    Существует два способа добавления сотрудников:

    1) Поштучное добавление с вводом данных в Web-интерфейсе.

    2) Импорт нескольких сотрудников из CSV файла.

    Поштучное добавление сотрудников

    Импорт и экспорт сотрудников из CSV файла

    Импорт

    Экспорт

    Шаблон

    Основные параметры учетной записи

    Установите сложные пароли на учетные записи (пароль для SIP)! Пароль должен удовлетворять следующим требованиям:

    • длина пароля должна быть длиннее восьми символов;

    Расширенные параметры учетной записи

    Переопределение строки набора

    Принимать несколько вызовов одновременно

    Режим DTMF

    Транспортный протокол

    Сетевой фильтр

    Настройки маршрутизации

    Документации по подключению софтфонов

    Документации по подключению IP-телефонов

    Настройка софтфонов
    IP-Телефоны
    пароль должен содержать буквы ВЕРХНЕГО и нижнего регистра;
  • пароль должен содержать цифры и специальные знаки: «-», «_», «[]», «{}», «@», «;».

  • Примеры использования REST API

    Инструкция с примерами по созданию и использованию API-ключей

    Работа с REST API построена по стандарту OpenAPI. Для получения актуального списка эндпоинтов используйте раздел «Документация» внутри АТС. Ниже приведены примеры работы с основными возможностями REST интерфейса MikoPBX.

    Если у вас отсутствует доверенный сертификат — добавьте verify=False в каждый запрос и отключите предупреждения:

    Настоятельно рекомендуется выпустить доверенный сертификат. Самый простой способ сделать это — с помощью .

    Подключение

    Для выполнения всех примеров из этой инструкции создайте API-ключ и настройте следующие права доступа (подробнее в ):

    Ресурс
    Уровень доступа
    Для каких примеров

    В этой статье, мы будем работать с Python, поэтому необходимо установить необходимые зависимости:

    Ниже приведён шаблон подключения к станции через API-ключ. Используйте его перед всеми скриптами из этой инструкции. API-ключ передаётся напрямую в заголовке запроса — никакой дополнительной аутентификации не требуется:

    Эндпоинт: POST /pbxcore/api/v3/employees

    Ниже приведена таблица с параметрами для такого запроса.

    Поле
    Обяз.
    Тип / ограничения
    Описание

    Пример ответа API (HTTP 201):

    Возможные коды ответов:

    Код
    Описание

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    На станции будут созданы сотрудники 243 и 244.

    В случае успешного выполнения запроса Вы увидите следующий вывод в консоль:

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    На станции будут создано 3 сотрудника.

    Эндпоинт: POST /pbxcore/api/v3/sip-providers

    Поле
    Обяз.
    Тип
    Описание

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    На станции будет создан провайдер:

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    Эндпоинт: GET /pbxcore/api/v3/cdr — только чтение.

    Параметр
    Тип
    Описание

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    Поле
    Тип
    Описание

    Эндпоинты: GET /pbxcore/api/v3/sip , GET /pbxcore/api/v3/sip-providers

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    Статусы сотрудников (поле status)

    Значение
    Описание

    Статусы провайдеров (поле state)

    Значение
    Описание

    Эндпоинт: GET /pbxcore/api/v3/pbx-status

    В случае успешного выполнения запроса вы увидите следующий вывод в консоль:

    Полный список эндпоинтов и интерактивная документация — в разделе

    string, 1–100 символов

    ФИО сотрудника

    sip_secret

    ✅

    string, 5–100 символов

    Пароль SIP-аккаунта

    user_email

    —

    string email, ≤255

    Email для уведомлений

    mobile_number

    —

    string E.164, ≤50

    Мобильный (+7...) для переадресации

    mobile_dialstring

    —

    string, ≤255

    Строка набора мобильного

    sip_transport

    —

    udp / tcp / tls / udp,tcp

    Транспорт SIP (по умолч.: udp)

    sip_dtmfmode

    —

    auto / rfc4733 / inband / info

    Режим DTMF (по умолч.: auto)

    sip_enableRecording

    —

    boolean

    Запись разговоров (по умолч.: true)

    sip_networkfilterid

    —

    number | "none"

    ID сетевого фильтра

    sip_manualattributes

    —

    string, ≤1024

    Дополнительные SIP-параметры

    fwd_ringlength

    —

    integer, ≤180

    Время дозвона до переадресации (сек, по умолч.: 45)

    fwd_forwarding

    —

    number | hangup | busy

    Безусловная переадресация

    fwd_forwardingonbusy

    —

    number | hangup | busy

    Переадресация при занятости

    fwd_forwardingonunavailable

    —

    number | hangup | busy

    Переадресация при недоступности

    403

    Нет прав на запись для ресурса /employees

    409

    Конфликт — номер уже занят

    string

    Адрес SIP-сервера провайдера

    username

    —

    string

    Логин на сервере провайдера

    secret

    —

    string

    Пароль

    registration_type

    —

    string

    inbound / outbound / none

    qualify

    —

    boolean

    Мониторинг доступности (по умолч.: true)

    transport

    —

    string

    udp / tcp / tls / udp,tcp (по умолч.: udp,tcp)

    dtmfmode

    —

    string

    auto / rfc4733 / inband / info (по умолч.: auto)

    port

    —

    integer

    Порт подключения (по умолч.: 5060)

    disabled

    —

    boolean

    Отключить провайдера (по умолч.: false)

    dateFrom

    string

    Начало периода: %Y-%m-%dT%H:%M:%S

    dateTo

    string

    Конец периода: %Y-%m-%dT%H:%M:%S

    src_num

    string

    Фильтр по номеру звонящего

    dst_num

    string

    Фильтр по номеру назначения

    disposition

    string

    ANSWERED / NO ANSWER / BUSY / FAILED

    src_num

    string

    Номер звонящего

    src_name

    string

    Имя звонящего

    dst_num

    string

    Номер назначения

    dst_name

    string

    Имя вызываемого

    disposition

    string

    ANSWERED / NO ANSWER / NOANSWER / BUSY / CHANUNAVAIL / FAILED

    totalBillsec

    integer

    Длительность разговора (секунды)

    totalDuration

    integer

    Полная длительность (включая дозвон)

    records

    array

    Детальные записи по каждому плечу звонка

    records[].recordingfile

    string

    Путь к файлу записи

    records[].playback_url

    string

    URL для воспроизведения записи

    records[].download_url

    string

    URL для скачивания записи

    records[].dtmf_digits

    string

    DTMF цифры, нажатые в IVR

    Employees Management

    Чтение и запись

    Создание и редактирование сотрудников

    Providers

    Чтение и запись

    Создание и редактирование провайдеров

    SIP

    Чтение

    Статусы регистрации сотрудников и транков

    Call Records

    Чтение

    История звонков (CDR)

    PBX Status

    Чтение

    Активные звонки в реальном времени

    SIP Providers

    Чтение и запись

    Создание и редактирование SIP провайдеров

    number

    ✅

    string, 2–8 цифр

    Добавочный номер

    user_username

    201

    Сотрудник успешно создан

    400

    Ошибка валидации (слабый пароль <5 символов, неверный формат номера)

    401

    Неверный или отсутствующий API-ключ

    description

    ✅

    string

    Название провайдера

    host

    offset

    integer

    Смещение для пагинации (по умолч.: 0)

    limit

    integer

    Кол-во записей, макс. 100

    linkedid

    string

    Уникальный идентификатор звонка

    start

    datetime

    Время начала звонка

    Available

    Зарегистрирован и доступен

    Unavailable

    Не зарегистрирован (оффлайн)

    registered

    Зарегистрирован на сервере провайдера

    rejected

    Регистрация отклонена сервером

    unregistered

    Не зарегистрирован

    В шаблоне замените следующие параметры:

    • your-mikopbx.com — на IP-адрес или URL вашей станции.

    • ваш-api-ключ — на ранее созданный API-ключ с необходимыми правами.

    Работа с сотрудниками

    Создание одного сотрудника

    Вывод списка сотрудников

    Массовое создание сотрудников

    Работа с SIP-провайдерами

    Создание провайдера

    Вывод списка всех провайдеров

    Вывод истории звонков (CDR)

    Статистика за период

    Звонки со статусом CHANUNAVAIL не учитываются в статистике «Отвечено», «Пропущено», «Средняя длит.».

    Поля CDR-записи

    Мониторинг: статусы SIP и активные звонки

    Статусы регистрации сотрудников и SIP-провайдеров

    Активные звонки в реальном времени

    общей статье
    Интерактивная документация и список эндпоинтов.
    модуля Let's Encrypt
    Пример настройки прав доступа (разрешение Call Records)
    Созданные сотрудники с помощью REST API
    Созданные сотрудники с помощью REST API
    Созданный провайдер с помощью REST API

    ✅

    ✅

    pip install requests
    import requests
    
    BASE_URL = 'https://your-mikopbx.com/pbxcore/api/v3'
    API_KEY  = 'ваш-api-ключ'
    
    HEADERS = {
        'Authorization': f'Bearer {API_KEY}',
        'Content-Type':  'application/json',
    }
    def create_employee(
        number: str,
        name: str,
        sip_secret: str,
        email: str = '',
        mobile: str = '',
        record_calls: bool = True,
        fwd_ringlength: int = 45,
    ) -> dict:
        payload = {
            'number':              number,
            'user_username':       name,
            'sip_secret':          sip_secret,
            'sip_enableRecording': record_calls,
            'fwd_ringlength':      fwd_ringlength,
        }
        if email:  payload['user_email']    = email
        if mobile: payload['mobile_number'] = mobile
    
        r = requests.post(f'{BASE_URL}/employees', headers=HEADERS, json=payload)
        result = r.json()
        if result.get('result'):
            print(f" Создан: {number} ({name}), id={result['data']['id']}")
        else:
            print(f" Ошибка: {result.get('messages', {}).get('error', [])}")
        return result
    
    
    # Минимальный пример (только обязательные поля)
    create_employee(
        number='243',
        name='Иванов Иван',
        sip_secret='Secure#Pass9201',
    )
    
    # Полный пример
    create_employee(
        number='244',
        name='Петрова Анна',
        sip_secret='Secure#Pass9202',
        email='anna@company.ru',
        mobile='79001234567',
        record_calls=True,
        fwd_ringlength=30,
    )
    {
      "result": true,
      "data": {
        "number": "201",
        "user_username": "Иванов Иван",
        "sip_secret": "Secure#Pass9201",
        "sip_dtmfmode": "auto",
        "sip_transport": "udp",
        "sip_enableRecording": true,
        "sip_networkfilterid": "none",
        "fwd_ringlength": 45,
        "id": "1",
        "extensions_length": 3
      },
      "messages": {"error": [], "info": [], "warning": []}
    }
     Создан: 243 (Иванов Иван), id=113
     Создан: 244 (Петрова Анна), id=114
    
    Process finished with exit code 0
    def list_employees(search: str = '', limit: int = 100, offset: int = 0) -> list:
        params = {'limit': limit, 'offset': offset}
        if search: params['search'] = search
        r = requests.get(f'{BASE_URL}/employees', headers=HEADERS, params=params)
        return r.json().get('data', {}).get('data', [])
    
    for emp in list_employees():
        print(f"  {emp.get('number'):>6}  {emp.get('user_username', '')}")
         202  Brown Brandon
         203  Collins Melanie
         201  Smith James
         243  Иванов Иван
         244  Петрова Анна
    
    Process finished with exit code 0
    import time
    
    employees = [
        {'number': '251', 'name': 'Иванов Иван',  'secret': 'Pass#9201'},
        {'number': '252', 'name': 'Петрова Анна', 'secret': 'Pass#9202'},
        {'number': '253', 'name': 'Сидоров Пётр', 'secret': 'Pass#9203'},
    ]
    
    created, failed = [], []
    for emp in employees:
        r = requests.post(
            f'{BASE_URL}/employees',
            headers=HEADERS,
            json={
                'number':        emp['number'],
                'user_username': emp['name'],
                'sip_secret':    emp['secret'],
            }
        )
        result = r.json()
        if result.get('result'):
            created.append(emp['number'])
            print(f" {emp['number']} {emp['name']}")
        else:
            failed.append(emp['number'])
            print(f" {emp['number']}: {result.get('messages', {}).get('error', [])}")
        time.sleep(0.2)  # небольшая пауза между запросами
    
    print(f'Создано: {len(created)}, Ошибок: {len(failed)}')
     251 Иванов Иван
     252 Петрова Анна
     253 Сидоров Пётр
    Создано: 3, Ошибок: 0
    
    Process finished with exit code 0
    def create_sip_provider(
        description: str,
        host: str,
        username: str = '',
        password: str = '',
        registration_type: str = 'outbound',
        qualify: bool = True,
    ) -> dict:
        payload = {
            'description': description,
            'host':        host,
        }
        if username:          payload['username']          = username
        if password:          payload['secret']            = password
        if registration_type: payload['registration_type'] = registration_type
        if not qualify:       payload['qualify']           = qualify
    
        r = requests.post(f'{BASE_URL}/sip-providers', headers=HEADERS, json=payload)
        result = r.json()
        if result.get('result'):
            print(f" Провайдер создан: {description}")
        else:
            print(f" Ошибка: {result.get('messages', {}).get('error', [])}")
        return result
    
    
    create_sip_provider(
        description='Zadarma',
        host='sip.zadarma.com',
        username='316811',
        password='mysecretpass',
    )
     Провайдер создан: Zadarma
    
    Process finished with exit code 0
    def list_providers() -> list:
        r = requests.get(f'{BASE_URL}/sip-providers', headers=HEADERS)
        return r.json().get('data', [])
    
    for prov in list_providers():
        print(f"  {prov.get('id'):<20} {prov.get('description', '')}  [{prov.get('type', '')}]")
      SIP-TRUNK-34F7CAFE     [SIP]
      SIP-TRUNK-7B5977ED     [SIP]
    
    Process finished with exit code 0
    from datetime import datetime, timedelta
    
    def get_cdr(
        offset: int = 0,
        limit: int = 20,
        date_from: str = None,
        date_to: str = None,
        src_num: str = None,
        dst_num: str = None,
        disposition: str = None,
    ) -> list:
        params = {'offset': offset, 'limit': min(limit, 100)}
        if date_from:   params['dateFrom'] = date_from
        if date_to:     params['dateTo']   = date_to
        if src_num:     params['src_num']  = src_num
        if dst_num:     params['dst_num']  = dst_num
        if disposition: params['disposition'] = disposition
    
        r = requests.get(f'{BASE_URL}/cdr', headers=HEADERS, params=params)
        return r.json().get('data', {}).get('records', [])
    
    
    now  = datetime.now()
    then = now - timedelta(days=7)
    
    for row in get_cdr(
        date_from=then.strftime('%Y-%m-%dT%H:%M:%S'),
        date_to=now.strftime('%Y-%m-%dT%H:%M:%S'),
    ):
        print(
            str(row.get('start', ''))[:16],
            row.get('src_num', ''), '→', row.get('dst_num', ''),
            row.get('disposition', ''), row.get('totalBillsec', 0), 'с'
        )
    2026-03-17 13:30 252 → 202 ANSWERED 48 с
    2026-03-17 13:30 243 → 252 BUSY 0 с
    2026-03-17 13:30 243 → 89161111111 CHANUNAVAIL 0 с
    2026-03-17 13:29 202 → 243 NOANSWER 0 с
    2026-03-17 13:29 202 → 202 ANSWERED 2 с
    2026-03-17 13:29 202 → 243 NOANSWER 0 с
    2026-03-17 13:29 202 → 10003246 NOANSWER 0 с
    2026-03-17 13:28 202 → 243 NOANSWER 0 с
    
    Process finished with exit code 0
    def cdr_stats(days: int = 1) -> dict:
        now  = datetime.now()
        then = now - timedelta(days=days)
        records = get_cdr(
            date_from=then.strftime('%Y-%m-%dT%H:%M:%S'),
            date_to=now.strftime('%Y-%m-%dT%H:%M:%S'),
            limit=100
        )
        answered  = [r for r in records if r.get('disposition') == 'ANSWERED']
        missed = [r for r in records if r.get('disposition') in ('NO ANSWER', 'NOANSWER')]
        total_dur = sum(r.get('totalBillsec', 0) for r in answered)
        return {
            'total':    len(records),
            'answered': len(answered),
            'missed':   len(missed),
            'avg_sec':  total_dur // len(answered) if answered else 0,
        }
    
    stats = cdr_stats(days=7)
    print(f"Звонков за 7 дней: {stats['total']}")
    print(f"Отвечено:          {stats['answered']}")
    print(f"Пропущено:         {stats['missed']}")
    print(f"Средняя длит.:     {stats['avg_sec']}с")
    Звонков за 7 дней: 13
    Отвечено:          2
    Пропущено:         5
    Средняя длит.:     25с
    
    Process finished with exit code 0
    from datetime import datetime
    
    def show_employees():
        r = requests.get(f'{BASE_URL}/sip:getStatuses', headers=HEADERS)
        peers = r.json().get('data', {})
        for number, info in peers.items():
            icon = '🟢' if info.get('status') == 'Available' else '🔴'
            print(f"  {icon}  {number:>6}  {info.get('callerid', '')}  [{info.get('status', '')}]")
    
    
    def show_providers():
        r = requests.get(f'{BASE_URL}/sip-providers:getStatuses', headers=HEADERS)
        providers = r.json().get('data', {}).get('sip', {})
        for prov_id, info in providers.items():
            icon = '🟢' if info.get('state') == 'registered' else '🔴'
            print(f"  {icon}  {info.get('description', prov_id):>20}  {info.get('username', '')}@{info.get('host', '')}  [{info.get('state', '')}]")
    
    
    if __name__ == '__main__':
        print(f'MikoPBX Monitor [{datetime.now().strftime("%Y-%m-%d %H:%M:%S")}]')
        print('\n── Сотрудники ──────────────────────────────')
        show_employees()
        print('\n── Провайдеры ───────────────────────────────')
        show_providers()
    MikoPBX Monitor [2026-03-17 16:47:35]
    
    ── Сотрудники ──────────────────────────────
      🔴     201  Smith James  [Unavailable]
      🟢     202  Brown Brandon  [Available]
      🔴     203  Collins Melanie  [Unavailable]
      🔴     243  Иванов Иван  [Unavailable]
      🟢     244  Петрова Анна  [Available]
      🔴     251  Иванов Иван  [Unavailable]
      🟢     252  Петрова Анна  [Available]
      🔴     253  Сидоров Пeтр  [Unavailable]
    
    ── Провайдеры ───────────────────────────────
      🔴         Demo provider  SIP-PROVIDER-122642725b9265fd7151c@demo.askozia.ru  [rejected]
      🟢               Zadarma  316811@sip.zadarma.com  [registered]
    
    Process finished with exit code 0
    def get_active_calls() -> list:
        r = requests.get(f'{BASE_URL}/pbx-status:getActiveCalls', headers=HEADERS)
        return r.json().get('data', [])
    
    calls = get_active_calls()
    
    print(f'Активных звонков: {len(calls)}')
    for call in calls:
        print(f"  {call.get('src_num', '?')} → {call.get('dst_num', '?')}  [{call.get('src_name', '')} → {call.get('dst_name', '')}]")
    Активных звонков: 1
      243 → 252  [Иванов Иван → Петрова Анна]
    
    Process finished with exit code 0
    import urllib3
    urllib3.disable_warnings()

    Интерактивная документация и список эндпоинтов

    Описание документации и таблицы эндпоинтов для работы с REST API в MikoPBX

    Работа с REST API MikoPBX построена по стандарту OpenAPI. Интерактивная документация встроена прямо в АТС и всегда содержит актуальный список эндпоинтов, параметров и схем для вашей версии системы.

    Как открыть документацию

    1. Перейдите в раздел «Система» → «API ключи».

    Раздел "Система" -> "API ключи"
    1. Нажмите кнопку «Документация API».

    Документация построена на базе стандарта OpenAPI и предоставляет полное описание всех эндпоинтов REST API MikoPBX.

    Навигация по эндпоинтам — в левой панели все эндпоинты сгруппированы по разделам.

    Для каждого эндпоинта отображается краткое описание, метод запроса (GET, POST, PUT, PATCH, DELETE), endpoint с подставленым адресом АТС. Ниже отображаются все доступные параметры запроса.

    Примеры кода — для каждого эндпоинта доступны готовые примеры запросов на разных языках. Переключатель находится под панелью параметров — по умолчанию показывается Shell / cURL, доступны также и другие языки (нажмите на название языка для его смены - в этой инструкции Python 3).

    Ниже находится пример ответа сервера.

    Выполнение запросов онлайн — документация позволяет отправлять реальные запросы прямо из браузера и получать ответы от вашей АТС. Сервер определяется автоматически по адресу текущей страницы.

    Внизу страницы Вы найдете возможные номера ответов на запрос и краткое пояснение к ним. Так же будут отображены все параметры тела выбранного ответа.

    Базовый префикс всех путей: /pbxcore/api/v3

    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание

    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание

    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание

    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание

    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание
    Метод
    Путь
    Описание

    • — экспорт решений о блокировке для внешних bouncer'ов (CrowdSec-совместимый формат). Доступен с MikoPBX 2026.1.76.

    GET

    /employees/{id}

    Получить сотрудника по ID

    PUT

    /employees/{id}

    Обновить сотрудника

    PATCH

    /employees/{id}

    Частично обновить сотрудника

    DELETE

    /employees/{id}

    Удалить сотрудника

    GET

    /employees:getDefault

    Получить значения по умолчанию

    POST

    /employees:batchCreate

    Массовое создание сотрудников

    POST

    /employees:batchDelete

    Массовое удаление сотрудников

    POST

    /employees:import

    Импортировать сотрудников (предпросмотр)

    POST

    /employees:confirmImport

    Подтвердить импорт

    POST

    /employees:export

    Экспортировать сотрудников

    POST

    /employees:exportTemplate

    Экспортировать шаблон

    POST

    /extensions:available

    Проверить доступность номера

    GET

    /extensions:getForSelect

    Получить добавочные для выпадающего списка

    POST

    /extensions/{id}:getPhoneRepresent

    Получить представление телефона

    POST

    /extensions:getPhonesRepresent

    Получить представление телефонов

    GET

    /sip-providers/{id}

    Получить SIP провайдера по ID

    PUT

    /sip-providers/{id}

    Обновить SIP провайдера

    PATCH

    /sip-providers/{id}

    Частично обновить SIP провайдера

    DELETE

    /sip-providers/{id}

    Удалить SIP провайдера

    GET

    /sip-providers/{id}:copy

    Скопировать SIP провайдера

    GET

    /sip-providers:getDefault

    Получить шаблон SIP провайдера

    GET

    /iax-providers/{id}

    Получить IAX провайдера по ID

    PUT

    /iax-providers/{id}

    Обновить IAX провайдера

    PATCH

    /iax-providers/{id}

    Частично обновить IAX провайдера

    DELETE

    /iax-providers/{id}

    Удалить IAX провайдера

    GET

    /iax-providers/{id}:copy

    Скопировать IAX провайдера

    GET

    /iax-providers:getDefault

    Получить шаблон IAX провайдера

    GET

    /providers:getForSelect

    Получить провайдеров для выпадающего списка

    GET

    /call-queues/{id}

    Получить очередь по ID

    PUT

    /call-queues/{id}

    Обновить очередь

    PATCH

    /call-queues/{id}

    Частично обновить очередь

    DELETE

    /call-queues/{id}

    Удалить очередь

    GET

    /call-queues/{id}:copy

    Копировать очередь

    GET

    /call-queues:getDefault

    Получить значения по умолчанию

    GET

    /ivr-menu/{id}

    Получить IVR меню по ID

    PUT

    /ivr-menu/{id}

    Обновить IVR меню

    PATCH

    /ivr-menu/{id}

    Частично обновить IVR меню

    DELETE

    /ivr-menu/{id}

    Удалить IVR меню

    GET

    /ivr-menu/{id}:copy

    Копировать IVR меню

    GET

    /ivr-menu:getDefault

    Получить значения по умолчанию

    GET

    /incoming-routes/{id}

    Получить входящий маршрут по ID

    PUT

    /incoming-routes/{id}

    Обновить входящий маршрут

    PATCH

    /incoming-routes/{id}

    Частично обновить входящий маршрут

    DELETE

    /incoming-routes/{id}

    Удалить входящий маршрут

    POST

    /incoming-routes/{id}:copy

    Копировать входящий маршрут

    GET

    /incoming-routes:getDefault

    Получить значения по умолчанию

    GET

    /incoming-routes:getDefaultRoute

    Получить маршрут по умолчанию

    POST

    /incoming-routes:changePriority

    Изменить приоритет маршрутов

    GET

    /outbound-routes/{id}

    Получить исходящий маршрут по ID

    PUT

    /outbound-routes/{id}

    Обновить исходящий маршрут

    PATCH

    /outbound-routes/{id}

    Частично обновить исходящий маршрут

    DELETE

    /outbound-routes/{id}

    Удалить исходящий маршрут

    GET

    /outbound-routes/{id}:copy

    Копировать исходящий маршрут

    GET

    /outbound-routes:getDefault

    Получить значения по умолчанию

    POST

    /outbound-routes:changePriority

    Изменить приоритет маршрутов

    GET

    /off-work-times/{id}

    Получить временное условие по ID

    PUT

    /off-work-times/{id}

    Обновить временное условие

    PATCH

    /off-work-times/{id}

    Частично обновить временное условие

    DELETE

    /off-work-times/{id}

    Удалить временное условие

    GET

    /off-work-times/{id}:copy

    Копировать временное условие

    GET

    /off-work-times:getDefault

    Получить значения по умолчанию

    POST

    /off-work-times:changePriorities

    Изменить приоритеты условий

    GET

    /conference-rooms/{id}

    Получить конференц-комнату по ID

    PUT

    /conference-rooms/{id}

    Обновить конференц-комнату

    PATCH

    /conference-rooms/{id}

    Частично обновить конференц-комнату

    DELETE

    /conference-rooms/{id}

    Удалить конференц-комнату

    GET

    /conference-rooms:getDefault

    Получить шаблон конференц-комнаты

    GET

    /dialplan-applications/{id}

    Получить dialplan приложение по ID

    PUT

    /dialplan-applications/{id}

    Обновить dialplan приложение

    PATCH

    /dialplan-applications/{id}

    Частично обновить dialplan приложение

    DELETE

    /dialplan-applications/{id}

    Удалить dialplan приложение

    GET

    /dialplan-applications/{id}:copy

    Скопировать dialplan приложение

    GET

    /dialplan-applications:getDefault

    Получить шаблон dialplan приложения

    GET

    /sound-files/{id}

    Получить звуковой файл по ID

    PUT

    /sound-files/{id}

    Обновить звуковой файл

    PATCH

    /sound-files/{id}

    Частично обновить звуковой файл

    DELETE

    /sound-files/{id}

    Удалить звуковой файл

    GET

    /sound-files:getDefault

    Получить значения по умолчанию

    GET

    /sound-files:getForSelect

    Получить для выпадающего списка

    GET

    /sound-files:playback

    Воспроизвести звуковой файл

    POST

    /sound-files:uploadFile

    Загрузить звуковой файл

    POST

    /sound-files:convertAudioFile

    Конвертировать аудио файл

    GET

    /custom-files/{id}

    Получить пользовательский файл по ID

    PUT

    /custom-files/{id}

    Обновить пользовательский файл

    PATCH

    /custom-files/{id}

    Частично обновить пользовательский файл

    DELETE

    /custom-files/{id}

    Удалить пользовательский файл

    GET

    /custom-files:getDefault

    Получить значения по умолчанию

    GET

    /sip:getRegistry

    Получить статус регистрации (legacy)

    POST

    /sip:processAuthFailures

    Обработать ошибки аутентификации

    GET

    /sip/{id}:getStatus

    Получить статус SIP устройства

    GET

    /sip/{id}:getStats

    Получить статистику SIP устройства

    GET

    /sip/{id}:getHistory

    Получить историю подключений

    GET

    /sip/{id}:getSecret

    Получить SIP пароль

    GET

    /sip/{id}:getAuthFailureStats

    Получить статистику ошибок аутентификации

    POST

    /sip/{id}:clearAuthFailureStats

    Очистить статистику ошибок

    POST

    /sip/{id}:forceCheck

    Принудительно проверить статус

    GET

    /sip-providers/{id}:getHistory

    Получить историю подключений

    GET

    /sip-providers/{id}:getStats

    Получить статистику SIP провайдера

    POST

    /sip-providers/{id}:forceCheck

    Принудительно проверить регистрацию

    POST

    /sip-providers/{id}:updateStatus

    Обновить статус провайдера

    GET

    /iax-providers/{id}:getHistory

    Получить историю подключений

    GET

    /iax-providers/{id}:getStats

    Получить статистику IAX провайдеров

    POST

    /iax-providers/{id}:forceCheck

    Принудительно проверить регистрацию

    POST

    /iax-providers/{id}:updateStatus

    Обновить статус провайдера

    GET

    /iax:getRegistry

    Получить статус регистрации IAX провайдеров

    GET

    /providers/{id}:getHistory

    Получить историю провайдера

    GET

    /providers/{id}:getStats

    Получить статистику провайдера

    POST

    /providers/{id}:updateStatus

    Обновить статус провайдера

    DELETE

    /cdr/{id}

    Удалить CDR запись

    GET

    /cdr:getMetadata

    Получить метаданные CDR

    GET

    /cdr:playback

    Воспроизвести запись разговора

    GET

    /cdr:download

    Скачать запись разговора

    POST

    /auth:logout

    Выйти из системы

    GET

    /api-keys/{id}

    Получить API ключ по ID

    PUT

    /api-keys/{id}

    Обновить API ключ

    PATCH

    /api-keys/{id}

    Частично обновить API ключ

    DELETE

    /api-keys/{id}

    Удалить API ключ

    GET

    /api-keys:getDefault

    Получить значения по умолчанию

    POST

    /api-keys:generateKey

    Сгенерировать новый ключ

    GET

    /asterisk-managers/{id}

    Получить AMI пользователя по ID

    PUT

    /asterisk-managers/{id}

    Обновить AMI пользователя

    PATCH

    /asterisk-managers/{id}

    Частично обновить AMI пользователя

    DELETE

    /asterisk-managers/{id}

    Удалить AMI пользователя

    GET

    /asterisk-managers/{id}:copy

    Копировать AMI пользователя

    GET

    /asterisk-managers:getDefault

    Получить значения по умолчанию

    GET

    /asterisk-rest-users/{id}

    Получить ARI пользователя по ID

    PUT

    /asterisk-rest-users/{id}

    Обновить ARI пользователя

    PATCH

    /asterisk-rest-users/{id}

    Частично обновить ARI пользователя

    DELETE

    /asterisk-rest-users/{id}

    Удалить ARI пользователя

    GET

    /asterisk-rest-users:getDefault

    Получить значения по умолчанию

    GET

    /passkeys/{id}

    Получить passkey по ID

    PATCH

    /passkeys/{id}

    Обновить passkey

    DELETE

    /passkeys/{id}

    Удалить passkey

    GET

    /passkeys:checkAvailability

    Проверить наличие passkeys

    GET

    /passkeys:authenticationStart

    Начать аутентификацию через passkey

    POST

    /passkeys:authenticationFinish

    Завершить аутентификацию через passkey

    POST

    /passkeys:registrationStart

    Начать регистрацию passkey

    POST

    /passkeys:registrationFinish

    Завершить регистрацию passkey

    POST

    /passwords:checkDictionary

    Проверить пароль в словаре

    POST

    /passwords:batchValidate

    Пакетная проверка паролей

    POST

    /passwords:batchCheckDictionary

    Пакетная проверка словаря

    GET

    /network-filters:getForSelect

    Получить фильтры для выпадающего списка

    GET

    /system:datetime

    Получить системное время

    GET

    /system:getAvailableLanguages

    Получить доступные языки

    GET

    /system:checkForUpdates

    Получить детальную информацию об обновлении

    GET

    /system:checkIfNewReleaseAvailable

    Быстрая проверка наличия новой версии

    GET

    /system:getDeleteStatistics

    Получить статистику удаления

    POST

    /system:reboot

    Перезагрузить систему

    POST

    /system:shutdown

    Выключить систему

    POST

    /system:upgrade

    Обновить систему

    POST

    /system:restoreDefault

    Восстановить настройки по умолчанию

    POST

    /system:changeLanguage

    Изменить язык системы

    POST

    /system:convertAudioFile

    Конвертировать аудиофайл

    POST

    /system:executeBashCommand

    Выполнить bash команду

    POST

    /system:executeSqlRequest

    Выполнить SQL запрос

    POST

    /system:updateMailSettings

    Обновить настройки почты

    PATCH

    /general-settings

    Частично обновить общие настройки

    GET

    /general-settings/{id}

    Получить конкретную настройку

    GET

    /general-settings:getDefault

    Получить значения по умолчанию

    POST

    /general-settings:updateCodecs

    Обновить настройки кодеков

    DELETE

    /network/{id}

    Удалить сетевой интерфейс

    GET

    /network:getConfig

    Получить полную конфигурацию сети

    GET

    /network:getNatSettings

    Получить настройки NAT

    POST

    /network:saveConfig

    Сохранить конфигурацию сети

    GET

    /firewall/{id}

    Получить правило файервола по ID

    PUT

    /firewall/{id}

    Обновить правило файервола

    PATCH

    /firewall/{id}

    Частично обновить правило файервола

    DELETE

    /firewall/{id}

    Удалить правило файервола

    GET

    /firewall:getDefault

    Получить значения по умолчанию

    GET

    /firewall:getBannedIps

    Получить список заблокированных IP

    POST

    /firewall:unbanIp

    Разблокировать IP адрес

    POST

    /firewall:enable

    Включить файервол

    POST

    /firewall:disable

    Выключить файервол

    PATCH

    /fail2ban

    Частично обновить настройки Fail2Ban

    PATCH

    /mail-settings

    Частично обновить настройки почты

    DELETE

    /mail-settings

    Сбросить настройки почты

    GET

    /mail-settings:getDefault

    Получить значения по умолчанию

    GET

    /mail-settings:getDiagnostics

    Получить диагностику настроек почты

    GET

    /mail-settings:getOAuth2Url

    Получить URL авторизации OAuth2

    POST

    /mail-settings:refreshToken

    Обновить OAuth2 токен

    POST

    /mail-settings:testConnection

    Проверить подключение к SMTP серверу

    POST

    /mail-settings:sendTestEmail

    Отправить тестовое письмо

    POST

    /storage:mount

    Смонтировать устройство хранения

    POST

    /storage:umount

    Размонтировать устройство хранения

    POST

    /storage:mkfs

    Форматировать устройство хранения

    POST

    /storage:statusMkfs

    Получить статус форматирования

    PATCH

    /s3-storage

    Частично обновить конфигурацию S3

    GET

    /s3-storage:stats

    Получить статистику синхронизации S3

    GET

    /s3-storage:testConnection

    Тестировать S3 соединение

    GET

    /modules/{id}

    Получить модуль по ID

    PUT

    /modules/{id}

    Обновить модуль

    PATCH

    /modules/{id}

    Частично обновить модуль

    DELETE

    /modules/{id}

    Удалить модуль

    GET

    /modules/{id}:getModuleInfo

    Получить информацию о модуле

    GET

    /modules/{id}:getModuleLink

    Получить ссылку на скачивание модуля

    GET

    /modules/{id}:getDownloadStatus

    Получить статус загрузки

    POST

    /modules/{id}:startDownload

    Начать загрузку модуля

    POST

    /modules/{id}:installFromRepo

    Установить модуль из репозитория

    POST

    /modules:installFromPackage

    Установить модуль из пакета

    POST

    /modules:getMetadataFromPackage

    Получить метаданные из пакета

    POST

    /modules/{id}:enable

    Включить модуль

    POST

    /modules/{id}:disable

    Отключить модуль

    POST

    /modules/{id}:uninstall

    Удалить модуль

    POST

    /modules:updateAll

    Обновить все модули

    GET

    /modules:getAvailableModules

    Получить доступные модули

    GET

    /modules:getInstallationStatus

    Получить статус установки

    GET

    /modules:getDefault

    Получить настройки модуля по умолчанию

    GET

    /license:resetKey

    Сбросить лицензионный ключ

    GET

    /license:sendPBXMetrics

    Отправить метрики АТС

    POST

    /license:captureFeatureForProductId

    Захватить функцию для продукта

    POST

    /license:processUserRequest

    Обработать запрос пользователя

    DELETE

    /files/{id}

    Удалить файл

    POST

    /files:upload

    Загрузить файл (чанками)

    GET

    /files:uploadStatus

    Проверить статус загрузки

    POST

    /files:downloadFirmware

    Скачать прошивку

    GET

    /files:firmwareStatus

    Проверить статус скачивания прошивки

    GET

    /sysinfo:getHypervisorInfo

    Получить информацию о гипервизоре

    GET

    /sysinfo:getDMIInfo

    Получить DMI информацию

    POST

    /syslog:getLogTimeRange

    Получить временной диапазон лога

    POST

    /syslog:eraseFile

    Очистить лог файл

    POST

    /syslog:startCapture

    Начать захват пакетов

    POST

    /syslog:stopCapture

    Остановить захват пакетов

    POST

    /syslog:prepareArchive

    Подготовить архив логов

    POST

    /syslog:downloadArchive

    Скачать архив логов

    POST

    /syslog:downloadLogFile

    Скачать лог файл

    GET

    /openapi:getDetailedPermissions

    Получить детальный список разрешений

    GET

    /openapi:getSimplifiedPermissions

    Получить упрощенный список разрешений

    GET

    /openapi:getValidationSchemas

    Получить схемы валидации

    POST

    /openapi:clearCache

    Очистить кэш OpenAPI

    GET

    /employees

    Получить список сотрудников

    POST

    /employees

    Создать нового сотрудника

    GET

    /extensions

    Получить список добавочных номеров

    GET

    /extensions/{id}

    Получить добавочный номер по ID

    GET

    /sip-providers

    Получить список SIP провайдеров

    POST

    /sip-providers

    Создать SIP провайдера

    GET

    /iax-providers

    Получить список IAX провайдеров

    POST

    /iax-providers

    Создать IAX провайдера

    GET

    /providers

    Получить список всех провайдеров

    GET

    /providers/{id}

    Получить провайдера по ID

    GET

    /call-queues

    Получить список очередей

    POST

    /call-queues

    Создать новую очередь

    GET

    /ivr-menu

    Получить список IVR меню

    POST

    /ivr-menu

    Создать новое IVR меню

    GET

    /incoming-routes

    Получить список входящих маршрутов

    POST

    /incoming-routes

    Создать входящий маршрут

    GET

    /outbound-routes

    Получить список исходящих маршрутов

    POST

    /outbound-routes

    Создать исходящий маршрут

    GET

    /off-work-times

    Получить список временных условий

    POST

    /off-work-times

    Создать временное условие

    GET

    /conference-rooms

    Получить список конференц-комнат

    POST

    /conference-rooms

    Создать конференц-комнату

    GET

    /dialplan-applications

    Получить список dialplan приложений

    POST

    /dialplan-applications

    Создать dialplan приложение

    GET

    /sound-files

    Получить список звуковых файлов

    POST

    /sound-files

    Создать звуковой файл

    GET

    /custom-files

    Получить список пользовательских файлов

    POST

    /custom-files

    Создать новый пользовательский файл

    GET

    /pbx-status:getActiveCalls

    Получить активные вызовы

    GET

    /pbx-status:getActiveChannels

    Получить активные каналы

    GET

    /sip:getStatuses

    Получить статусы всех SIP устройств

    GET

    /sip:getPeersStatuses

    Получить статусы SIP peers (legacy)

    GET

    /sip-providers:getStatuses

    Получить статусы всех SIP провайдеров

    GET

    /sip-providers/{id}:getStatus

    Получить статус SIP провайдера

    GET

    /iax-providers:getStatuses

    Получить статусы всех IAX провайдеров

    GET

    /iax-providers/{id}:getStatus

    Получить статус IAX провайдера

    GET

    /providers:getStatuses

    Получить статусы всех провайдеров

    GET

    /providers/{id}:getStatus

    Получить статус провайдера

    GET

    /cdr

    Получить список CDR записей

    GET

    /cdr/{id}

    Получить CDR запись по ID

    GET

    /advice:getList

    Получить список системных уведомлений

    GET

    /advice:refresh

    Обновить кеш уведомлений

    POST

    /auth:login

    Войти в систему (логин/пароль)

    POST

    /auth:refresh

    Обновить токен доступа

    GET

    /api-keys

    Получить список API ключей

    POST

    /api-keys

    Создать новый API ключ

    GET

    /asterisk-managers

    Получить список AMI пользователей

    POST

    /asterisk-managers

    Создать нового AMI пользователя

    GET

    /asterisk-rest-users

    Получить список ARI пользователей

    POST

    /asterisk-rest-users

    Создать нового ARI пользователя

    GET

    /passkeys

    Получить список passkeys

    POST

    /passkeys

    Создать новый passkey

    GET

    /passwords:generate

    Сгенерировать пароль

    POST

    /passwords:validate

    Проверить надежность пароля

    GET

    /users:available

    Проверить доступность email

    GET

    /network-filters

    Получить список сетевых фильтров

    GET

    /network-filters/{id}

    Получить сетевой фильтр по ID

    GET

    /system:ping

    Проверить доступность системы

    GET

    /system:checkAuth

    Проверить аутентификацию

    GET

    /general-settings

    Получить общие настройки

    PUT

    /general-settings

    Обновить общие настройки

    GET

    /network

    Получить список сетевых интерфейсов

    GET

    /network/{id}

    Получить сетевой интерфейс по ID

    GET

    /firewall

    Получить список правил файервола

    POST

    /firewall

    Создать правило файервола

    GET

    /fail2ban

    Получить настройки Fail2Ban

    PUT

    /fail2ban

    Обновить настройки Fail2Ban

    GET

    /time-settings:getAvailableTimezones

    Получить список доступных часовых поясов

    GET

    /mail-settings

    Получить настройки почты

    PUT

    /mail-settings

    Обновить настройки почты

    GET

    /storage:usage

    Получить статистику использования хранилища

    GET

    /storage:list

    Получить список доступных устройств хранения

    GET

    /s3-storage

    Получить конфигурацию S3 хранилища

    PUT

    /s3-storage

    Обновить конфигурацию S3 хранилища

    GET

    /modules

    Получить список модулей

    POST

    /modules

    Создать модуль

    GET

    /license:getLicenseInfo

    Получить информацию о лицензии

    GET

    /license:ping

    Проверить связь с сервером лицензий

    GET

    /files/{id}

    Получить содержимое файла

    PUT

    /files/{id}

    Загрузить/обновить файл

    GET

    /sysinfo:getInfo

    Получить системную информацию

    GET

    /sysinfo:getExternalIpInfo

    Получить внешний IP адрес

    GET

    /syslog:getLogsList

    Получить список лог файлов

    POST

    /syslog:getLogFromFile

    Получить содержимое лога

    GET

    /openapi:getSpecification

    Получить OpenAPI спецификацию

    GET

    /openapi:getAclRules

    Получить ACL правила API

    GET

    /search:getSearchItems

    Глобальный поиск

    GET

    /wiki-links:getLink

    Получить ссылку на документацию

    POST

    /user-page-tracker:pageView

    Зафиксировать просмотр страницы

    POST

    /user-page-tracker:pageLeave

    Зафиксировать уход со страницы

    Возможности интерактивной документации

    Список эндпоинтов

    Телефония и маршрутизация

    Сотрудники

    Внутренние номера

    SIP провайдеры

    IAX провайдеры

    Провайдеры (общий список SIP + IAX)

    Очереди звонков

    IVR меню

    Входящая маршрутизация

    Исходящая маршрутизация

    Нерабочее время

    Конференц-комнаты

    Приложения диалплана

    Звуковые файлы

    Кастомизация системных файлов

    Мониторинг и статистика

    Состояние АТС

    SIP устройства

    SIP провайдеры (мониторинг)

    IAX провайдеры (мониторинг)

    Провайдеры (мониторинг)

    Журнал звонков (CDR)

    Советы и рекомендации

    Аутентификация и доступ

    Аутентификация

    API ключи

    AMI пользователи

    ARI пользователи

    Ключи доступа (Passkeys)

    Пароли

    Пользователи

    Сетевые фильтры

    Системные настройки

    Системные операции

    Общие настройки

    Сетевые интерфейсы и маршрутизация

    Сетевой фильтр (Firewall)

    Защита от взлома (Fail2Ban)

    Настройки времени

    Настройки почты

    Хранилище

    S3 Облачное хранилище

    Дополнительные модули

    Лицензирование

    Операции с файлами

    Диагностика

    Информация о системе

    Системные логи

    Документация OpenAPI

    Поиск

    Ссылки на документацию

    Отслеживание активности пользователей

    Технические эндпоинты

    Эндпоинт firewall-export
    Кнопка «Документация API» в разделе API ключей
    Меню навигации
    Описание эндпоинта с параметрами запроса и примером тела
    Пример запроса на Python и пример ответа сервера
    Выполнение запросов из документации API
    Коды ответов и структура тела ответа