362 lines
15 KiB
Markdown
362 lines
15 KiB
Markdown

|
|
|
|
<!-- Badges -->
|
|
<p align="center">
|
|
<img src="https://img.shields.io/github/stars/homarr-labs/homarr?label=%E2%AD%90%20Stars&style=flat-square?branch=master&kill_cache=1%22">
|
|
<a href="https://github.com/homarr-labs/homarr/releases/latest">
|
|
<img alt="Latest Release (Semver)" src="https://img.shields.io/github/v/release/homarr-labs/homarr?label=%F0%9F%9A%80%20Release">
|
|
</a>
|
|
<a href="https://github.com/homarr-labs/homarr/actions/workflows/deployment-docker-image.yml">
|
|
<img title="Docker CI Status" src="https://github.com/homarr-labs/homarr/actions/workflows/deployment-docker-image.yml/badge.svg" alt="CI Status">
|
|
</a>
|
|
<a href="https://crowdin.com/project/homarr_labs">
|
|
<img title="Translations" src="https://badges.crowdin.net/homarr_labs/localized.svg" />
|
|
</a>
|
|
<a href="https://discord.gg/aCsmEV5RgA">
|
|
<img title="Discord" src="https://discordapp.com/api/guilds/972958686051962910/widget.png?style=shield">
|
|
</a>
|
|
</p>
|
|
|
|
<!-- Links -->
|
|
<p align="center">
|
|
<a href="https://homarr.dev/docs/category/installation-1/">
|
|
<strong>Install 💻</strong>
|
|
</a> •
|
|
<a href="https://crowdin.com/project/homarr_labs">
|
|
<strong>Translations 🈺</strong>
|
|
</a> •
|
|
<a href="https://discord.com/invite/aCsmEV5RgA">
|
|
<strong>Discord 👋</strong>
|
|
</a>
|
|
</p>
|
|
|
|

|
|
|
|

|
|
|
|
- 🖌️ Highly customizable with an extensive drag and drop grid system
|
|
- ✨ Integrates seamlessly with your favorite self-hosted applications
|
|
- 📌 Easy and fast app management - no YAML involved
|
|
- 👤 Detailed and easy to use user management with permissions and groups
|
|
- 👥 Support for single sign on via OIDC / LDAP
|
|
- 🙊 Safe encryption using BCrypt and AES-256-CBC for your valuable data
|
|
- 🕔 Realtime widget updates using WebSockets, tRPC and Redis
|
|
- 🔍 Search through thousands of data points in supported integrations or your data in Homarr using the fast built-in search
|
|
- 🦞 Icon picker with over 11K icons
|
|
- 🚀 Compatible with any major consumer hardware (x86, Raspberry Pi, old laptops, ...) and most OS (Windows, Linux, TrueNAS, Unraid)
|
|
- 🖥️ Extensive Kubernetes support with Helm for efficient scaling & high reliability
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|

|
|
|
|
<!-- AUTO_GENERATE_INTEGRATION_LIST_START -->
|
|
|
|
<div align="center">
|
|
<table>
|
|
<tbody>
|
|
<tr><td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/adguard-home" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/adguard-home.svg" alt="AdGuard Home" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">AdGuard<br/>Home</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/aria2" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/PapirusDevelopmentTeam/papirus_icons@latest/src/system_downloads_3.svg" alt="Aria2" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Aria2</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/codeberg" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/codeberg.svg" alt="Codeberg" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Codeberg</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/dash-dot" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/dashdot.png" alt="Dash." width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Dash.</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/deluge" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/deluge.svg" alt="Deluge" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Deluge</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/docker-hub" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/docker.svg" alt="Docker Hub" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Docker<br/>Hub</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/emby" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/emby.svg" alt="Emby" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Emby</p>
|
|
</a>
|
|
</td></tr>
|
|
<tr><td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/github" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/github.svg" alt="Github" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Github</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/github" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/github.svg" alt="GitHub Container Registry" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">GitHub<br/>Container<br/>Registry</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/gitlab" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/gitlab.svg" alt="Gitlab" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Gitlab</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/home-assistant" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/home-assistant.svg" alt="Home Assistant" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Home<br/>Assistant</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/ical" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/ical.svg" alt="iCal" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">iCal</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/jellyfin" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/jellyfin.svg" alt="Jellyfin" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Jellyfin</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/jellyseerr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/jellyseerr.svg" alt="Jellyseerr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Jellyseerr</p>
|
|
</a>
|
|
</td></tr>
|
|
<tr><td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/lidarr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/lidarr.svg" alt="Lidarr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Lidarr</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/linux-server-io" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/linuxserver-io.svg" alt="LinuxServer.io" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">LinuxServer.io</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/nextcloud" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/nextcloud.svg" alt="Nextcloud" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Nextcloud</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/npm" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/npm.svg" alt="NPM" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">NPM</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/ntfy" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/ntfy.svg" alt="ntfy" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">ntfy</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/nzbget" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/nzbget.svg" alt="NZBGet" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">NZBGet</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/open-media-vault" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/openmediavault.svg" alt="OpenMediaVault" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">OpenMediaVault</p>
|
|
</a>
|
|
</td></tr>
|
|
<tr><td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/opnsense" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/opnsense.svg" alt="OPNsense" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">OPNsense</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/overseerr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/overseerr.svg" alt="Overseerr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Overseerr</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/pi-hole" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/pi-hole.svg" alt="Pi-hole" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Pi-hole</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/plex" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/plex.svg" alt="Plex" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Plex</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/prowlarr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/prowlarr.svg" alt="Prowlarr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Prowlarr</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/proxmox" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/proxmox.svg" alt="Proxmox" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Proxmox</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/q-bittorent" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/qbittorrent.svg" alt="qBittorrent" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">qBittorrent</p>
|
|
</a>
|
|
</td></tr>
|
|
<tr><td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/quay" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/quay.png" alt="Quay" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Quay</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/radarr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/radarr.svg" alt="Radarr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Radarr</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/readarr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/readarr.svg" alt="Readarr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Readarr</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/sabnzbd" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/sabnzbd.svg" alt="SABnzbd" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">SABnzbd</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/sonarr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/sonarr.svg" alt="Sonarr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Sonarr</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/tdarr" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/tdarr.png" alt="Tdarr" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Tdarr</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/transmission" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/transmission.svg" alt="Transmission" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Transmission</p>
|
|
</a>
|
|
</td></tr>
|
|
<tr><td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/truenas" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/svg/truenas.svg" alt="TrueNAS" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">TrueNAS</p>
|
|
</a>
|
|
</td>
|
|
<td align="center">
|
|
<a href="https://homarr.dev/docs/integrations/unifi-controller" target="_blank" rel="noreferrer noopener">
|
|
<img src="https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons@master/png/unifi.png" alt="Unifi Controller" width="90" height="90" />
|
|
<br/>
|
|
<p align="center">Unifi<br/>Controller</p>
|
|
</a>
|
|
</td></tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<!-- AUTO_GENERATE_INTEGRATION_LIST_END -->
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|

|
|
|
|
<h2>
|
|
<a href="https://homarr.dev/docs/category/installation-1/">
|
|
Please click here for official installation instructions
|
|
</a>
|
|
</h2>
|
|
|
|
<br/>
|
|
<br/>
|
|
|
|

|
|
|
|
<br/>
|
|
|
|
Homarr is a free-to-use open source project maintained by volunteers and developers from all over the world.
|
|
We publish under the `Apache License 2.0` license which allows commercial usage.
|
|
We invest multiple hours daily in providing support, developing Homarr, integrating to third party software and more.
|
|
We also pay for licensing and server hosting fees.
|
|
Please consider helping us cover these costs to enable the future development of Homarr. Thank you!
|
|
|
|
<h2>
|
|
<a href="https://opencollective.com/homarr">
|
|
Please click here to sponsor us at OpenCollective
|
|
</a>
|
|
</h2>
|
|
|
|
You can also support us by helping with [translating the entire project](https://homarr.dev/docs/community/translations) to as many languages as possible or contributing directly to the code or documentation. Please read our [Contribution Guidelines](/CONTRIBUTING.md). All contributions, regardless of their size or scope, are welcome and highly appreciated! Thank you ❤️
|
|
|
|
## Sponsors
|
|
|
|
Thanks to your generous sponsors, we can continue to build Homarr. Check them out for high-quality and easy-to-use development tools.
|
|
Feel free to contact us at homarr-labs@proton.me if you wish to become a sponsor.
|
|
|
|
[](https://argos-ci.com?utm_source=%5Bhomarr%5D&utm_campaign=oss) \
|
|
[](https://www.pikapods.com/pods?run=homarr-v1)
|