Skip to content

Commit

Permalink
GITBOOK-372: No subject
Browse files Browse the repository at this point in the history
  • Loading branch information
excla1mmm authored and gitbook-bot committed Dec 18, 2024
1 parent 51e6785 commit c2323c2
Show file tree
Hide file tree
Showing 23 changed files with 228 additions and 106 deletions.
Binary file added .gitbook/assets/SshAuthorizedKeysField.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/backupSchedule.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/createBackupCopy (2).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/createBackupCopy (3).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/image (41).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/image (42).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/image (43).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/image (44).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/image (45).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/restoreFromABackup.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/savedCopy (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 added .gitbook/assets/savedCopy.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/selectingData.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/selectingData2.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/settings.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/sshConnection.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/uploadBackupFile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,10 @@
* [Setup](faq/setup/README.md)
* [Installation on MDADM RAID1](faq/setup/installation-on-mdadm-raid1.md)
* [Fine-tuning the firewall](faq/setup/fine-tuning-the-firewall.md)
* [Migrating MikoPBX to Another Server](faq/setup/change-host.md)
* [Migrating MikoPBX to Another Server](faq/setup/change-host/README.md)
* [Transfer Using Backup](faq/setup/change-host/transfer-using-backup.md)
* [Transfer using scheduled backup (SFTP)](faq/setup/change-host/transfer-using-scheduled-backup.md)
* [Transfer using rsync](faq/setup/change-host/transfer-using-rsync.md)
* [Reset to factory settings](faq/setup/reset-to-factory-settings.md)
* [Monitoring Providers on MikoPBX](faq/setup/monitoring-providers-on-mikopbx.md)
* [Management](faq/management/README.md)
Expand Down
105 changes: 0 additions & 105 deletions faq/setup/change-host.md

This file was deleted.

70 changes: 70 additions & 0 deletions faq/setup/change-host/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
description: Overview of methods for transferring MikoPBX to another server
---

# Migrating MikoPBX to Another Server

There are several ways to transfer MikoPBX to a different host (server). Each method has its advantages and special considerations. Below is a brief overview of each option, and you can refer to the detailed guides in this section.

## Option #1: Transfer Using Backup

**Description:**

A backup of the current MikoPBX configuration is created and then uploaded to the new server. This method is suitable for smaller amounts of data.

**Pros:**

* Easy to set up.
* Allows you to preserve the current configuration.

**Considerations:**

* May be less reliable for large amounts of data.
* Requires intermediate storage for the backup (e.g., local disk or cloud).



***

## Option #2: Transfer Using SFTP and Scheduled Backups

**Description:**

A backup is automatically created and saved directly to the target server via the SFTP protocol. This method is especially effective for large amounts of data.

**Pros:**

* Suitable for large amounts of data.
* Minimizes manual actions.
* Provides direct data transfer between servers.

**Considerations:**

* Requires SFTP configuration on both servers.
* Needs correct SSH user settings for proper operation.



***

## Option #3: Transfer Using rsync

**Description:**

The `rsync` command is used to directly synchronize data between the old and new servers. This method is convenient for experienced users.

**Pros:**

* Fast synchronization, even for large data volumes.
* Preserves access rights and directory structure.
* Does not require creating intermediate backups.

**Considerations:**

* Requires basic command-line knowledge.
* Possible errors if configurations (e.g., paths) are incorrect.
* Both servers must be accessible on the network at the same time.



***
25 changes: 25 additions & 0 deletions faq/setup/change-host/transfer-using-backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
description: A method to transfer MikoPBX to another host using backup
---

# Transfer Using Backup

This method involves creating a backup of your current MikoPBX configuration, transferring it, and restoring it on the new server. It’s simple to implement and suitable for small systems. This approach is convenient for users with minimal technical experience.

1. First, create a backup of your previous system. You can find detailed instructions in [this article](../../../modules/miko/module-quality-assessment.md).

<figure><img src="../../../.gitbook/assets/createBackupCopy (2).png" alt=""><figcaption><p>Creating a new backup copy</p></figcaption></figure>

2. Select the data you want to transfer and wait for the process to complete.

<figure><img src="../../../.gitbook/assets/selectingData.png" alt=""><figcaption><p>Selecting data for backup copy</p></figcaption></figure>

3. Download your archive by clicking the corresponding button in the **"Backup Module"** section:

<figure><img src="../../../.gitbook/assets/selectingData2.png" alt=""><figcaption><p>Button to download archive</p></figcaption></figure>

4. On the new host (server) with your MikoPBX installation, restore from the archive by clicking **"Upload backup file"**:

<figure><img src="../../../.gitbook/assets/uploadBackupFile.png" alt=""><figcaption><p>"<strong>Upload backup file</strong>" button</p></figcaption></figure>

After this, your system will be restored from the archive. This method is ideal for transferring small amounts of data.
83 changes: 83 additions & 0 deletions faq/setup/change-host/transfer-using-rsync.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
description: A method for transferring MikoPBX to another host using rsync (preferred)
---

# Transfer using rsync

This article discusses transferring data to a new host using `rsync`. This approach uses a generated SSH key for authentication, making it the most reliable and therefore the recommended method.

## Creating the Script File and Adding Content

1. First, establish an SSH connection to your **new** MikoPBX. You can find instructions on how to do this in [this article](../../troubleshooting/connecting-to-a-pbx-using-an-ssh-client.md).

<figure><img src="../../../.gitbook/assets/sshConnection.png" alt=""><figcaption><p>Successful SSH connection to the new MikoPBX</p></figcaption></figure>

2. Once connected, switch to the console (**\[9] Console**). First, you need to create a directory to store the script file. Use the following command:

```
mkdir -p /storage/usbdisk1/transfer
```

3. Navigate to the created directory:

```
cd /storage/usbdisk1/transfer
```

4. Create the file "**transfer-rsync.sh**" to store the script:

```
touch transfer-rsync.sh
```

<figure><img src="../../../.gitbook/assets/image (41).png" alt=""><figcaption><p>Running commands to create a file</p></figcaption></figure>

5. Next, you need to fill the file with the script content. You can find the script [here](https://gist.github.com/excla1mmm/c9891306b459cac0c7ea3c785ab0936e).

Use the following command to download the script:

```php
curl -o /storage/usbdisk1/transfer/transfer-rsync.sh https://gist.githubusercontent.com/excla1mmm/c9891306b459cac0c7ea3c785ab0936e/raw/41ada1e25e2c60b64d69f17120d3147da188cf27/transfer-rsync.sh
```

## Running and Using the Script

1. Make the file executable:

```php
chmod +x transfer-rsync.sh
```

2. Run the script:

```php
./transfer-rsync.sh
```

3. You will be prompted to enter necessary information about your old MikoPBX:

* IP address of your old station
* Username for SSH authentication
* Port for SSH authentication

<figure><img src="../../../.gitbook/assets/image (42).png" alt=""><figcaption><p>Entering the required data</p></figcaption></figure>

4. Next, you’ll be asked whether to generate a new key. If you haven’t done this before, type "y" to confirm. If you previously generated a key for accessing the second MikoPBX, type "n":

<figure><img src="../../../.gitbook/assets/image (43).png" alt=""><figcaption><p>Generating a new key</p></figcaption></figure>

5. A new SSH key will be created. You must copy this key and insert it into the web interface of your old MikoPBX at **General Settings****SSH****SSH Authorized keys** field.

<figure><img src="../../../.gitbook/assets/image (44).png" alt=""><figcaption><p>Generated ssh key</p></figcaption></figure>

<figure><img src="../../../.gitbook/assets/SshAuthorizedKeysField.png" alt=""><figcaption><p>Inserted key</p></figcaption></figure>

6. After saving the key on the old MikoPBX, wait a few seconds, then press any key to continue the script.

The transfer of all data to the new host will begin. This may take some time.

{% hint style="danger" %}
After the transfer, always verify the integrity of all data before retiring the old MikoPBX!
{% endhint %}

<figure><img src="../../../.gitbook/assets/image (45).png" alt=""><figcaption><p>Successful transfer</p></figcaption></figure>
46 changes: 46 additions & 0 deletions faq/setup/change-host/transfer-using-scheduled-backup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
description: A method to transfer MikoPBX to another host using scheduled backup via SFTP
---

# Transfer using scheduled backup (SFTP)

The second method involves setting up automatic scheduled backups, saving the data directly onto the target server via SFTP. This approach is particularly convenient for transferring larger amounts of data, as it eliminates the need for intermediate storage of the backup.

## Configuring Scheduled Backup

First, you need to configure scheduled backups for the MikoPBX you want to transfer data from.

1. Go to the **"Backup"** module. Navigate to the **"Backup Schedule"** tab:

<figure><img src="../../../.gitbook/assets/backupSchedule.png" alt=""><figcaption><p>"Backup schedule" button</p></figcaption></figure>

2. Next, set the scheduled backup parameters:

* **Server Address**: Enter the address of your new MikoPBX server.
* **Mode**: SFTP mode
* **Port**: 22
* **Username**: The SSH username for your **new** MikoPBX server.
* **Password**: The SSH password for your **new** MikoPBX server.
* **The path on the server**: `"/storage/usbdisk1/mikopbx/backup/"`

For information on SSH connection, refer to the related documentation. To start the backup immediately after saving the settings, choose the option **"Start backup immediately after saving settings"**. You can also select the specific data you want to transfer in the corresponding section.

<figure><img src="../../../.gitbook/assets/settings.png" alt=""><figcaption><p>Parameters of backup</p></figcaption></figure>

Wait for the backup to complete, and then shut down the old machine.

## Restoring from the Backup on the New Host

If the data transfer is successful, your backup will appear in the backup module section on the new host:

<figure><img src="../../../.gitbook/assets/savedCopy.png" alt=""><figcaption><p>Backup copy</p></figcaption></figure>

To restore from the backup on your new host, do the following:

1. Go to the backup settings by clicking on the respective element:

<figure><img src="../../../.gitbook/assets/savedCopy (1).png" alt=""><figcaption><p>Way to recovery settings from a copy</p></figcaption></figure>

2. Select the data you need to transfer and click **"Restore from a backup"**:

<figure><img src="../../../.gitbook/assets/restoreFromABackup.png" alt=""><figcaption><p>"Restore from a backup"</p></figcaption></figure>

0 comments on commit c2323c2

Please sign in to comment.