Homarr
A homepage for your server.
Demo
Join the discord!
📃
Table of Contents
🚀
Getting Started
ℹ️
About
Homarr is a simple and lightweight homepage for your server, that helps you easily access all of your services in one place.
💥
Known Issues
- Posters on the Calendar get blocked by adblockers. (IMDb posters)
- Editing a service creates a duplicate (#97)
- Used search engine not properly selected (#35)
⚡
Installation
🐳
Deploying from Docker Image
Supported architectures: x86-64, ARM, ARM64
Requirements:
Standard Docker Install
docker run --name homarr -p 7575:7575 -v /data/docker/homarr:/app/data/configs -d ghcr.io/ajnart/homarr:latest
Docker Compose
---
version: '3'
#--------------------------------------------------------------------------------------------#
# Homarr - A homepage for your server. #
#--------------------------------------------------------------------------------------------#
services:
homarr:
container_name: homarr
image: ghcr.io/ajnart/homarr:latest
restart: unless-stopped
volumes:
- /data/docker/homarr:/app/data/configs
ports:
- '7575:7575'
Getting EACCESS errors in the logs? Try running sudo chmod 775 /directory-you-mounted-to!
🛠️
Building from Source
Requirements:
Installing
- Clone the GitHub repo:
git clone https://github.com/ajnart/homarr.git&cd homarr - Install all dependencies:
yarn install - Build the source:
yarn build - Start the NextJS web server:
yarn start - Note: If you want to update the code in real time, launch with
yarn dev
🔧
Configuration
🧩
Integrations
Homarr natively integrates with your services. Here is a list of all supported services.
Emby The Emby integration is still in development.
Lidarr The Lidarr integration is still in development.
Sonarr Sonarr needs an API key.
Make a new API key in Advanced > Security > Create new API key
Current integration: Upcoming media is displayed in the Calendar module.
Plex The Plex integration is still in development.
Radarr Radarr needs an API key.
Make a new API key in Advanced > Security > Create new API key
Current integration: Upcoming media is displayed in the Calendar module.
qBittorent The qBittorent integration is still in development.
🧑🤝🧑
Multiple Configs
Homarr allows the usage of multiple configs. You can add a new config in two ways.
Drag-and-Drop
- Download your config from the Homarr settings.
- Change the name of the
.jsonfile and the name in the.jsonfile to any name you want (just make sure it's different). - Drag-and-Drop the file into the Homarr tab in your browser.
- Change the config in settings.
Using a filebrowser
- Locate your mounted
default.jsonfile. - Duplicate your
default.jsonfile. - Change the name of the
.jsonfile and the name in the.jsonfile to any name you want (just make sure it's different). - Refresh the Homarr tab in your browser.
- Change the config in settings.
🐻
Icons
The icons used in Homarr are automatically requested from the dashboard-icons repo.
Icons are requested in the following way:
Grab name > Replace ' ' with '-' > .toLower() > https://cdn.jsdelivr.net/gh/walkxhub/dashboard-icons/png/{name}.png
📊
Modules
Modules are blocks shown on the sides of the Homarr dashboard that display information. They can be enabled in settings.
Clock Module The clock module will display your current time and date.
Calendar Module The Calendar module uses integrations to display new content.
🔍
Search Bar
The Search Bar will open any Search Query after the Query URL you've specified in settings.
(Eg. https://www.google.com/search?q=*Your Query will be inserted here*)
💖
Contributing
Please read our Contribution Guidelines
All contributions are highly appreciated.
