# Homarr documentation ## search - [Search the documentation](/search.md) ## docs - [Tags](/docs/tags.md) - [One doc tagged with "Active Directory"](/docs/tags/active-directory.md) - [3 docs tagged with "Administration"](/docs/tags/administration.md) - [4 docs tagged with "Advanced"](/docs/tags/advanced.md) - [One doc tagged with "AI"](/docs/tags/ai.md) - [One doc tagged with "Analytics"](/docs/tags/analytics.md) - [3 docs tagged with "API"](/docs/tags/api.md) - [One doc tagged with "Apps"](/docs/tags/apps.md) - [One doc tagged with "Automation"](/docs/tags/automation.md) - [One doc tagged with "Background"](/docs/tags/background.md) - [One doc tagged with "Backup"](/docs/tags/backup.md) - [One doc tagged with "Boards"](/docs/tags/boards.md) - [One doc tagged with "Bookmarks"](/docs/tags/bookmarks.md) - [One doc tagged with "Caddy"](/docs/tags/caddy.md) - [One doc tagged with "Certificates"](/docs/tags/certificates.md) - [2 docs tagged with "Code"](/docs/tags/code.md) - [5 docs tagged with "Community"](/docs/tags/community.md) - [5 docs tagged with "Configuration"](/docs/tags/configuration.md) - [One doc tagged with "Connections"](/docs/tags/connections.md) - [One doc tagged with "Custom Widgets"](/docs/tags/custom-widgets.md) - [2 docs tagged with "Customization"](/docs/tags/customization.md) - [One doc tagged with "Data"](/docs/tags/data.md) - [One doc tagged with "Data sources"](/docs/tags/data-sources.md) - [One doc tagged with "Database"](/docs/tags/database.md) - [2 docs tagged with "Developer"](/docs/tags/developer.md) - [One doc tagged with "Development"](/docs/tags/development.md) - [4 docs tagged with "Docker"](/docs/tags/docker.md) - [One doc tagged with "Donation"](/docs/tags/donation.md) - [One doc tagged with "Edit mode"](/docs/tags/edit-mode.md) - [One doc tagged with "Env"](/docs/tags/env.md) - [One doc tagged with "Environment variables"](/docs/tags/environment-variables.md) - [2 docs tagged with "Getting started"](/docs/tags/getting-started.md) - [One doc tagged with "Google"](/docs/tags/google.md) - [One doc tagged with "Groups"](/docs/tags/groups.md) - [2 docs tagged with "Help"](/docs/tags/help.md) - [One doc tagged with "Icon picker"](/docs/tags/icon-picker.md) - [One doc tagged with "Icon repositories"](/docs/tags/icon-repositories.md) - [2 docs tagged with "Icons"](/docs/tags/icons.md) - [One doc tagged with "Installation"](/docs/tags/installation.md) - [One doc tagged with "Integration"](/docs/tags/integration.md) - [One doc tagged with "Integrations"](/docs/tags/integrations.md) - [One doc tagged with "Interface"](/docs/tags/interface.md) - [One doc tagged with "Jobs"](/docs/tags/jobs.md) - [One doc tagged with "JSX"](/docs/tags/jsx.md) - [One doc tagged with "Layout"](/docs/tags/layout.md) - [One doc tagged with "LDAP"](/docs/tags/ldap.md) - [4 docs tagged with "Management"](/docs/tags/management.md) - [One doc tagged with "MCP"](/docs/tags/mcp.md) - [One doc tagged with "Media"](/docs/tags/media.md) - [One doc tagged with "OIDC"](/docs/tags/oidc.md) - [One doc tagged with "OpenCollective"](/docs/tags/open-collective.md) - [One doc tagged with "Permissions"](/docs/tags/permissions.md) - [One doc tagged with "PGID"](/docs/tags/pgid.md) - [One doc tagged with "Ping"](/docs/tags/ping.md) - [2 docs tagged with "Programming"](/docs/tags/programming.md) - [One doc tagged with "Proxy"](/docs/tags/proxy.md) - [One doc tagged with "PUID"](/docs/tags/puid.md) - [One doc tagged with "Redis"](/docs/tags/redis.md) - [One doc tagged with "Responsive"](/docs/tags/responsive.md) - [One doc tagged with "Roles"](/docs/tags/roles.md) - [One doc tagged with "Search"](/docs/tags/search.md) - [One doc tagged with "Search engines"](/docs/tags/search-engines.md) - [One doc tagged with "Secrets"](/docs/tags/secrets.md) - [2 docs tagged with "Security"](/docs/tags/security.md) - [One doc tagged with "Self signed"](/docs/tags/self-signed.md) - [One doc tagged with "SEO"](/docs/tags/seo.md) - [One doc tagged with "Server"](/docs/tags/server.md) - [One doc tagged with "Settings"](/docs/tags/settings.md) - [One doc tagged with "SQLite"](/docs/tags/sq-lite.md) - [One doc tagged with "SSO"](/docs/tags/sso.md) - [One doc tagged with "Tasks"](/docs/tags/tasks.md) - [2 docs tagged with "Technical documentation"](/docs/tags/technical-documentation.md) - [One doc tagged with "Traefik"](/docs/tags/traefik.md) - [One doc tagged with "Translations"](/docs/tags/translations.md) - [One doc tagged with "Unraid"](/docs/tags/unraid.md) - [One doc tagged with "Uploads"](/docs/tags/uploads.md) - [2 docs tagged with "Users"](/docs/tags/users.md) - [One doc tagged with "Variables"](/docs/tags/variables.md) - [One doc tagged with "Widgets"](/docs/tags/widgets.md) - [Command line interface](/docs/advanced/command-line.md): The Homarr image ships with a built-in recovery tool. This can be useful, if you do not have access to Homarr or if something is not working. - [Fix usernames](/docs/advanced/command-line/fix-usernames.md): This guide requires that you understand how to access the CLI. - [Integrations](/docs/advanced/command-line/integrations.md): This guide requires that you understand how to access the CLI. - [Password Recovery](/docs/advanced/command-line/password-recovery.md): This guide requires that you understand how to access the CLI. - [Users](/docs/advanced/command-line/users.md): This guide requires that you understand how to access the CLI. - [Getting started](/docs/advanced/development/getting-started.md): Setting up your development environment - [Kubernetes](/docs/advanced/development/kubernetes.md): This guide provides step-by-step instructions for setting up a Kubernetes cluster using kind, configuring multiple nodes, and installing the Metrics Server. - [Environment variables](/docs/advanced/environment-variables.md): Homarr offers a few environment variables, which can be used to configure the container. - [Icons](/docs/advanced/icons.md): Icon picker - [Keyboard Shortcuts](/docs/advanced/keyboard-shortcuts.md): Homarr has the following keyboard shortcuts: - [Proxies and Certificates](/docs/advanced/proxy.md): Allowing self-signed certificates - [Running as a different user](/docs/advanced/running-as-different-user.md): By default the container is running with user root and group root. - [Single Sign On](/docs/advanced/single-sign-on.md): Homarr supports multiple authentication options, from internal userbase (credentials), to LDAP (with Active directory support), and OIDC. - [Styling](/docs/advanced/styling.md): This page is directed at more experienced users with knowledge about CSS and browsers. - [Advanced Concepts or features](/docs/category/advanced.md) - [Community](/docs/category/community.md) - [Developer guides](/docs/category/developer-guides.md) - [Getting started](/docs/category/getting-started.md) - [Getting started](/docs/category/installation.md) - [Getting started](/docs/category/installation-1.md) - [Integrations](/docs/category/integrations.md): Integration are a principal part of homarr, it's where you can connect your other apps to interact with them with widgets or other capabilities, Homarr currently integrates with the following applications: - [Management pages](/docs/category/management.md) - [Widgets](/docs/category/widgets.md): Widgets allow you to show data on your board or control applications. Click on one of the widgets below for further information: - [Donate](/docs/community/donate.md): Why to donate - [Frequently Asked Questions](/docs/community/faq.md): Can I install Homarr on a Raspberry Pi? - [Get In Touch](/docs/community/get-in-touch.md): Still have a question? Click here! - [License](/docs/community/license.md): Homarr is licensed under Apache 2.0. - [Translations](/docs/community/translations.md): We want to make Homarr accessible for everyone. - [Prerequisites](/docs/getting-started.md): Before you try to install Homarr, please review if your device meets the requirements. - [After the installation](/docs/getting-started/after-the-installation.md): Read our glossary if you are new to Homarr. - [Glossary](/docs/getting-started/glossary.md): In the glossary, you'll learn the different components and their names of Homarr. - [Docker](/docs/getting-started/installation/docker.md): Docker is our recommended installation method for beginners and professionals. - [EasyPanel](/docs/getting-started/installation/easy-panel.md): Easypanel has not updated to 1.0 yet. There template is still on 0.15.4. - [Helm](/docs/getting-started/installation/helm.md): Version: 8.22.0 - [Home Assistant Add-on](/docs/getting-started/installation/home-assistant.md): Home Assistant Add-on is now updated to 1.0. Please add the new repository to your Add-on store. Also make sure to follow the migration guide so you don't lose your existing setup. - [Pika Pods](/docs/getting-started/installation/pika-pods.md): Pika Pods is a hosting platform for open source apps. You can deploy Homarr on Pika Pods with just a few clicks: - [Portainer](/docs/getting-started/installation/portainer.md): Portainer Stacks - [Proxmox](/docs/getting-started/installation/proxmox.md): This guide covers how to install homarr inside of a linux-container in ProxmoxVE, using a fully automated approach. - [QNAP](/docs/getting-started/installation/qnap.md): QNAP installation guide has not updated to 1.0 yet. There guide is still for 0.15.10. - [Railway](/docs/getting-started/installation/railway.md): Railway is a cloud platform that allows you to deploy your apps with ease. You can deploy Homarr on Railway with a few clicks. - [Runtipi](/docs/getting-started/installation/runtipi.md): Runtipi is a self-hosted orchestrator that makes it easy to manage and run multiple services on a single server. It is based on Docker and comes with a simple web interface to manage your services. Runtipi is designed to be easy to use, so you don't have to worry about manual configuration or networking. - [Saltbox](/docs/getting-started/installation/saltbox.md): Saltbox installation command has not updated to 1.0 yet. There command still runs 0.15.10. - [(Not recommended): From source](/docs/getting-started/installation/source.md): Installing from source is a bad idea in many ways: - [Synology](/docs/getting-started/installation/synology.md): The installation process is quite easy and fast on Synology devices. - [Unraid](/docs/getting-started/installation/unraid.md): You can install Homarr directly from your Unraid Dashboard, no terminal required. - [AdGuard Home](/docs/integrations/adguard-home.md): AdGuard Home is a network-wide software for blocking ads and trackers, providing a safer and faster internet experience. - [Anchor](/docs/integrations/anchor.md): Anchor is a self-hosted note-taking application. - [ArchiveTeam Warrior](/docs/integrations/archiveteam-warrior.md): ArchiveTeam Warrior is an easy-to-run virtual machine that helps preserve websites by using some of your bandwidth and disk space to download and upload content to ArchiveTeam’s archive. - [Aria2](/docs/integrations/aria2.md): Lightweight multiprotocol & multi-source command-line download utility. It supports HTTP/HTTPS, FTP, SFTP, BitTorrent and Metalink - [Audiobookshelf](/docs/integrations/audiobookshelf.md): Audiobookshelf is a self-hosted audiobook and podcast server that lets you manage and stream your audio library. - [Bazarr](/docs/integrations/bazarr.md): Bazarr is a companion application to Sonarr and Radarr that manages and downloads subtitles. - [Beszel](/docs/integrations/beszel.md): Beszel is a lightweight server monitoring platform with Docker stats, historical data, and alert functions. - [Coolify](/docs/integrations/coolify.md): Self-hosted PaaS and deployment platform - [Dash.](/docs/integrations/dash-dot.md): Dash. is a system performance and resource monitoring tool - [Deluge](/docs/integrations/deluge.md): Deluge is a lightweight, Free Software, cross-platform BitTorrent client. - [Docker](/docs/integrations/docker.md): Docker is a platform where you can run your applications in containers, allowing for easy deployment and management of applications. - [Emby](/docs/integrations/emby.md): Emby is a media server platform that allows you to organize, manage, and stream your personal media collection. - [Glances](/docs/integrations/glances.md): Glances is a cross-platform system monitoring tool. - [Gluetun](/docs/integrations/gluetun.md): Connect Gluetun to Homarr as a VPN integration. - [Gotify](/docs/integrations/gotify.md): Gotify is a simple, self-hosted server for sending and receiving messages in real time. - [Home Assistant](/docs/integrations/home-assistant.md): Home Assistant is an open-source home automation platform that focuses on privacy and local control, allowing you to automate and control your smart home devices. - [iCal](/docs/integrations/ical.md): iCal is a standard for calendar data exchange, allowing users to share and manage calendar events across different platforms. - [Immich](/docs/integrations/immich.md): Self-hosted photo and video management solution - [Jellyfin](/docs/integrations/jellyfin.md): Jellyfin is a free and open-source media server software that allows you to organize, manage, and share your media files. - [Jellyseerr](/docs/integrations/jellyseerr.md): Jellyseerr is a self-hosted media request management system that integrates with Jellyfin and other media servers. - [Kubernetes](/docs/integrations/kubernetes.md): Kubernetes is a powerful container orchestration platform that automates the deployment, scaling, and management of containerized applications. - [Lidarr](/docs/integrations/lidarr.md): Lidarr is a music management tool that automates the process of downloading, sorting, and renaming music. - [Navidrome](/docs/integrations/navidrome.md): Navidrome is a self-hosted music server and streamer compatible with the Subsonic API. - [Nextcloud](/docs/integrations/nextcloud.md): Nextcloud is a self-hosted productivity platform that provides file storage, collaboration tools, and more. - [Ntfy](/docs/integrations/ntfy.md): Ntfy is a simple, open-source notification service that allows you to send and receive notifications across devices. - [NZBGet](/docs/integrations/nzbget.md): NZBGet is a lightweight and efficient Usenet downloader. - [Open Media Vault](/docs/integrations/open-media-vault.md): Open Media Vault is a free network-attached storage server based on the Debian operating system. - [OPNsense](/docs/integrations/opnsense.md): OPNsense is an open-source, easy-to-use, and easy-to-build firewall and routing platform. - [Overseerr](/docs/integrations/overseerr.md): Overseerr is a self-hosted media request management system that integrates with Plex. - [Paperless-ngx](/docs/integrations/paperless-ngx.md): Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive. - [PatchMon](/docs/integrations/patchmon.md): PatchMon is a patch management and monitoring solution for Linux hosts. - [PeaNUT](/docs/integrations/peanut.md): A tiny dashboard for Network UPS Tools (NUT) servers. - [Pi-hole](/docs/integrations/pi-hole.md): Pi-hole is a network-wide ad blocker that acts as a DNS sinkhole, blocking unwanted content and improving your browsing experience. - [Plex](/docs/integrations/plex.md): Plex is a media server platform that allows you to organize, manage, and stream your personal media collection. - [Prowlarr](/docs/integrations/prowlarr.md): Prowlarr is an indexer manager for Usenet and BitTorrent, providing a unified interface to manage your indexers. - [Proxmox](/docs/integrations/proxmox.md): Proxmox is a powerful open-source virtualization platform that allows you to run virtual machines and containers. - [qBittorrent](/docs/integrations/q-bittorent.md): qBittorrent is a free and open-source BitTorrent client. - [Radarr](/docs/integrations/radarr.md): Radarr is a movie management tool that automates the process of downloading, sorting, and renaming movies. - [Readarr](/docs/integrations/readarr.md): Readarr is a book management tool that automates the process of downloading, sorting, and renaming books. - [SABnzbd](/docs/integrations/sabnzbd.md): SABnzbd is an Open Source Binary Newsreader. - [Seerr](/docs/integrations/seerr.md): Seerr is a self-hosted media request management system that integrates with various media servers. - [Slskd](/docs/integrations/slskd.md): A modern client-server application for the Soulseek file sharing network. - [Sonarr](/docs/integrations/sonarr.md): Sonarr is a TV series management tool that automates the process of downloading, sorting, and renaming episodes. - [Speedtest Tracker](/docs/integrations/speedtest-tracker.md): Speedtest Tracker is a self-hosted internet performance tracking application. - [Synology DiskStation](/docs/integrations/synology.md): Monitor CPU, memory, storage volumes, and system health from Synology DSM. - [Tdarr](/docs/integrations/tdarr.md): Tdarr is a distributed media transcoding system that allows you to process and optimize your media files across multiple nodes. - [Technitium DNS](/docs/integrations/technitium-dns.md): Technitium DNS Server is a self-hosted DNS server with ad-blocking and network-wide filtering capabilities. - [Tracearr](/docs/integrations/tracearr.md): Tracearr is a comprehensive media monitoring solution that tracks streams, user activity, and policy violations in your media server (including Plex, Jellyfin, Emby). - [Traefik](/docs/integrations/traefik.md): Cloud-native reverse proxy and load balancer - [Transmission](/docs/integrations/transmission.md): A Fast, Easy and Free Bittorrent Client. - [TrueNAS](/docs/integrations/truenas.md): Enterprise network-attached storage for your home, office, and cloud. - [Umami](/docs/integrations/umami.md): Privacy-focused, open-source web analytics - [Unifi Controller](/docs/integrations/unifi-controller.md): Unifi Controller is a network management platform for Unifi devices. - [Unraid](/docs/integrations/unraid.md): Versatile operating system that lets you run applications, virtual machines, and storage devices on your server - [Uptime Kuma](/docs/integrations/uptime-kuma.md): Uptime Kuma is a self-hosted monitoring tool that tracks the availability of your services and websites. - [API](/docs/management/api.md): Using the Homarr API, you can interface with the application with your own code and business logic. - [Apps](/docs/management/apps.md): Apps are the building blocks of your Homarr board. - [Backup & Restore](/docs/management/backup.md): Homarr provides a built-in backup and restore system for SQLite instances. You can export your entire database - including apps, integrations, boards, users, and encryption keys - as a ZIP archive, and restore it on the same or a different Homarr instance. - [Boards](/docs/management/boards.md): Each dashboard is called a "board". - [Certificates](/docs/management/certificates.md): On this page you can manage your trusted certificates. - [Custom Widgets](/docs/management/custom-widgets.md): Custom widgets are a new feature. Share feedback, ask questions, and discuss ideas in our GitHub Discussions. - [Integrations](/docs/management/integrations.md): Integrations are connections to supported third party applications. - [Model Context Protocol (MCP)](/docs/management/mcp.md): Homarr exposes a Model Context Protocol server at /api/mcp/mcp, enabling AI assistants like Claude, Cursor, VS Code Copilot, and Claude Code to interact with your Homarr instance using natural language. - [Media](/docs/management/media.md): Using the media feature, you can upload images for custom icons to Homarr. - [Search Engines](/docs/management/search-engines.md): Using the search engines, terms can be quickly searched simply by opening the search bar at the top or using the keyboard shortcut CTRL + K. - [Settings](/docs/management/settings.md): The settings page has a few options that will be applied to the entire Homarr application. - [Tasks](/docs/management/tasks.md): Homarr has background jobs for various tasks, most of them are for realtime widget updates. - [Users](/docs/management/users.md): Each person accessing Homarr is a user. Using the users management you can configure who has access to certain resources. - [Anchor Note](/docs/widgets/anchor-note.md): Display and edit a selected note from Anchor - [App](/docs/widgets/app.md): Embeds an app into the board. - [Audio Stats](/docs/widgets/audio-stats.md): Displays library statistics from Navidrome or Audiobookshelf, adapting its display based on the linked integration. - [Bazarr](/docs/widgets/bazarr.md): Displays missing subtitle counts and health indicators from your Bazarr instance. - [Beszel Alerts](/docs/widgets/beszel-alerts.md): View Beszel alert configurations and history with triggered/ok status indicators. - [Beszel Systems (Grid)](/docs/widgets/beszel-system-grid.md): Card grid view of all Beszel-monitored systems with real-time metrics. - [Beszel System Stats](/docs/widgets/beszel-system-stats.md): Time-series charts for CPU, memory, disk, network, and Docker container metrics from Beszel. - [Beszel Systems (Table)](/docs/widgets/beszel-system-table.md): Table view of all Beszel-monitored systems with sortable columns and status indicators. - [Bookmarks](/docs/widgets/bookmarks.md): Displays multiple app links - [Calendar](/docs/widgets/calendar.md): Display events from your integrations in a calendar view within a certain relative time period - [Date and time](/docs/widgets/clock.md): Displays the current date and time. - [Coolify](/docs/widgets/coolify.md): Overview of your Coolify instance with servers, applications, and services. - [Custom API](/docs/widgets/custom-api.md): Displays data from a custom API endpoint using configurable display types and optional JSX templates. - [DNS Hole Controls](/docs/widgets/dns-hole-controls.md): Control PiHole or AdGuard from your dashboard. - [DNS Hole Summary](/docs/widgets/dns-hole-summary.md): Displays the summary of your DNS Hole. - [Docker stats](/docs/widgets/docker-containers.md): Stats of your containers - [Download Client](/docs/widgets/downloads.md): Allows you to view and manage your Downloads from both Torrent and Usenet clients. - [Firewall Monitoring](/docs/widgets/firewall.md): Displays a summary of firewalls. - [System Health Monitoring](/docs/widgets/health-monitoring.md): Displays information showing the health and status of your system(s). - [iFrame](/docs/widgets/iframe.md): Embed any content from the internet. Some websites may restrict access. - [Immich Album](/docs/widgets/immich-album-carousel.md): Shows a slideshow of your album pictures from Immich - [Immich Server Stats](/docs/widgets/immich-server-stats.md): Information about your Immich instance - [Indexer manager status](/docs/widgets/indexer-manager.md): View the status of your indexers. - [Media Missing & Queue](/docs/widgets/media-missing.md): Track missing media and active downloads from Radarr and Sonarr - [Media releases](/docs/widgets/media-releases.md): Display newly added medias or upcoming releases from different integrations - [Media Request List](/docs/widgets/media-request-list.md): See a list of all media requests from your integration - [Media Requests Stats](/docs/widgets/media-request-stats.md): Statistics about your media requests - [Media server streams](/docs/widgets/media-server.md): Show the current streams on your media servers - [Media transcoding](/docs/widgets/media-transcoding.md): Statistics, current queue and worker status of your media transcoding - [Minecraft Server Status](/docs/widgets/minecraft-server-status.md): Displays the status of a Minecraft server. - [Network Status](/docs/widgets/network-controller-status.md): Display connected devices on a network - [Network Controller Summary](/docs/widgets/network-controller-summary.md): Displays the summary of a Network Controller - [Notebook](/docs/widgets/notebook.md): A simple notebook widget that supports markdown. - [Notifications](/docs/widgets/notifications.md): Display notification history from an integration - [Paperless-ngx](/docs/widgets/paperless-ngx.md): Displays document management statistics including inbox ratio, document counts, and metadata. - [PatchMon](/docs/widgets/patchmon.md): Displays host patch statistics from PatchMon including update and security counts. - [Releases](/docs/widgets/releases.md): Displays a list of the current version of the given repositories with the given version regex. - [RSS Feed](/docs/widgets/rss-feed.md): Monitor and display one or more generic RSS, ATOM or JSON feeds. - [Entity State](/docs/widgets/smart-home-entity-state.md): Display the state of an entity and toggle it optionally - [Execute Automation](/docs/widgets/smart-home-execute-automation.md): Trigger an automation with one click - [Speedtest Tracker](/docs/widgets/speedtest-tracker.md): Displays speed test results from your Speedtest Tracker instance. - [Stock Price](/docs/widgets/stock-price.md): Displays the current stock price of a company. - [System disks](/docs/widgets/system-disks.md): Disk usage of your system - [System Resources](/docs/widgets/system-resources.md): Displays CPU, RAM and network of your host in real time - [Timetable](/docs/widgets/timetable.md): Displays departure times for a station. - [Tracearr](/docs/widgets/tracearr.md): Monitor media server streams, user activity, and policy violations. - [Traefik](/docs/widgets/traefik.md): Displays Traefik router, service, middleware, and entry point counts. - [Umami Analytics](/docs/widgets/umami.md): Display visitor stats from your Umami analytics instance - [UPS](/docs/widgets/ups.md): Monitor the status of your UPS devices through a NUT server. - [Uptime Kuma](/docs/widgets/uptime-kuma.md): Displays monitor uptime statistics, average uptime percentage, and service status counts. - [Video Stream](/docs/widgets/video.md): Embed a video stream or video from a camera or a website. - [VPN](/docs/widgets/vpn.md): Monitor the status of your VPN integrations. - [Weather](/docs/widgets/weather.md): Displays the current weather information of a set location.