Skip to content

Commit

Permalink
GITBOOK-366: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
excla1mmm authored and gitbook-bot committed Nov 30, 2024
1 parent 20dc701 commit 508297e
Show file tree
Hide file tree
Showing 19 changed files with 119 additions and 63 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/maintenceSectionMikoPBX.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@
* [Module management](manual/modules/pbx-extension-modules.md)
* [Application dialplans](manual/modules/dialplan-applications.md)
* [Maintenance](manual/maintenance/README.md)
* [System upgrade](manual/maintenance/update/README.md)
* [PBX update](manual/maintenance/update/README.md)
* [Updating from the web interface](manual/maintenance/update/updating-from-the-web-interface.md)
* [Updating from the MikoPBX console](manual/maintenance/update/updating-from-the-mikopbx-console.md)
* [Updating the docker](manual/maintenance/update/updating-the-docker.md)
* [System diagnostic](manual/maintenance/system-diagnostic.md)
* [System log entries](manual/maintenance/system-diagnostic.md)
* [Reboot](manual/maintenance/restart.md)
* [Network and Firewall](manual/connectivity/README.md)
* [Network interface](manual/connectivity/network.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ In the above code fragment, you need to specify the logins for your provider acc

Below, the fragments highlighted in red are the ones you need to modify:

<figure><img src="../../.gitbook/assets/image (1) (1).png" alt=""><figcaption><p>Fragments to change</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (1) (1) (1).png" alt=""><figcaption><p>Fragments to change</p></figcaption></figure>

Let's break down the **ExecIfTime** command in more detail. This command executes the specified Asterisk application if the current time matches the given time specification. In our case, the command plays an audio file located in the directory **/offload/asterisk/sounds/other/out\_work\_times** in MikoPBX. Command syntax:

Expand Down
2 changes: 1 addition & 1 deletion faq/softphones/telephone-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This is the simplest client for users of Apple products. You can download it fro

2. In the "**Domain**" field, enter the **IP address** of the MikoPBX to which the connection is being made

<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

<figure><img src="../../.gitbook/assets/image (23).png" alt=""><figcaption></figcaption></figure>

Expand Down
35 changes: 35 additions & 0 deletions manual/maintenance/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,37 @@
---
description: Description of the Maintenance section in MikoPBX
---

# Maintenance

The **Maintenance** section of MikoPBX is an interface for managing the technical aspects of the system and ensuring its stable operation. Here, administrators can perform tasks on data backup and recovery, software updates, system status monitoring, and event log management. This section helps maintain the functionality of the telephone system, promptly detect and eliminate possible problems.

<figure><img src="../../.gitbook/assets/maintenceSectionMikoPBX.png" alt=""><figcaption><p>"Maintenance" section in MikoPBX</p></figcaption></figure>

## PBX update

{% content-ref url="update/" %}
[update](update/)
{% endcontent-ref %}

The "**PBX update**" section in MikoPBX is an interface for managing system software updates. Here, administrators can check for new versions, install updates, and view the change history. Regular use of this section ensures that MikoPBX is up-to-date, secure, and stable.

***

## System log entries

{% content-ref url="system-diagnostic.md" %}
[system-diagnostic.md](system-diagnostic.md)
{% endcontent-ref %}

The "**System log entries**" section in MikoPBX is a tool for monitoring and analyzing the status of the telephone system. Here, administrators can view event logs, check the status of various services and system components, and test connections and calls. Using this section helps to promptly detect and eliminate technical problems, ensuring stable and efficient operation of MikoPBX.

***

## Reboot

{% content-ref url="restart.md" %}
[restart.md](restart.md)
{% endcontent-ref %}

The "**Reboot**" section in MikoPBX is an interface for securely managing the state of the telephone system via the web interface. Here, administrators can reboot the system to apply new settings or shut it down gracefully for maintenance. Using this section prevents possible errors and ensures stable operation of MikoPBX. In addition, the possibility of rebooting via the console will be discussed.
47 changes: 24 additions & 23 deletions manual/maintenance/restart.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,53 @@
---
description: Description of section functions
---

# Reboot

## Rebooting the station via the MikoPBX interface

The system shutdown/reboot menu can be found in MikoPBX by clicking on "**Reboot**" in the "**Maintenance**" section
The system shutdown/reboot menu can be found in MikoPBX by clicking on "**Reboot**" in the "**Maintenance**" section.

<figure><img src="../../.gitbook/assets/1 (9).png" alt=""><figcaption><p>"Maintenance" -> "Reboot" section</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/1 (9).png" alt=""><figcaption></figcaption></figure>
When you open the page, a list of active calls to the PBX will be displayed. The start date of the call is displayed, **from** whom and **to** whom the call.

When you open the page, a list of active calls to the PBX will be displayed. The start date of the call is displayed, **from** whom and **to** whom the call
{% hint style="warning" %}
As long as there are active calls, the reboot and shutdown will not be available via the web interface.
{% endhint %}

<figure><img src="../../.gitbook/assets/2 (8).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/2 (8).png" alt=""><figcaption><p>List of active calls</p></figcaption></figure>

* **Restart the PBX** - the command starts restarting the station.&#x20;
* **Turn off PBX** - completes all processes and disconnects the station.

<figure><img src="../../.gitbook/assets/3 (8).png" alt=""><figcaption></figcaption></figure>

{% hint style="warning" %}
As long as there are active calls, the reboot and shutdown will not be available via the web interface.
{% endhint %}
<figure><img src="../../.gitbook/assets/3 (8).png" alt=""><figcaption><p>System shutdown/reboot options</p></figcaption></figure>

## Rebooting the station via the console menu

You can restart the station via the console menu. To do this, select the section **"\[3] Reboot the system"**

<figure><img src="../../.gitbook/assets/4 (16).png" alt=""><figcaption></figcaption></figure>

If you want to restart the station: press **"\[1] Reboot MikoPBX"**
<figure><img src="../../.gitbook/assets/4 (16).png" alt=""><figcaption><p>MikoPBX console</p></figcaption></figure>

If you want to turn off the station: press **"\[2] Shutdown"**

<figure><img src="../../.gitbook/assets/5 (17).png" alt=""><figcaption></figcaption></figure>
* If you want to restart the station: press **"\[1] Reboot MikoPBX"**
* If you want to turn off the station: press **"\[2] Shutdown"**

The system will reboot.

<figure><img src="../../.gitbook/assets/5 (17).png" alt=""><figcaption><p>Restart/shutdown station</p></figcaption></figure>

## Reboot with disk check

In case of an emergency restart of the PBX (for example, power outage), it may be necessary to check the disk for errors.

In the PBX console menu, enter the command **"\[9] Console(Shell)"** and press **Enter**
In the PBX console menu, enter the command **"\[9] Console(Shell)"** and press **Enter.**

<figure><img src="../../.gitbook/assets/6 (3).png" alt=""><figcaption></figcaption></figure>
System launch the MikoPBX console.

System launch the Miko PBX console
<figure><img src="../../.gitbook/assets/6 (3).png" alt=""><figcaption><p>Console menu MikoPBX</p></figcaption></figure>

Enter the command `reboot`

Press **Enter**.

<figure><img src="../../.gitbook/assets/7 (10).png" alt=""><figcaption></figcaption></figure>
Enter the command `reboot`. Press **Enter**.

The system will reboot with a disk check.

<figure><img src="../../.gitbook/assets/7 (10).png" alt=""><figcaption><p>Reboot command</p></figcaption></figure>
36 changes: 22 additions & 14 deletions manual/maintenance/system-diagnostic.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
# System diagnostic
---
description: Description of section functions
---

# System log entries

The "**System Diagnostics"** section in MikoPBX is a tool for monitoring and analyzing the status of the telephone system. Using this section helps to promptly detect and eliminate technical problems, ensuring stable and efficient operation of MikoPBX.

Section location: "**Maintenance**" -> "**System log entries**"

<figure><img src="../../.gitbook/assets/LogsSection.png" alt=""><figcaption><p>System logs section</p></figcaption></figure>

Expand All @@ -8,24 +16,24 @@ Contains 3 tabs: _**Show log**_**,&#x20;**_**System information**_**,&#x20;**_**

## Show log section <a href="#prosmotr_logov" id="prosmotr_logov"></a>

<figure><img src="../../.gitbook/assets/ShowLogSection.png" alt=""><figcaption></figcaption></figure>

This section allows you to view log files for detailed analysis of PBX operations.

1. To start, select a **file**.
2. Set the **lines** for the number of lines to fetch.
3. Set the **offset** value to shift the selection.
4. Set the **filter** by entering a string to be included in the selection.

<figure><img src="../../.gitbook/assets/fuilters.png" alt=""><figcaption><p>Filters</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/ShowLogSection.png" alt=""><figcaption><p>"Show log" section</p></figcaption></figure>

The following options are available:

1. **Download** the selected log as a file ![](../../.gitbook/assets/sistem_logi_skachat.png)
2. **Refresh** the log ![](../../.gitbook/assets/sistem_logi_obnovit.png)
3. **Auto-refresh** the log ![](../../.gitbook/assets/sistem_logi_obnovit_avt.png)
1. **Download** the selected log as a file ![](../../.gitbook/assets/sistem_logi_skachat.png).
2. **Refresh** the log ![](../../.gitbook/assets/sistem_logi_obnovit.png).
3. **Auto-refresh** the log ![](../../.gitbook/assets/image.png).

### Example: Call Analysis <a href="#primer_analiz_zvonka" id="primer_analiz_zvonka"></a>
<figure><img src="../../.gitbook/assets/fuilters.png" alt=""><figcaption><p>Filters</p></figcaption></figure>

## Example: Call Analysis <a href="#primer_analiz_zvonka" id="primer_analiz_zvonka"></a>

Suppose you need to analyze an outgoing call to the number **74952293042**.

Expand All @@ -45,21 +53,21 @@ Suppose you need to analyze an outgoing call to the number **74952293042**.

## System Information <a href="#informacija_o_sisteme" id="informacija_o_sisteme"></a>

<figure><img src="../../.gitbook/assets/sysInfoSection.png" alt=""><figcaption><p>System information section</p></figcaption></figure>

The tab displays the following information:

* Network settings
* CPU load
* RAM usage
* iptables settings

### Campuring network packets <a href="#zaxvat_logov" id="zaxvat_logov"></a>
<figure><img src="../../.gitbook/assets/sysInfoSection.png" alt=""><figcaption><p>System information section</p></figcaption></figure>

<figure><img src="../../.gitbook/assets/captureSection.png" alt=""><figcaption></figcaption></figure>
## Campuring network packets <a href="#zaxvat_logov" id="zaxvat_logov"></a>

This section allows you to perform a detailed analysis of errors in PBX operation.

<figure><img src="../../.gitbook/assets/captureSection.png" alt=""><figcaption><p>"Computer network packets" section</p></figcaption></figure>

#### Capturing Network Packets

You can start capturing network packets passing through the network interface.
Expand All @@ -75,7 +83,7 @@ You can start capturing network packets passing through the network interface.

The network packets will automatically be saved in the archive **MikoPBXLogs\_log-tcpdump-XXXXXXXXXX**. They should also automatically save in your browser's **Downloads** folder.

<figure><img src="../../.gitbook/assets/file.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/file.png" alt=""><figcaption><p>Logs file</p></figcaption></figure>

If you cannot find the archive in the **Downloads** folder, you can [connect to the PBX via WinSCP](../../faq/troubleshooting/connecting-to-a-pbx-using-winscp.md) and download it from the **/storage/usbdisk1/mikopbx/tmp** directory - the file will be **log-tcpdump-XXXXXXXXXX.zip**.

Expand All @@ -87,7 +95,7 @@ You can use the search function in WinSCP by entering "**log-tcpdump\***" in the

You can download all system logs accumulated on the PBX. To do this, click the **Download All System Logs** button.

<figure><img src="../../.gitbook/assets/dnldAllSysLog.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/dnldAllSysLog.png" alt=""><figcaption><p>"Download all system logs" button</p></figcaption></figure>

The system logs will automatically be saved in the archive **MikoPBXLogs\_log-sys-XXXXXXXXXX.zip**. The logs should also automatically save in your browser's **Downloads** folder.\
You can also obtain this log archive from the **/storage/usbdisk1/mikopbx/tmp** directory by connecting to the PBX using WinSCP. The file will be **log-sys-XXXXXXXXXX.zip**.
Expand Down
16 changes: 10 additions & 6 deletions manual/maintenance/update/updating-from-the-mikopbx-console.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,35 @@
---
description: Update option from MikoPBX console
---

# Updating from the MikoPBX console

Below is an example of a PBX installed on a VirtualBOX virtual machine, updated from version 2023.1.223 to version 2023.2.206.\
Download the iso image of the required PBX version from the [repository](https://github.com/mikopbx/Core/releases).

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_10.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_10.png" alt=""><figcaption><p>.iso image in MikoPBX release repository</p></figcaption></figure>

In VirtualBOX, open the settings of the virtual machine where the PBX is installed.\
Go to the **Storage** section.\
Select the virtual optical drive.\
Click the icon ![](../../../.gitbook/assets/obnov\_kons\_1.png) in the **Attributes** group, and click **Choose Disk File**.\
Click the icon ![](../../../.gitbook/assets/obnov_kons_1.png) in the **Attributes** group, and click **Choose Disk File**.\
Select the downloaded PBX iso image.\
Start the machine.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_11.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_11.png" alt=""><figcaption><p>Selecting a disk file in the VirtualBox interface</p></figcaption></figure>

The console will display the line "<mark style="color:red;">**The system loaded in Recovery mode**</mark>".

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_12.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_12.png" alt=""><figcaption><p>MikoPBX Console</p></figcaption></figure>

Select **Install / Repair** (or press the number **8** on the keyboard) and press **Enter**.

You need the command "**Update to version \*\*\*\*.\*.\*\*".** Press the number **2** on the keyboard, then press **Enter**.\
The update installation will begin. When it is complete, the PBX will reboot.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_13.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_13.png" alt=""><figcaption><p>Update installation process</p></figcaption></figure>

After the PBX reboots, the message "<mark style="color:red;">**The system loaded in Recovery mode**</mark>" will no longer appear, indicating that the PBX has booted from the hard disk and not from the virtual optical drive.\
The installed update version will be displayed in green at the top.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_14.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_14.png" alt=""><figcaption><p>Updated version</p></figcaption></figure>
28 changes: 16 additions & 12 deletions manual/maintenance/update/updating-from-the-web-interface.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
---
description: Update option from the web interface
---

# Updating from the web interface

In some sections of the interface (e.g., **Extensions**), the current version of MikoPBX is displayed in the lower right corner.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_1.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_1.png" alt=""><figcaption><p>Displaying the version in the web interface</p></figcaption></figure>

In the PBX web interface, go to **Maintenance****PBX update**.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_2.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_2.png" alt=""><figcaption><p>"PBX update" section</p></figcaption></figure>

If there are newer versions of the PBX available, they will be displayed in the **Online updates** **available** table, with the version number in the first field and the list of changes in the second.

{% hint style="warning" %}
We recommend performing updates sequentially without skipping releases.
{% endhint %}

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_3.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_3.png" alt=""><figcaption><p>Section "Available online updates"</p></figcaption></figure>

There are two update options: **online update** and **update using a downloaded img file**.

Expand All @@ -25,13 +29,13 @@ There are two update options: **online update** and **update using a downloaded
{% endhint %}

Updates are downloaded to the PBX and applied immediately.\
To update this way, click the button ![](../../../.gitbook/assets/obnov\_ats\_3.png) for the desired version.
To update this way, click the button ![](../../../.gitbook/assets/obnov_ats_3.png) for the desired version.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_4.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_4.png" alt=""><figcaption><p>Button to update the system</p></figcaption></figure>

A warning window will appear. Click **Upgrade**.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_5.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_5.png" alt=""><figcaption><p>Warning window</p></figcaption></figure>

The PBX will download and apply the updates, and then reboot.

Expand All @@ -41,20 +45,20 @@ The PBX will download and apply the updates, and then reboot.
Please note that this method can also be used to roll back to a previous version.
{% endhint %}

To update using this method, click the button ![](../../../.gitbook/assets/obnov\_ats\_6.png) for the desired version.
To update using this method, click the button ![](../../../.gitbook/assets/obnov_ats_6.png) for the desired version.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_6.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_6.png" alt=""><figcaption><p>Button to download the update file</p></figcaption></figure>

The img file will start downloading. Wait for the download to complete.

Then click the button ![](../../../.gitbook/assets/obnov\_ats\_8.png) and select the downloaded img file.
Then click the button ![](../../../.gitbook/assets/obnov_ats_8.png) and select the downloaded img file.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_7.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_7.png" alt=""><figcaption><p>Selecting a file to update</p></figcaption></figure>

Then click **Apply the update**, and in the warning window, click **Upgrade**.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_8.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_8.png" alt=""><figcaption><p>Installing the update</p></figcaption></figure>

The updates will be applied, and the PBX will reboot upon completion.

<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_9.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/MikoPBXupgrade_eng_9.png" alt=""><figcaption><p>The update process</p></figcaption></figure>
Loading

0 comments on commit 508297e

Please sign in to comment.