📘

Homarr

Homarr is a browser-based dashboard that integrates a wide variety of applications. With Homarr, you can access and control everything in one convenient location.

For more information about this app, follow this link.

Initial Setup

From your User Control Panel, go to the Installers tab and find Homarr in the list.
Click the Install button and wait until the installation has been completed.

Configuration

After the installation, access the webUI of Homarr from the Apps tab on the UCP.
You will be presented with a login form, log in with your Ultra service username and the password that you previously set during the installation.

Once you have successfully logged in, you will see your Homarr dashboard.
To add an application, click the Enter Edit Mode button in the top right corner.

While in edit mode, you can move the existing tiles by dragging them across the screen, or you can edit them by pressing the cog icon in the top right corner of the specific tile.

Next, to add an application, click the Add Tile icon in the top right corner.

A window will appear, where you can select what kind of tile you want to add. In this guide.
To add an application integration tile, click the Apps button.

After clicking the Apps button in the previous step, you will be presented with a new window where you need to enter the connection details for the application you want to add. We will use qBittorrent as an example, but the procedure is more or less the same for any other application.
The General and Integration tabs are the bare minimum that needs to be configured, the rest of the tabs are optional.

1 App name
2 Internal address
3 External address

When adding the Internal & External address, make sure to not end the URL with /, as this could break the integration. Only use the main domain of your server.

Most applications are configured with a base URL, such as https://username.hostname.usbx.me/appname
Though some applications can only be accessed via the following format: http://appname-username.usbx.me. This can be confirmed on the UCP.
Make sure to replace username, hostname, and port with your specific details.

Let's begin with the General tab, enter the following:

App name: Name your application
Internal address: https://username.hostname.usbx.me/qbittorrent
External address: https://username.hostname.usbx.me/qbittorrent

Be sure to replace username and hostname with the specific details for your service.
Next, go to the Integration tab.

Some applications will require an API Key to authenticate instead of a username and password.
For example, the *arr suite of applications will require an API Key, which most often can be found in Settings > General of the application you are integrating with Homarr.
To integrate Plex, you will need to fetch your X-Plex-Token, instructions can be found here.

Under the Integration tab, begin by selecting 1 qBittorrent from the Integration configuration drop-down menu.
In the 2 Username field, enter your Ultra service username.
In the 3 Password field, enter your qBittorrent password, which can be found on the UCP.
Lastly, click the 4 Save button.

Do not forget to exit the tile edit mode by pressing the Exit and Save button in the top right corner of the Homarr dashboard.
You should now see a qBittorrent tile added on your Homarr dashboard. To add more app integration tiles, simply repeat the above procedure.

Set Dark/Light Theme

By default, Homarr will install with a light theme. To toggle between a dark and light theme, you need to access the application at container level. To achieve this, we have added an option to the install/upgrade command of Homarr. For example, to toggle a dark or light theme, follow the instructions provided below.

Connect to your Ultra service via SSH.
Execute an install/upgrade action for Homarr:

Set dark theme: app-homarr upgrade --color-theme='dark'
Set light theme: app-homarr upgrade --color-theme='light'Homarr

Homarr V1

Homarr V1 is now available on the User Control Panel. Due to major changes in the Homarr V1 installation procedure, it is not compatible with our existing Homarr installer.

New Installation

This method is to be used if you do not have an existing instance and you are installing Homarr for the first time.

Navigate to your UCP.
Go to the Installers tab and find Homarr V1.
Click the Install button and choose a strong password.
Once the installation has finished, go to the Apps tab and find Homarr V1 in the list.
Click the Show info button to reveal the webUI URL and your login credentials.

Migrate Homarr (Legacy) to Homarr V1

This method is to be used if you already have an existing legacy instance of Homarr, and want to migrate your configuration to Homarr V1.

To migrate your configuration from the legacy version of Homarr to Homarr V1, please follow these steps:

Open your existing legacy Homarr webUI and click the profile icon in the top-right corner to reveal a context menu.
In the menu, click Manage.
In the menu on the left-hand side, click the Tools tab.
Select everything you want to export, then click the Export data button.
Important: After downloading the .zip file, make sure to copy or save the import token/encryption key shown. You will need it to complete the import in Homarr V1.

Once you have downloaded your boards and taken note of your import token, you can proceed to install Homarr V1.

Navigate to your UCP and install Homarr V1.

Make sure to enable Migrate from version before 1.0 (Optional) and leave the password fields blank.

Once the installation has finished, open the Homarr V1 webUI.
Next, you will be presented with a setup wizard.
Click the Import from Homarr before 1.0 button and upload the .zip file, and enter the saved token when prompted.

Choose the parameters you would like to import.
Done!

If you require further assistance, you can open a support ticket here!

Feedback and suggestions regarding this article are welcome on our Discord server

Homarr
Initial Setup
Configuration
Set Dark/Light Theme
Homarr V1
New Installation
Migrate Homarr (Legacy) to Homarr V1

📘

Homarr

Homarr is a browser-based dashboard that integrates a wide variety of applications. With Homarr, you can access and control everything in one convenient location.

For more information about this app, follow this link.

Initial Setup

From your User Control Panel, go to the Installers tab and find Homarr in the list.
Click the Install button and wait until the installation has been completed.

Configuration

After the installation, access the webUI of Homarr from the Apps tab on the UCP.
You will be presented with a login form, log in with your Ultra service username and the password that you previously set during the installation.

Once you have successfully logged in, you will see your Homarr dashboard.
To add an application, click the Enter Edit Mode button in the top right corner.

While in edit mode, you can move the existing tiles by dragging them across the screen, or you can edit them by pressing the cog icon in the top right corner of the specific tile.

Next, to add an application, click the Add Tile icon in the top right corner.

A window will appear, where you can select what kind of tile you want to add. In this guide.
To add an application integration tile, click the Apps button.

After clicking the Apps button in the previous step, you will be presented with a new window where you need to enter the connection details for the application you want to add. We will use qBittorrent as an example, but the procedure is more or less the same for any other application.
The General and Integration tabs are the bare minimum that needs to be configured, the rest of the tabs are optional.

1 App name
2 Internal address
3 External address

Let's begin with the General tab, enter the following:

App name: Name your application
Internal address: https://username.hostname.usbx.me/qbittorrent
External address: https://username.hostname.usbx.me/qbittorrent

Be sure to replace username and hostname with the specific details for your service.
Next, go to the Integration tab.

Under the Integration tab, begin by selecting 1 qBittorrent from the Integration configuration drop-down menu.
In the 2 Username field, enter your Ultra service username.
In the 3 Password field, enter your qBittorrent password, which can be found on the UCP.
Lastly, click the 4 Save button.

Do not forget to exit the tile edit mode by pressing the Exit and Save button in the top right corner of the Homarr dashboard.
You should now see a qBittorrent tile added on your Homarr dashboard. To add more app integration tiles, simply repeat the above procedure.

Set Dark/Light Theme

Connect to your Ultra service via SSH.
Execute an install/upgrade action for Homarr:

Set dark theme: app-homarr upgrade --color-theme='dark'
Set light theme: app-homarr upgrade --color-theme='light'Homarr

Homarr V1

Homarr V1 is now available on the User Control Panel. Due to major changes in the Homarr V1 installation procedure, it is not compatible with our existing Homarr installer.

New Installation

This method is to be used if you do not have an existing instance and you are installing Homarr for the first time.

Navigate to your UCP.
Go to the Installers tab and find Homarr V1.
Click the Install button and choose a strong password.
Once the installation has finished, go to the Apps tab and find Homarr V1 in the list.
Click the Show info button to reveal the webUI URL and your login credentials.

Migrate Homarr (Legacy) to Homarr V1

This method is to be used if you already have an existing legacy instance of Homarr, and want to migrate your configuration to Homarr V1.

To migrate your configuration from the legacy version of Homarr to Homarr V1, please follow these steps:

Open your existing legacy Homarr webUI and click the profile icon in the top-right corner to reveal a context menu.
In the menu, click Manage.
In the menu on the left-hand side, click the Tools tab.
Select everything you want to export, then click the Export data button.
Important: After downloading the .zip file, make sure to copy or save the import token/encryption key shown. You will need it to complete the import in Homarr V1.

Once you have downloaded your boards and taken note of your import token, you can proceed to install Homarr V1.

Navigate to your UCP and install Homarr V1.

Make sure to enable Migrate from version before 1.0 (Optional) and leave the password fields blank.

Once the installation has finished, open the Homarr V1 webUI.
Next, you will be presented with a setup wizard.
Click the Import from Homarr before 1.0 button and upload the .zip file, and enter the saved token when prompted.

Choose the parameters you would like to import.
Done!

If you require further assistance, you can open a support ticket here!

Feedback and suggestions regarding this article are welcome on our Discord server

Homarr
Initial Setup
Configuration
Set Dark/Light Theme
Homarr V1
New Installation
Migrate Homarr (Legacy) to Homarr V1