Skip to main content

Quick Start

Get homescreen-hero up and running in minutes.

Prerequisites​

Setup​

Security Tip

Want to keep secrets out of config files? Copy .env.example to .env and fill in your sensitive values before running the wizard. The wizard will automatically use your environment variables instead of writing them to config.yaml.

git clone https://github.com/trentferguson/homescreen-hero.git
cd homescreen-hero
mkdir -p data
docker-compose up -d
Open http://localhost:8000 and the Setup Wizard will guide you through configuration.

Open http://localhost:8000 and the Setup Wizard will guide you through configuration.

note

All info entered into the Setup Wizard (except for passwords) is stored as plaintext in config.yaml. See the Environment Variables page for best practices on managing sensitive values.

What's Next?​

Once the Setup Wizard is complete, you'll land on the dashboard. From there you can:

  • Set up rotation groups to start rotating collections on your homescreen
  • Connect integrations like Trakt, MDBList, or Letterboxd to sync external lists
  • Add widgets from Tautulli, Seerr, and more to customize your dashboard
  • Explore tools like the Date Added Editor and Watch History Cleaner

For more detailed setup options, check out the Installation Guide or the Docker Setup page.