Integrations
Integrations are a useful way to further connect and manage your network. They may require additional configuration in or outside Homarr. An integration cannot be added by itself. You must configure an app to a specific integration. Most integration will then fill widgets with data or add functionality to other parts of Homarr.
The following integrations are available:
- Torrent Clients
- Usenet Clients
- Collection Managers
- Media Servers
- Dash.
- Overseerr & Jellyseerr (media requests)
- Docker
Homarr usually does not support beta, alpha or older legacy versions of integrations, because new versions often contain breaking API changes.
We will not support these, because the underlying API often changes frequently and would require much attention for very little outcome.
Torrent Clients​
Homarr supports a total of 3 Torrent clients (Deluge, Transmission and qBittorrent). You can use them to display your torrents directly on your dashboard and see if you are leeching / seeding.
Deluge​
The Deluge integration is used by the following widgets:
Available configuration options
| Field | Type | Description |
|---|---|---|
| Password | Private | Used for authenticating with the Deluge service |
Transmission​
The Transmission integration is used by the following widgets:
Available configuration options
| Field | Type | Description |
|---|---|---|
| Username | Private | Username used for authentication |
| Password | Private | Password used for authentication |
qBittorrent Integration​
The qBittorrent integration is used by the following widgets:
Available configuration options
| Field | Type | Description |
|---|---|---|
| Username | Private | Username used for authentication |
| Password | Private | Password used for authentication |
Please note the known issue with qBittorrent: qBittorrent webUI showing Unauthorized
Usenet Clients​
Usenet clients are an alternative to Torrent clients and enable you to download a wide variety of files.
SABnzbd​
The SABnzbd integration directly communicates with your download client and enables you to view and control your downloads directly from Homarr. You can use this integration from the Usenet Widget.
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
NZBGet​
The NZBGet integration directly communicates with your download client and enables you to view and control your downloads directly from Homarr. You can use this integration from the Usenet Widget.
Available configuration options
| Field | Type | Description |
|---|---|---|
| Username | Private | Username used for authentication |
| Password | Private | Password used for authentication |
Collection Managers​
Sonarr​
Homarr will integrate the shows of your Sonarr calendars in the Calendar Widget
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
Radarr​
Homarr will integrate the shows of your Radarr calendars in the Calendar Widget
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
Lidarr​
Homarr will integrate the shows of your Lidarr calendars in the Calendar Widget
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
Readarr​
Homarr will integrate the shows of your Readarr calendars in the Calendar Widget
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
Media Servers​
Homarr can integrate with your media servers, which allows you to control it from your dashboard. You may add multiple media servers, also of different kinds, to your dashboard.
We recommend creating a separate account just for Homarr. Only grant access to the libraries and permissions that you require to be accessed by Homarr. This allows for better security.
Jellyfin​
The Jellyfin integration enables you to view the active sessions, using the Media Server widget, on your dashboard.
Available configuration options
| Field | Type | Description |
|---|---|---|
| Username | Private | Username used for authentication |
| Password | Private | Password used for authentication |
Plex​
The Plex integration enables you to view the active sessions, using the Media Server widget, on your dashboard.
For a successful integration, remember that the internal address should not have a path, only the IP and the port (http://IP:port).
In this case it would mean to remove anything of the likes of "/web/index.html" from the link you would usually use.
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
Overseerr & Jellyseerr​
The Overseerr integration will enable you to request movies and series directly from your Homarr dashboard.
After choosing the correct type, you can search for content:
It displays, which content is already in your Overseerr library and links available content directly to your Plex or Jellyfin instance.
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
Initial setup​
Installation of Media Server​
The Overseer integration supports both Overseerr and Jellyseerr, a fork of Overseerr compatible with Jellyfin.
- 🎬 Plex Media Server
- 🎬 Jellyfin Media Server
Install Plex on your machine using your preferred installation method: https://www.plex.tv/
We recommend the installation using Docker for the easiest and fastest installation.
Install Jellyfin on your machine using your preferred installation method: https://jellyfin.org/docs/general/administration/installing.html
We recommend the installation using Docker for the easiest and fastest installation.
Installation of Media requester​
- 🎬 Plex Media Server
- 🎬 Jellyfin Media Server
After you have your Plex instance up and running, you must install Overseer as your media request application. Please read the official documentation of how to install Overseerr on your machine: https://docs.overseerr.dev/getting-started/installation.
Officially, Jellyfin is not supported by Overseerr. This is why Jellyfin users must use a fork of the official Overseerr project, which was modified to work with Jellyfin: https://github.com/Fallenbagel/jellyseerr.
We recommend the installation using Docker for the easiest and fastest installation.
Add your application in Homarr​
If your instance of Overseerr or Jellyseerr is up and running, it's time to add it to your dashboard. Simply select the correct type from the integration tab when editing the application:
- 🎬 Plex Media Server
- 🎬 Jellyfin Media Server
Select Overseerr in the app type for your Overseerr app.
Fill our the field Api token with from the link below, when having Overseerr as the app type selected.
Select Jellyseerr in the app type for your Jellyseerr app.
Fill our the field Api token with from the link below, when having Jellyseerr as the app type selected.
Searching for a movie / series​
To search for a movie or series, simply press CTRL + K or click into the search box.
Then, type !os (with a space at the end) and enter, what you want to search for.
The integration will display, what content is already available in your media library.
Seasons selection​
If you're selecting a series, you'll be asked what seasons you want to request:
DNS Holes​
Homarr allows the integration of DHS-holes to control them and display their stats. Multiple DNS-holes can be added at the same time. Currently, only PiHole and AdGuard Home are supported.
PiHole​
The PiHole integration enables you to see basic stats like the number of queries in the day and how many are blocked.
You can also disable and enable it using the dns-hole control widget.
For a successful integration, remember that the internal address should not have a path, only the IP and the port (http://IP:port).
In this case it would mean to remove anything of the likes of "/admin" from the link you would usually use.
Available configuration options
| Field | Type | Description |
|---|---|---|
| ApiToken | Private | Token used for authentication |
AdGuard Home​
The Adguard Home integration enables you to see basic stats like the number of queries in the day and how many are blocked.
You can also disable and enable it using the dns-hole control widget.
Available configuration options
| Field | Type | Description |
|---|---|---|
| Username | Private | Username used for authentication |
| Password | Private | Password used for authentication |
Dash.​
The Dash. integration can be used to monitor the performance and used system resources of your machine. Dash. will be used in the Dash.
Docker​
Homarr allows you to interact with Docker containers running on your system.
You can restart, stop, start, refresh and remove containers as well as add them to the Homarr dashboard
Additionally, if you have a lot of containers you can search and filter them by container or image name
View the state of each container (created, running or stopped)
And also check what ports the container has exposed (container port:external port)
Before you begin​
In order for Homarr to be able to interact with your Docker instance you must tell Homarr the path to your Docker socket. You do this by adding the following to the Docker command when you first run Homarr:
-v /var/run/docker.sock:/var/run/docker.sock
If you are running Docker Desktop on Windows 10, use the following path to your Docker socket:
-v //var/run/docker.sock:/var/run/docker.sock