About this project

Heimdall is an application dashboard and launcher developed by LinuxServer.io. Its purpose is to provide a single page for all web applications and links, so users can organize self-hosted services and websites without relying on browser bookmarks. It can be used as a browser start page and optionally includes a search bar with Google, Bing, or DuckDuckGo. The dashboard lets users add links to any site or application. Supported applications are recognized by title, and Foundation apps automatically provide an icon and default tile color. Enhanced apps can use an application API to display live statistics directly on the dashboard, such as queue size and download speed for NZBGet and SABnzbd. Heimdall is built on Laravel 11 and requires PHP 8.4 or newer with common PHP extensions, plus SQLite and zip support. Installation can be done by cloning the repository or extracting an archive and pointing the web server document root to the public folder, then creating an .env file and generating an application key. A multi-architecture Docker image is available for x86-64, armhf, and arm64. The project includes configuration guidance for Apache, Nginx, and reverse proxies, including LinuxServer.io's SWAG image. It supports custom background images, with notes about PHP upload limits and fileinfo. Search providers are stored in a YAML file and can be customized, including a Tiles option for searching dashboard apps by name. Heimdall has been translated into several languages, including Chinese, Japanese, Korean, Spanish, French, German, Portuguese, Russian, and others. Translations live in resources/lang and contributions are accepted through pull requests. For security, Heimdall blocks requests to private or reserved IP addresses by default to mitigate SSRF risks. An ALLOW_INTERNAL_REQUESTS environment variable can enable internal requests. The project also documents how to run offline by hosting or downloading the apps list and setting APP_SOURCE. The application is open-source under the MIT license. Credits include Laravel, FontAwesome 5, jQuery, Huebee, Pexels, and Trianglify. Support is offered through Discord and GitHub issues.