UISP Cloud Hosting - Migration scenarios

Note: UPG (Ubiquiti Payment Gateway) is not available on UISP Console or Local instance

Migration from UISP Cloud Hosting to UISP Console

• Seamless migration using the same hostname
• Manual migration using the same hostname
• Manual migration using a different hostname

Migration from UISP Cloud Hosting to Local instance/custom server

• Manual migration to Local instance/custom server

Seamless migration from UISP Cloud Hosting to UISP Console using the same hostname via the UISP Mobile App

Prerequisites

1. Ensure that your UISP Cloud Hosting is running the latest version.
2. Make sure that the UISP Mobile App is on version 3.2.4 or newer on Android or 2.35.0 or newer on iOS.
3. Ensure that at least one device is connected in UISP Cloud Hosting.
4. Verify that the UISP Console is in its factory default state.
5. Your SSO account have to be owner of UISP Cloud Hosting.

Migration

1. Log out of the UISP Application in the UISP Mobile App (Standalone Mode).
2. Connect the WAN port of the UISP Console to the internet.
3. In the Discovered Devices section of the UISP Mobile App, tap the UISP Console you want to migrate to.
4. Wait for the UISP Console to complete its setup.
5. Tap Migrate Cloud Console, select your UISP Cloud Hosting, and start the migration by tapping the Migrate button.
6. Wait approximately 20 minutes for the migration to finish, and do not leave the UISP Mobile App during this time. The latest UISP application will be installed on the UISP Console, and all data will be migrated.
7. Log in and complete the setup wizard.

Note: In case of a migration from unmsapp.com, the new domain will be uisp.com. This change has no impact, as both domains are configured in the DNS settings of the UISP Console proxy. Therefore, hostname.unmsapp.com will function the same as hostname.uisp.com.

Manual migration from UISP Cloud to UISP Console using the same hostname

1. Prepare the backup of the Cloud Console

   1. Go to the UISP Cloud Hosting from which you are migrating.
   2. Check the backup settings in the CRM module: System → Tools → Backup and enable all entities you want to include in the migration backup.
   3. Create the backup of the UISP Cloud Hosting.
      1. Go to UISP Application → Settings → Backup → Click Create Backup button.
      2. Wait for the backup to be created and download it to your PC.
   4. Delete your UISP Cloud Hosting.

2. Set up a new UISP Console

   1. Power on the new UISP Console.
   2. Start the UISP Mobile app and log in with the same SSO account you were using for the UISP Cloud Hosting you want to migrate from.
   3. Wait for the adoption modal with UISP Console to appear and go through the Setup wizard.
   4. Wait for the setup wizard to finish and ensure you can access the UISP Application.
   5. Update the UISP Application to the latest stable version, if the update is available.

3. Restore backup on UISP Console

   1. Log in to the UISP Application running on the UISP Console.
   2. Restore the backup in the UISP Application: Go to Settings → Backup → Click Restore from File button.
   3. Wait for the restoring process to finish.
   4. After restoring, you will need to wait a bit to be able to log in with an SSO account.
      You might have seen this message for some time: “Authentication failed. The UI Account you are currently using is not bound to the SSO used for this UISP Console.“
   5. Assign the pending UISP Console device to the site after the restore; it’s the Console UISP is running on. Due to the backup restore from another instance, the Console is in a pending adoption state.
   6. The vault key will be transferred from the UISP Cloud Hosting.
   7. Check mail server settings in UISP Network: Settings → General → Mail Server on UISP Console.

Note: In case of a migration from unmsapp.com, the new domain will be uisp.com. This change has no impact, as both domains are configured in the DNS settings of the UISP Console proxy. Therefore, hostname.unmsapp.com will function the same as hostname.uisp.com.

Migration from UISP Cloud Hosting to UISP Console using a different hostname

1. Prepare the backup of the UISP Cloud Hosting

   1. Go to the UISP Cloud Hosting from which you are migrating.
   2. Stop automatic billing and payment processing in the CRM module: System → Billing → Invoicing.
      1. Disable the Automatic billing enabled option.
      2. Disable the Online payment processing option.
   3. Disable Client zone in the CRM module: System → Settings → Client zone → disable Enable client zone option.
   4. Check the backup settings in the CRM module: System → Tools → Backup and enable all entities you want to include in the migration backup.
   5. Create the backup of the UISP Cloud Hosting.
      1. Go to UISP Application → Settings → Backup → Click Create Backup button.
      2. Wait for the backup to be created and download it to your PC.

2. Set up a new UISP Console

   1. Power on the new UISP Console.
   2. Start the UISP Mobile app and log in with the same SSO account you were using for the UISP Cloud Hosting you want to migrate from.
   3. Wait for the adoption modal with UISP Console to appear and go through the Setup wizard.
   4. Wait for the setup wizard to finish and ensure you can access the UISP Application.
   5. Update the UISP Application to the latest stable version if an update is available.

3. Restore backup on UISP Console

   1. Log in to the UISP Application running on the UISP Console.
   2. Restore the backup in the UISP Application: Go to Settings → Backup → Click Restore from File button.
   3. Wait for the restoring process to finish.
   4. After the restore, you will need to wait a bit to be able to log in with the SSO account.
      You might have seen this message for some time: “Authentication failed. The UI Account you are currently using is not bound to the SSO used for this UISP Console.“
   5. Assign the pending UISP Console device to the site after the restore; it’s the Console UISP is running on. Due to the backup restore from another instance, the Console is in a pending adoption state.
   6. The vault key will be transferred from the UISP Cloud Hosting.
   7. Check mail server settings in UISP Network: Settings → General → Mail Server on UISP Console.
   8. Set the proper hostname in UISP Network: Settings → General → UISP Hostname.
   9. Enable previously disabled options in the CRM module: Automatic billing, Online payment processing, and Client zone on UISP Console.

4. Migrate devices to UISP Console

   1. Go to the UISP Cloud Hosting you are migrating from and enable migration mode in Settings → Devices → Migration.
      1. Enable the option Migration Mode.
      2. Enable the option With Backup.
      3. Fill in the new hostname in the Hostname field.
      4. Optional: if you are using a custom port, you can set the Port option. The default value is 443.
      5. Apply changes.
   2. All devices should connect to the new UISP application.

5. Configure new UISP instance running on UISP Console

   1. Check mail server settings in Settings → General → Mail Server.
   2. Set the proper hostname in Settings → General → UISP Hostname.
   3. Enable previously disabled options in the CRM module: Automatic billing, Online payment processing, and Client zone on UISP Console.

Tips

• Don’t forget to inform your clients that the URL of the client section has changed to the new domain.
• Check your 3rd party integrations and update the URL to the new one.

Migration from UISP Cloud Hosting to Local instance/custom server

1. Prepare the backup of the UISP Cloud Hosting

   1. Go to the UISP Cloud Hosting from which you are migrating.
   2. Stop automatic billing and payment processing in the CRM module: System → Billing → Invoicing.
      1. Disable the Automatic billing enabled option.
      2. Disable the Online payment processing option.
   3. Disable Client zone in the CRM module: System → Settings → Client zone → disable Enable client zone option.
   4. Check the backup settings in the CRM module: System → Tools → Backup and enable all entities you want to include in the migration backup.
   5. Create the backup of the UISP Cloud Hosting.
      1. Go to UISP Application → Settings → Backup → Click Create Backup button.
      2. Wait for the backup to be created and download it to your PC.

2. Setup new UISP Application on your server

   1. Set up a new UISP instance on your local server, click the Upload Backup button during the setup.
   2. Wait for the setup wizard to be finished and ensure you can access the UISP Application.
   3. Wait for the restoring process to be finished.
   4. Set password for at least one user using UISP CLI:
      1. SSH to your local server.
      2. Print list of users: /home/unms/app/unms-cli set-password.
      3. Set password for selected user: /home/unms/app/unms-cli set-password --username <USERNAME>.
      4. Login to UISP using the new set password.

3. Migrate devices to a new instance

   1. Go to your UISP Cloud Hosting you are migrating from and enable migration mode in Settings → Devices → Migration.
      1. Enable the option Migration Mode.
      2. Enable the option With Backup.
      3. Fill in the new hostname in the Hostname field.
      4. Optional: if you are using a custom port, you can set the Port option. The default value is 443.
      5. Apply changes.
   2. All devices should connect to the new UISP application.

4. Config a new UISP instance running on the local server

   1. Check mail server settings in Settings → General → Mail Server.
   2. Set proper hostname in Settings → General → UISP Hostname.
   3. Enable previously disabled options in the CRM module: Automatic billing, Online payment processing, and Client zone on the UISP Console.
   4. Download the Vault key from UISP Cloud Hosting: go to UISP Portal → click three dots and select Download Vault.
   5. Upload the vault key in the UISP Application running on your local server: go to Settings → Credentials Vault → Upload the key.

Tips

• Don’t forget to inform your clients that the URL of the client section has changed to the new domain.
• Check your 3rd party integrations and update the URL to the new one.