A modern (fully static, fast), secure (fully proxied), highly customizable application dashboard with integrations for more than 25 services and s for 15 languages. Easily configured via YAML files (or discovery via docker labels).

Linkedin - phelpsben

Docker Weblate

## Features - **Fast!** The entire site is statically generated at build time, so you can expect instant load times - **Secure!** Every API request to backend services goes through a proxy server, so your API keys are never exposed to the frontend client. - Images built for AMD64 (x86_64), ARM64, ARMv7 and ARMv6 - Supports all Raspberry Pi's, most SBCs & Apple Silicon - Full i18n support with automatic language detection - s for Chinese, Dutch, French, German, Hebrew, Hungarian, Norwegian Bokmål, Polish, Portuguese, Portuguese (Brazil), Romainian, Russian, Spanish, Swedish and Yue - Want to help translate? [Join the Weblate project](https://hosted.weblate.org/engage/homepage/) - Service & Web Bookmarks - Docker Integration - Container status (Running / Stopped) & statistics (CPU, Memory, Network) - Automatic service discovery (via labels) - Service Integration - Sonarr, Radarr, Readarr, Prowlarr, Bazarr, Lidarr, Emby, Jellyfin, Tautulli (Plex) - Ombi, Overseerr, Jellyseerr, Jackett, NZBGet, SABnzbd, ruTorrent, Transmission, qBittorrent - Portainer, Traefik, Speedtest Tracker, PiHole, AdGuard Home, Nginx Proxy Manager, Gotify, Syncthing Relay Server, Authentic - Information Providers - Coin Market Cap, Mastodon - Information & Utility Widgets - System Stats (Disk, CPU, Memory) - Weather via WeatherAPI.com or OpenWeatherMap - Search Bar - Customizable - 21 theme colors with light and dark mode support - Background image support - Column and Row layout options ## Support & Suggestions If you have any questions, suggestions, or general issues, please start a discussion on the [Discussions](https://github.com/benphelps/homepage/discussions) page. If you have a more specific issue, please open an issue on the [Issues](https://github.com/benphelps/homepage/issues) page. ## Getting Started For configuration options, examples and more, [please check out the Wiki](https://github.com/benphelps/homepage/wiki). ### With Docker Using docker compose: ```yaml version: "3.3" services: homepage: image: ghcr.io/benphelps/homepage:latest container_name: homepage ports: - 3000:3000 volumes: - /path/to/config:/app/config # Make sure your local config directory exists - /var/run/docker.sock:/var/run/docker.sock # (optional) For docker integrations ``` or docker run: ```bash docker run -p 3000:3000 -v /path/to/config:/app/config -v /var/run/docker.sock:/var/run/docker.sock ghcr.io/benphelps/homepage:latest ``` ### With Node First, clone the repository: ```bash git clone https://github.com/benphelps/homepage.git ``` Then install dependencies and build the production bundle (I'm using pnpm here, you can use npm or yarn if you like): ```bash pnpm install pnpm build ``` If this is your first time starting, copy the `src/skeleton` directory to `config/` to populate initial example config files. Finally, run the server: ```bash pnpm start ``` ## Configuration Configuration files will be genereted and placed on the first request. Configuration is done in the /config directory using .yaml files. Refer to each config for the specific configuration options. You may also check [the wiki](https://github.com/benphelps/homepage/wiki) for detailed configuration instructions, examples and more. ## Development Install NPM packages, this project uses [pnpm](https://pnpm.io/) (and so should you!): ```bash pnpm install ``` Start the development server: ```bash pnpm dev ``` Open [http://localhost:3000](http://localhost:3000) to start. This is a [Next.js](https://nextjs.org/) application, see their doucmentation for more information: ## Contributors Huge thanks to the all the contributors who have helped make this project what it is today! In alphabetical order: - [aidenpwnz](https://github.com/benphelps/homepage/commits?author=aidenpwnz) - Nginx Proxy Manager, Search Bar Widget - [AlexFullmoon](https://github.com/benphelps/homepage/commits?author=AlexFullmoon) - OpenWeatherMap Widget - [andrii-kryvoviaz](https://github.com/benphelps/homepage/commits?author=andrii-kryvoviaz) - Background opacity option - [DevPGSV](https://github.com/benphelps/homepage/commits?author=DevPGSV) - Syncthing Relay Server & Mastodon widgets - [ilusi0n](https://github.com/benphelps/homepage/commits?author=ilusi0n) - Jellyseerr Integration - [ItsJustMeChris](https://github.com/benphelps/homepage/commits?author=ItsJustMeChris) - Coin Market Cap Widget - [JazzFisch](https://github.com/benphelps/homepage/commits?author=JazzFisch) - Readarr, Bazarr, Lidarr, SABnzbd, Transmission, qBittorrent Integrations & countless more improvements - [josways](https://github.com/benphelps/homepage/commits?author=josways) - Baidu search provider - [mauricio-kalil](https://github.com/benphelps/homepage/commits?author=mauricio-kalil) - Portuguese (Brazil) - [modem7](https://github.com/benphelps/homepage/commits?author=modem7) - Impvoed Docker Image - [quod](https://github.com/benphelps/homepage/commits?author=quod) - Fixed Typos - [schklom](https://github.com/benphelps/homepage/commits?author=schklom) - ARM64, ARMv7 and ARMv6 - [xicopitz](https://github.com/benphelps/homepage/commits?author=xicopitz) - Gotify & Prowlarr Integration ### Translators - [3vilson](https://github.com/benphelps/homepage/commits?author=3vilson) - German - [4lenz1](https://github.com/benphelps/homepage/commits?author=4lenz1) - Chinese - [AmadeusGraves](https://github.com/benphelps/homepage/commits?author=AmadeusGraves) - Spanish - [boerniee](https://github.com/benphelps/homepage/commits?author=boerniee) - German - [brunoccr](https://github.com/benphelps/homepage/commits?author=brunoccr) - Portuguese (Brazil) - [C8opmBM](https://github.com/benphelps/homepage/commits?author=C8opmBM) - Romainian - [comradekingu](https://github.com/benphelps/homepage/commits?author=comradekingu) - Norwegian Bokmål - Daniel Varga - German & Hungarian - [deffcolony](https://github.com/benphelps/homepage/commits?author=deffcolony) - Dutch - [desolaris](https://github.com/benphelps/homepage/commits?author=desolaris) - Russian - [ericlokz](https://github.com/benphelps/homepage/commits?author=ericlokz) - Yue - [FunsKiTo](https://github.com/benphelps/homepage/commits?author=FunsKiTo) - Spanish - [jackblk](https://github.com/benphelps/homepage/commits?author=jackblk) - Vietnamese - [juanmanuelbc](https://github.com/benphelps/homepage/commits?author=juanmanuelbc) - Spanish and Catalan - [ling0412](https://github.com/benphelps/homepage/commits?author=ling0412) - Chinese - [milotype](https://github.com/benphelps/homepage/commits?author=milotype) - Croatian - [nicedc](https://github.com/benphelps/homepage/commits?author=nicedc) - Chinese - [Nonoss117](https://github.com/benphelps/homepage/commits?author=Nonoss117) - French - [pacoculebras](https://github.com/benphelps/homepage/commits?author=pacoculebras) - Catalan - [Prilann](https://github.com/benphelps/homepage/commits?author=Prilann) - German - [psychodracon](https://github.com/benphelps/homepage/commits?author=psychodracon) - Polish - Sascha Jelinek - German - [ShlomiPorush](https://github.com/benphelps/homepage/commits?author=ShlomiPorush) - Hebrew - [SuperDOS](https://github.com/benphelps/homepage/commits?author=SuperDOS) - Swedish