1 of 5

Management

Change the login name

When a new is added to the PBX, a SIP account with a numeric internal number is created on the PBX. In some cases, for security reasons, it is necessary to change the name for authorization of this employee.

When configuring SIP Clients, you can often see two key parameters:

Username - usually equal to the account ID, in the case of MikoPBX equal to the internal number
Auth name - username for authorization. In the case of MikoPBX is equal to the internal number

To change the authorization name:

Open the employee's account for editing

Go to "Advanced Settings" → "Advanced SIP Settings"

Add the following lines:

[auth] 
username = MIKO204

Instead of MIKO204, specify a name for authorization, it is advisable to use both letters and numbers

The extra disk space has run out, the disk size has increased

Some virtual machines allow you to increase the disk size

Be sure to back up your data before you work!

To execute the following commands, you will need to connect to the PBX using an SSH client.

Control of free disk space

~ # df -h
Filesystem                Size      Used Available Use% Mounted on
none                    281.3M    324.0K    281.0M   0% /dev
/dev/sda2               392.3M    384.6M      3.8M  99% /offload
/dev/sda3                14.1M    915.0K     12.9M   6% /cf
/dev/sdb1                 4.9G     71.0M      4.5G   2% /storage/usbdisk1

The data storage disk is usually mounted in the "/storage/usbdisk1" directory. From the example above, it can be seen that 4.5G of 4.9G is currently available.

Disabling the disk

Before starting work, you should unmount the disk. To do this, run the script:

~ # /sbin/freestorage

Make sure that the data storage disk is no longer mounted:

~ # df -h
Filesystem                Size      Used Available Use% Mounted on
none                    281.3M    324.0K    281.0M   0% /dev
/dev/sda2               392.3M    388.3M         0 100% /offload
/dev/sda3                14.1M    915.0K     12.9M   6% /cf

Editing the Partition table

Deleting a partition

First, delete the existing partition. This operation does NOT delete data on the disk, just edits the partition table.

Launching the Section Editor:

# fdisk /dev/sdb

The system will prompt you to enter a command, enter "d" and press Enter:

Command (m for help): d

Система запросит выбрать раздел к удалению, он один, вводим номер раздела «1» и жмем Enter:

Selected partition 1

Сохраняем таблицу разделов, вводим команду «w» и жмем Enter:

Command (m for help): w

Adding a larger section

Launching the Section Editor:

# fdisk /dev/sdb

The system will prompt you to enter a command, enter "n" and press Enter:

Command (m for help): n

Next, specify the command "p", the section will be primary, press Enter:

Command action p

Enter the number of the created section "1", press Enter:

Partition number (1-4): 1

Next, the system will ask you to enter the numbers of the first and last sector "First sector" / "Last sector", wait for Enter, do not enter anything and agree with the "default" values.

Checking a new partition

The size of the partition must match the size of the disk.

~ # fdisk -l 
Disk /dev/sdb: 10 GB, 10737418240 bytes, 20971520 sectors
1305 cylinders, 255 heads, 63 sectors/track
Units: cylinders of 16065 * 512 = 8225280 bytes

Device  Boot StartCHS    EndCHS        StartLBA     EndLBA    Sectors  Size Id Type
/dev/sdb1    0,1,1       1023,254,63         63   20964824   20964762  9.9G 83 Linux

Checking the section for errors

Run the verification command:

e2fsck -f /dev/sdb1

Example of the result of the team's work:

e2fsck 1.43.4 (31-Jan-2017)
Pass 1: Checking inodes, blocks, and sizes
Pass 2: Checking directory structure
Pass 3: Checking directory connectivity
Pass 4: Checking reference counts
Pass 5: Checking group summary information
/dev/sdb1: 35/655360 files (11.4% non-contiguous), 63423/2620595 blocks

Partition file system size

Run the command:

resize2fs /dev/sdb1

Example of command output:

resize2fs 1.43.4 (31-Jan-2017)
The filesystem is already 2620595 (4k) blocks long.  Nothing to do!

Rebooting and mounting

When booting, the system will automatically mount a disk for data storage:

~ # df -h
Filesystem                Size      Used Available Use% Mounted on
none                    281.3M    324.0K    281.0M   0% /dev
/dev/sda2               392.3M    384.6M      3.8M  99% /offload
/dev/sda3                14.1M    915.0K     12.9M   6% /cf
/dev/sdb1                 9.8G     73.3M      9.2G   1% /tmp/123

Storing Recordings in a Shared Windows Folder

In some cases, it is necessary to save call recordings on a network drive. This example shows how to connect a shared Windows folder to MikoPBX.

Note: If the network folder becomes unavailable, it may cause disruptions in PBX operation.

Create a directory for the script:

mkdir /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script

Create the script file:

/cat > /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script/mount-shared-folder.sh

Insert the script content:

#!/bin/sh
HOST='//172.16.32.38/SharedFolder';
USER='';
PASS='';
REC_DIR='autorecords';
mountPoint='/storage/win-shared';

createLink ()
{
  subDir="$(date '+%Y/%m')";
  monitorDir="$(/bin/busybox grep monitordir < /etc/inc/mikopbx-settings.json | /bin/busybox cut -f 4 -d '"')";
  if [ "${monitorDir}x" = 'x' ];then
    echo "Empty monitor dir";
    return;
  fi;
  /bin/busybox mkdir -p "$monitorDir" "$mountPoint/$REC_DIR/$subDir";
  if [ ! -L "$monitorDir/$subDir" ] && [ -d "$monitorDir/$subDir" ];then
    cp -r "$monitorDir/$subDir/"*  "$mountPoint/$REC_DIR/$subDir";
    rm -rf "${monitorDir:?}/$subDir/";
    ln -s "$mountPoint/$REC_DIR/$subDir" "${monitorDir:?}/$subDir";
  fi;

  if [ ! -L "$monitorDir/$subDir" ] && [ ! -f "${monitorDir:?}/$subDir" ]; then
    ln -s "$mountPoint/$REC_DIR/$subDir" "${monitorDir:?}/$subDir";
  fi;
}

/bin/busybox mount | /bin/busybox grep "$HOST";
resGrep="$?";
if [ "$resGrep" = "0" ]; then
  echo "Disk is mounted..."
  createLink;
  exit 2;
fi;

mkdir -p "$mountPoint";
/bin/busybox mount -t cifs "$HOST" "$mountPoint" -o "username=$USER,password=$PASS,vers=2.0"
resMount="$?";

if [ "$resMount" != '0' ];then
  echo "Error mount $HOST"
  exit 1;
fi;

createLink;

Press "CTRL+D" twice to finish creating the file.
Grant execution permissions:

chmod +x /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script/mount-shared-folder.sh

In the script variables "HOST, USER, PASS", specify the connection parameters to the shared folder.
Add the script to cron for automatic connection of the shared folder.
Go to the System → Customizing System Files section.
Add the following rule to the end of the /var/spool/cron/crontabs/root file:

*/1 * * * * /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script/mount-shared-folder.sh > /dev/null 2> /dev/null

Test the PBX operation to ensure that call recordings are being saved to the network drive.

Resetting WEB Interface Credentials

Steps to reset the WEB interface credentials from the MikoPBX console

You may encounter a situation where you have forgotten the username or password for the MikoPBX web interface. This guide explains how to reset them.

Solution

Go to the MikoPBX console.

The location of the console depends on the installation method:

If installed on a physical server - on the monitor connected to the server.
If installed in a virtual machine - in the virtual machine management console.
If installed in the cloud - in the cloud serial console (also in the virtual machine management console).
The reset method when installing in a Docker container is described in more detail in the current documentation.

In addition, the console can be accessed using SSH authorization. You can read more about SSH connection here.

To learn more about MikoPBX, please refer to the following documentation.

Select the option "[7] Reset password for the web interface".
Type y to confirm resetting the login and password.

Default web interface credentials:

Username: admin
Password: admin

After the first login, you will be prompted to change the credentials.

Resetting the Password in a Docker Container

Access the container shell:

docker exec -it mikopbxContainerNameOrID sh

Replace mikopbxContainerNameOrID with the name or ID of your container.

Launch the menu using this command:

/etc/rc/console_menu

Navigate to "[7] Reset password for the web interface".
Enter "y" to confirm resetting the username and password.
Log in to the web interface using the default credentials:

Default web interface credentials:

Username: admin
Password: admin

Change the login credentials after the first authorization:

The extra disk space has run out, the disk size has increased

Some virtual machines allow you to increase the disk size

Be sure to back up your data before you work!

To execute the following commands, you will need to connect to the PBX using an SSH client.

Control of free disk space

~ # df -h
Filesystem                Size      Used Available Use% Mounted on
none                    281.3M    324.0K    281.0M   0% /dev
/dev/sda2               392.3M    384.6M      3.8M  99% /offload
/dev/sda3                14.1M    915.0K     12.9M   6% /cf
/dev/sdb1                 4.9G     71.0M      4.5G   2% /storage/usbdisk1

The data storage disk is usually mounted in the "/storage/usbdisk1" directory. From the example above, it can be seen that 4.5G of 4.9G is currently available.

Disabling the disk

Before starting work, you should unmount the disk. To do this, run the script:

~ # /sbin/freestorage

Make sure that the data storage disk is no longer mounted:

~ # df -h
Filesystem                Size      Used Available Use% Mounted on
none                    281.3M    324.0K    281.0M   0% /dev
/dev/sda2               392.3M    388.3M         0 100% /offload
/dev/sda3                14.1M    915.0K     12.9M   6% /cf

Editing the Partition table

Deleting a partition

First, delete the existing partition. This operation does NOT delete data on the disk, just edits the partition table.

Launching the Section Editor:

# fdisk /dev/sdb

The system will prompt you to enter a command, enter "d" and press Enter:

Command (m for help): d

Система запросит выбрать раздел к удалению, он один, вводим номер раздела «1» и жмем Enter:

Selected partition 1

Сохраняем таблицу разделов, вводим команду «w» и жмем Enter:

Command (m for help): w

Adding a larger section

Launching the Section Editor:

# fdisk /dev/sdb

The system will prompt you to enter a command, enter "n" and press Enter:

Command (m for help): n

Next, specify the command "p", the section will be primary, press Enter:

Command action p

Enter the number of the created section "1", press Enter:

Partition number (1-4): 1

Next, the system will ask you to enter the numbers of the first and last sector "First sector" / "Last sector", wait for Enter, do not enter anything and agree with the "default" values.

Checking a new partition

The size of the partition must match the size of the disk.

~ # fdisk -l 
Disk /dev/sdb: 10 GB, 10737418240 bytes, 20971520 sectors
1305 cylinders, 255 heads, 63 sectors/track
Units: cylinders of 16065 * 512 = 8225280 bytes

Device  Boot StartCHS    EndCHS        StartLBA     EndLBA    Sectors  Size Id Type
/dev/sdb1    0,1,1       1023,254,63         63   20964824   20964762  9.9G 83 Linux

Checking the section for errors

Run the verification command:

e2fsck -f /dev/sdb1

Example of the result of the team's work:

e2fsck 1.43.4 (31-Jan-2017)
Pass 1: Checking inodes, blocks, and sizes
Pass 2: Checking directory structure
Pass 3: Checking directory connectivity
Pass 4: Checking reference counts
Pass 5: Checking group summary information
/dev/sdb1: 35/655360 files (11.4% non-contiguous), 63423/2620595 blocks

Partition file system size

Run the command:

resize2fs /dev/sdb1

Example of command output:

resize2fs 1.43.4 (31-Jan-2017)
The filesystem is already 2620595 (4k) blocks long.  Nothing to do!

Rebooting and mounting

When booting, the system will automatically mount a disk for data storage:

~ # df -h
Filesystem                Size      Used Available Use% Mounted on
none                    281.3M    324.0K    281.0M   0% /dev
/dev/sda2               392.3M    384.6M      3.8M  99% /offload
/dev/sda3                14.1M    915.0K     12.9M   6% /cf
/dev/sdb1                 9.8G     73.3M      9.2G   1% /tmp/123

Resetting WEB Interface Credentials

Steps to reset the WEB interface credentials from the MikoPBX console

You may encounter a situation where you have forgotten the username or password for the MikoPBX web interface. This guide explains how to reset them.

Solution

Go to the MikoPBX console.

The location of the console depends on the installation method:

If installed on a physical server - on the monitor connected to the server.
If installed in a virtual machine - in the virtual machine management console.
If installed in the cloud - in the cloud serial console (also in the virtual machine management console).
The reset method when installing in a Docker container is described in more detail in the current documentation.

In addition, the console can be accessed using SSH authorization. You can read more about SSH connection here.

To learn more about MikoPBX, please refer to the following documentation.

Select the option "[7] Reset password for the web interface".
Type y to confirm resetting the login and password.

Default web interface credentials:

Username: admin
Password: admin

After the first login, you will be prompted to change the credentials.

Resetting the Password in a Docker Container

Access the container shell:

docker exec -it mikopbxContainerNameOrID sh

Replace mikopbxContainerNameOrID with the name or ID of your container.

Launch the menu using this command:

/etc/rc/console_menu

Navigate to "[7] Reset password for the web interface".
Enter "y" to confirm resetting the username and password.
Log in to the web interface using the default credentials:

Default web interface credentials:

Username: admin
Password: admin

Change the login credentials after the first authorization:

Storing Recordings in a Shared Windows Folder

In some cases, it is necessary to save call recordings on a network drive. This example shows how to connect a shared Windows folder to MikoPBX.

Note: If the network folder becomes unavailable, it may cause disruptions in PBX operation.

Create a directory for the script:

mkdir /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script

Create the script file:

/cat > /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script/mount-shared-folder.sh

Insert the script content:

#!/bin/sh
HOST='//172.16.32.38/SharedFolder';
USER='';
PASS='';
REC_DIR='autorecords';
mountPoint='/storage/win-shared';

createLink ()
{
  subDir="$(date '+%Y/%m')";
  monitorDir="$(/bin/busybox grep monitordir < /etc/inc/mikopbx-settings.json | /bin/busybox cut -f 4 -d '"')";
  if [ "${monitorDir}x" = 'x' ];then
    echo "Empty monitor dir";
    return;
  fi;
  /bin/busybox mkdir -p "$monitorDir" "$mountPoint/$REC_DIR/$subDir";
  if [ ! -L "$monitorDir/$subDir" ] && [ -d "$monitorDir/$subDir" ];then
    cp -r "$monitorDir/$subDir/"*  "$mountPoint/$REC_DIR/$subDir";
    rm -rf "${monitorDir:?}/$subDir/";
    ln -s "$mountPoint/$REC_DIR/$subDir" "${monitorDir:?}/$subDir";
  fi;

  if [ ! -L "$monitorDir/$subDir" ] && [ ! -f "${monitorDir:?}/$subDir" ]; then
    ln -s "$mountPoint/$REC_DIR/$subDir" "${monitorDir:?}/$subDir";
  fi;
}

/bin/busybox mount | /bin/busybox grep "$HOST";
resGrep="$?";
if [ "$resGrep" = "0" ]; then
  echo "Disk is mounted..."
  createLink;
  exit 2;
fi;

mkdir -p "$mountPoint";
/bin/busybox mount -t cifs "$HOST" "$mountPoint" -o "username=$USER,password=$PASS,vers=2.0"
resMount="$?";

if [ "$resMount" != '0' ];then
  echo "Error mount $HOST"
  exit 1;
fi;

createLink;

Press "CTRL+D" twice to finish creating the file.
Grant execution permissions:

chmod +x /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script/mount-shared-folder.sh

In the script variables "HOST, USER, PASS", specify the connection parameters to the shared folder.
Add the script to cron for automatic connection of the shared folder.
Go to the System → Customizing System Files section.
Add the following rule to the end of the /var/spool/cron/crontabs/root file:

*/1 * * * * /storage/usbdisk1/mikopbx/custom_modules/shared-folder-script/mount-shared-folder.sh > /dev/null 2> /dev/null

Test the PBX operation to ensure that call recordings are being saved to the network drive.