Homarr

Homarr is a customizable browser home page that integrates with your applications, such as torrent clients and *arrs.

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.

Homarr is currently deployed as a BETA application on our servers. This means it cannot be installed from the UCP until we have concluded it to be stable on our infrastructure.

In the meantime, Homarr can be installed via SSH. Once we officially support Homarr, it needs to be re-installed from the UCP to show up on the Apps tab.

If you have feedback or need support regarding a beta application, we have a Beta Testing section on our Discord.

Initial Setup

app-homarr install -p '<your-password>'
{"data": {"url": "https://homarr-ultradocs.hostname.usbx.me", "username": "ultradocs", "password": "kmRWdeCZnifj39gC598MXng3Hj7GyQwt", "version": "0.15.2", "port": 12345}, "result": true}

Configuration

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 use the internal address format of https://username.hostname.usbx.me/appname. Though some require the http://hostname-direct.usbx.me:PORT format. Make sure to replace username, hostname, and port with your specific details.

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.

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.