Skip to main content

🎴 IFrame

If you application is not supported natively by Homarr, you can integrate it using the iframe widget. It uses the iframe element, which embeds the desired page in the browser. This means, no traffic is routed through Homarr (and the URL must be reachable from the client).

Athough you can integrate many websites, some may not work. This is because the administrators of those sites disallow iframes for security reasons, as users could easily be tricked by embeding the original site on a malicious page.

Some proxies disallow iframes by default for this reason. You can use https://iframetester.com/ to check, if the site is allowing iframes. If you manage all of your own applications, you can usually change that.

If you want to test a page, you can use the following URL: https://en.wikipedia.org/wiki/Main_Page

iframes can be used to host streaming content, such as a youtube video, by directly linking the embed source, you can test this with the NASA ISS stream: https://www.youtube.com/embed/K5JSRGhB-nM?si=XRV7_NjreHywZbYS


Adding the widget

Please check out our documentation on how to add a widget.


Configuration

ConfigurationDescriptionValuesDefault Value
Embed URLThe page that should be embeddedURL-
Allow full screenAllow pages inside the iframe to enter full screenyes / nono
Allow scrollingAllows scrolling pass through to iframeyes / noyes
Allow transparencyAllows scrolling pass through from iframe (board transparency settings do not impact the iframe, only the border)yes / nono
Allow paymentAllow payment information pass through to iframeyes / nono
Allow auto playAllows videos to autoplayyes / nono
Allow microphoneAllows microphone pass through to iframeyes / nono
Allow cameraAllows camera pass through to iframeyes / nono
Allow geolocationAllows geolocation pass through to iframeyes / nono
tip

Check out our documentation on editing tiles.


Screenshots


Third party content

info

The content below is an overview of third party projects. All support requests/problems must be redirected to the appropriate repository.

homarr-iframes from Diogo Valentim

The project homarr-iframes has iframes designed to be used with Homarr, these iframes offer a minimalist view of other systems:

  • Vikunja: overview of your tasks with links to them.
  • Linkwarden: overview of your bookmarks with links to them.
  • Cinemark Brazil: overview of the movies in Cinemark theaters in your city (only in Brazil).

Image of the Vikunja (left), Linkwarden (middle), and Cinemark Brazil (right) iframes on a Homarr dashboard

You can configure the iframes appearance and behavior using query arguments when adding them to your dashboard, like selecting the iframe theme and limit of items to show, and other options specific to each iframe.