Self-host homescreen-hero

services: homescreen-hero: image: trentferguson/homescreen-hero:latest container_name: homescreen-hero ports: - "${HSH_PORT:-8000}:8000" environment: HOMESCREEN_HERO_CONFIG: /data/config.yaml HOMESCREEN_HERO_DB: sqlite:////data/homescreen_hero.sqlite HOMESCREEN_HERO_LOG_DIR: /data/logs HSH_PLEX_URL: ${HSH_PLEX_URL:-} HSH_PLEX_TOKEN: ${HSH_PLEX_TOKEN} HSH_AUTH_PASSWORD: ${HSH_AUTH_PASSWORD:-} HSH_AUTH_SECRET_KEY: ${HSH_AUTH_SECRET_KEY:-} HSH_TRAKT_CLIENT_ID: ${HSH_TRAKT_CLIENT_ID:-} HSH_MDBLIST_API_KEY: ${HSH_MDBLIST_API_KEY:-} HSH_TMDB_API_KEY: ${HSH_TMDB_API_KEY:-} HSH_TAUTULLI_API_KEY: ${HSH_TAUTULLI_API_KEY:-} HSH_TAUTULLI_BASE_URL: ${HSH_TAUTULLI_BASE_URL:-} HSH_SEERR_API_KEY: ${HSH_SEERR_API_KEY:-} HSH_SEERR_BASE_URL: ${HSH_SEERR_BASE_URL:-} volumes: - ./data:/data restart: unless-stopped healthcheck: test: ["CMD", "curl", "-fsS", "http://localhost:8000/api/health"] interval: 30s timeout: 5s retries: 3

Clone the repository

git clone https://github.com/trentferguson/homescreen-hero.git cd homescreen-hero

Create virtual environment

python -m venv .venv source .venv/bin/activate # Linux/Mac

or

.venv\Scripts\activate # Windows

Install dependencies

pip install -r homescreen_hero/requirements.txt

Create data directory

mkdir -p data

Run the server

uvicorn homescreen_hero.web.app:app --host 0.0.0.0 --port 8000

Download the latest homescreen-hero-portable.zip from the latest release page Extract the homescreen-hero-portable.zip to any folder on your machine Open the README.txt file and follow the setup instructions for configuring the app