[WIP] Manage home server with Homarr dashboard

Introduction to Homarr

Having a home server could bring a lot of joys, but having a dashboard that shows all running services with live updates about the system make it lively.

And if you're not using any dashboards, Homarr is a very good choice to start with. With an intuitive interface, it centralizes control over various server components, making it easier to monitor system health, manage Docker containers, handle backups, and integrate with other applications. Whether you are a beginner or an experienced user, Homarr offers a streamlined way to keep your home server running smoothly.

Why Homarr?

Homarr offers a range of features that make managing your home server more efficient:

• Drag and drop system: helps you move parts of our dashboard easily
• Customizable Dashboard: Tailor the dashboard to your needs with customizable widgets and layouts.
• Docker Management: Easily start, stop, and monitor Docker containers.
• Service Management: Manage and monitor services running on your server.
• User Management: Create and manage user accounts with different access levels.
• Backup Management: Automate and manage backups for your data.
• Integrations: Seamlessly integrate with various applications and services like Plex, Nextcloud, Home Assistant, and more.

Installing Homarr with Docker Compose

In this guideline, I use Portainer to install Homarr with Docker Compose, but you can run it directly with Docker Compose CLI.

Prerequisites

• A home server running Docker.
• Portainer installed on your server

Step-by-Step Installation

1. Open Portainer:
   • Access your Portainer instance via a web browser.
2. Create a stack:

• Navigate to the "Stacks" section and click on "Add stack."
• Use the docker-compose.yml below to install Homarr
  • Optional: map the container port to a host port
  • Optional: configure configs, icons and data volumes

version: '3'
#---------------------------------------------------------------------#
#     Homarr - A simple, yet powerful dashboard for your server.      #
#---------------------------------------------------------------------#
services:
  homarr:
    container_name: homarr
    image: ghcr.io/ajnart/homarr:latest
    restart: unless-stopped
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock # Optional, only if you want docker integration
      - ./homarr/configs:/app/data/configs
      - ./homarr/icons:/app/public/icons
      - ./homarr/data:/data
    ports:
      - '7575:7575'

3. Test the service

After the container starts, access Homarr via http://your-server-ip:7575

Integrations in Homarr

Homarr supports various integrations that enhance its functionality. Here are some common integrations and how to set up one:

Supported Integrations

• Plex
• Nextcloud
• Home Assistant
• Jellyfin
• Radarr
• Sonarr
• NZBGet
• qBittorrent

Setting Up an Integration: Example with Plex

• Get Plex API
  • Follow this article to get X-Plex-Token: https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/
• Add Plex service to Homarr dashboard
  • Enter Edit Mode
• Add a tile (Apps)
• Set up integration
  • Edit the tile
  • Open the integration tab and select Plex for the Integration configuration
  • Paste the X-Plex-Token above to the API key field
• Add Plex Widget
• Test the integration
• Optional: update network HTTP status for the ping feature

Conclusion

Homarr is a versatile tool that makes managing a home server easier and more efficient. With its powerful features and integrations, you can keep your server running smoothly and access all necessary information from a single, customizable dashboard. Installing Homarr using Portainer is a breeze, and setting up integrations like Plex takes just a few minutes. Start using Homarr today to streamline your home server management!