English | Русский

ModuleAutoprovision

Automatic IP phone provisioning module for MikoPBX. Discovers phones on the local network via Plug-and-Play (PnP) multicast, generates vendor-specific configuration files, and delivers them over HTTP.

Features

• Automatic phone discovery and registration via SIP PnP (multicast 224.0.1.75:5060)
• Vendor-specific configuration generation for Yealink, Snom, Fanvil
• Shared phonebook for Yealink (XML) and Grandstream (text)
• Template engine with variable substitution ({SIP_USER_NAME}, {SIP_NUM}, {SIP_PASS})
• URI pattern matching with % wildcard for flexible delivery
• MAC address whitelist / blacklist
• BLF (Busy Lamp Field) button configuration
• Per-vendor INI overrides
• REST API for configuration and image delivery
• Built-in SIP user apv-miko-pbx for first contact with factory-reset phones

Supported phones

Vendor	Models / Notes
Yealink	T18P, T19D, T21D, T28P, W52P (DECT)
Snom	All PnP-capable models
Fanvil	All PnP-capable models
Grandstream	Phonebook only

Installation

From the MikoPBX Marketplace

1. Open the MikoPBX web interface.
2. Navigate to Modules > Marketplace.
3. Find ModuleAutoprovision in the list and click Install.
4. Once installed, enable the module on the Modules > Installed page.

Manual installation

1. Download the latest .zip release from the Releases page.
2. In the MikoPBX web interface, go to Modules > Installed.
3. Click Upload module and select the downloaded .zip file.
4. Enable the module after installation.

How it works

1. The module creates a service SIP account apv-miko-pbx on the PBX.
2. The WorkerProvisioningServerPnP worker listens on multicast 224.0.1.75:5060 and answers PnP SUBSCRIBE from phones.
3. A factory-reset phone in the LAN discovers the PBX and registers as apv-miko-pbx.
4. The user dials the provisioning pattern from the phone (e.g. *2*XXX) where XXX is the desired extension.
5. The phone fetches its config from /pbxcore/api/autoprovision-http/... and re-registers with the assigned extension.

Configuration

After enabling the module, open Modules > Autoprovision module in MikoPBX. The settings page has five tabs:

Tab	Description
Phone Settings	Bind employees to MAC addresses and templates
Settings Templates	Configuration templates with variable substitution
URI Settings	Map URI patterns to templates (supports % wildcard)
Phone Book	Add external PBX addresses for shared phonebook
PnP Settings	Extension pattern, PBX host, MAC lists, additional params

Template variables

Inside any template you can use:

• {SIP_USER_NAME} -- display name of the user
• {SIP_NUM} -- extension number
• {SIP_PASS} -- SIP secret
• {PBX_HOST} -- PBX host / IP from PnP settings

REST API

Two endpoint families are exposed:

Internal (authenticated) endpoints

Method	Endpoint	Description
GET	/pbxcore/api/autoprovision/getcfg?mac=<MAC>	Generate and stream the vendor config for the given MAC
GET	/pbxcore/api/autoprovision/getimg?file=<name>	Serve an image asset from assets/img/

Public (no-auth) endpoints used by phones

Base path: /pbxcore/api/autoprovision-http

Endpoint	Description
/{p1}/{p2}/.../{p35}	URI-matched configuration delivery (auto-detects vendor by User-Agent / MAC)
/phonebook, /yealink	Phonebook in Yealink XML format
/grandstream	Phonebook in Grandstream text format

Requirements

• MikoPBX 2024.1.42 or later
• PHP 7.4 or 8.x

Documentation

• English documentation
• Russian documentation

Support

• Issues: GitHub Issues
• Telegram: @mikopbx_dev
• Forum: qa.mikopbx.ru

License

GPL-3.0-or-later. See LICENSE.