> For the complete documentation index, see [llms.txt](https://docs.mikopbx.com/mikopbx/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.mikopbx.com/mikopbx/english/readme.md).

# MikoPBX Manual

Description of MikoPBX and the sections you can find in the documentation. Introduction to the documentation.

## Foreword

Welcome to the MikoPBX documentation resource! Here you can find step-by-step instructions related to interacting with the MikoPBX PBX system. For your convenience, the documentation is organized into sections - just like in the web interface, making it very easy to navigate.

Thank you for choosing **MikoPBX**! :heart:

## What is MikoPBX?

**MikoPBX** is a **free** telephony server with its own operating system and a simple, user-friendly web interface. It works with virtually any telephony technology in the world.

<figure><img src="https://835495363-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsZ8acWnNlSalIHQjMFu1%2Fuploads%2F3TqSCzIxUEa58DoqWaUV%2FMikoPBXInterface.png?alt=media&amp;token=ba396d68-87d9-45f6-851b-3c86f6b0ea57" alt=""><figcaption><p>MikoPBX Interface</p></figcaption></figure>

MikoPBX is a fully modular interface for Asterisk, written in PHP and JavaScript. This means that you can implement absolutely any additional Asterisk telephony functionality within MikoPBX. Moreover, if you develop a useful module, you can place it in the public repository and make it available to all MikoPBX users. Additionally, MikoPBX has very low hardware requirements:

| Simultaneous Calls |  Minimally Recommended Configuration  |
| :----------------: | :-----------------------------------: |
|       5 - 10       |        1 GHz x86-64, 512 MB RAM       |
|      Up to 25      |         3 GHz x86-64, 1 GB RAM        |
|       Over 25      | 2 CPUs 3 GHz x86-64, 2 GB RAM or more |

## Where to Start?

To get started, you should install MikoPBX using any method convenient for you. Below are installation options. By clicking on their names, you can access detailed articles:

* Installation [on a standalone computer](/mikopbx/english/setup/bare-metal.md).
* Installation [in a virtual machine](/mikopbx/english/setup/hypervisor.md).
* Installation [using cloud services](/mikopbx/english/setup/cloud.md).
* Installation in a [Docker container](/mikopbx/english/setup/docker.md).

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

* [Telephony](/mikopbx/english/manual/telephony.md).
* [Call Routing](/mikopbx/english/manual/routing.md).
* [Modules](/mikopbx/english/manual/modules.md).
* [Maintenance](/mikopbx/english/manual/maintenance.md).
* [Network and Firewall](/mikopbx/english/manual/connectivity.md).
* [System](/mikopbx/english/manual/system.md).

For additional help with getting started quickly, you can refer to [this article](/mikopbx/english/readme/quick-start.md).

## Modules

If you have familiarized yourself with the basic setup and operation of MikoPBX, you can expand its functionality using modules.

Modules allow you to add extra features to your system. You can learn more about them step by step:

1. [Registration in the MikoPBX Marketplace](/mikopbx/english/manual/modules/licensing.md) – here you'll find a detailed description of the registration process and its specifics.
2. [Module Management](/mikopbx/english/manual/modules/pbx-extension-modules.md) – this section provides a detailed explanation of how to install and manage modules.
3. [Documentation on Specific Modules](/mikopbx/english/modules/miko.md) – in this section, you'll find detailed descriptions of each module, as well as steps for configuring and using them.

## FAQ Section

In this section, you can find answers to your questions and solutions that will help you expand the functionality of basic features. This section, like the main documentation, is divided into categories for easy navigation.

If you have a question that isn't covered here, you can seek assistance in the [Telegram Community](https://t.me/mikopbx), where MikoPBX users help each other resolve issues and needs related to the PBX system.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.mikopbx.com/mikopbx/english/readme.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
