Skip to content

Latest commit

 

History

History
129 lines (109 loc) · 3.24 KB

README.md

File metadata and controls

129 lines (109 loc) · 3.24 KB
Raw

MediaHome

MediaHome is a self-hostable homepage for all your media services. MediaHome is not meant as a competitor to homelab dashboards like Homer or Homepage. Rather, it is meant to be accessed from a dedicated HTPC to provide a fast and simple way to access content.

screenshot

Features

  • Configurable with json
  • Keyboard shortcuts to launch into services

Deployment

Docker compose:

---
version: "3"
services:
  homer:
    image: noahhefner/mediahome:latest
    container_name: media-home
    volumes:
      - /path/to/your/config:/usr/share/nginx/html/config
    ports:
      - 8080:80
    user: 1000:1000

For config example directory, see /public/config. Expected config directory is:

config/
├── config.json
└── images
    ├── service-image-1.png
    └── service-image-2.jpg

Example config.json:

{
  "appearance": {
    "columns": 4,
    "hideKeybind": false,
    "colors": {
      "backgroundColor": "#161616",
      "textColor": "#a5a5a5",
      "borderColor": "#a5a5a5",
      "hoverColor": "#ffffff",
      "keybindColor": "#161616"
    }
  },
  "tiles": [
    {
      "service": "Netflix",
      "url": "https://www.netflix.com",
      "image": "netflix-logo.png",
      "keybind": "n",
      "target": "_blank",
      "keybindHidden": false
    },
    {
      "service": "Hulu",
      "url": "https://www.hulu.com",
      "image": "hulu-logo.jpg",
      "keybind": "h",
      "target": "_blank",
      "keybindHidden": false
    },
    {
      "service": "Disney",
      "url": "https://www.disneyplus.com",
      "image": "disney-logo.jpeg",
      "keybind": "d",
      "target": "_blank",
      "keybindHidden": false
    },
    {
      "service": "Youtube",
      "url": "https://www.youtube.com",
      "image": "youtube-logo.jpg",
      "keybind": "y",
      "target": "_blank",
      "keybindHidden": false
    },
    {
      "service": "Spotify",
      "url": "https://www.spotify.com",
      "image": "spotify-logo.jpg",
      "keybind": "s",
      "target": "_blank",
      "keybindHidden": false
    }
  ]
}

Service configuration options:

  • url: The URL to open when the tile is clicked / the hotkey is pressed.
  • image: The image to display for the service tile.
  • keybind: Hotkey that will instantly open the service.
  • target: Set where the page should be opened (new tab, current tab, etc.)
  • keybindHidden: Toggle visibility for the hotkey indicator for that service. Set to true to hide the hotkey indicator.

Roadmap

  • Dockerize the application with volume support for configuration files (done-ish, docker-compose is untested)
  • Additional customization options (colors, toggle keyboard shortcut visibility, etc.)

Development

Prerequisites:

  • node.js
  • npm
  • docker

Makefile commands:

Command Description
make dev Build and run through node. Available at localhost:5173
make build Build the Docker image.
make run Run the Docker image. Available at localhost:8080
make clean Delete dist directory and delete Docker image with latest tag
make publish Publish image to Docker Hub