Quick Start

1. Installation

   • Docker: docker-compose up -d (using provided docker-compose.yml)
   • Manual: Clone repo and follow Manual Installation guide

2. Required API Keys

   • Get TMDB API Token from TMDB (Free)
   • Get Fanart API Key from Fanart.tv (Free)
   • Get TVDB Project API Key from TVDB (Free)
   • For more information on API keys and required software/plugins, review the requirements section.

3. Basic Configuration

   • Copy config.example.json to config.json -> Configuration
   • Add your API keys
   • Set your media server details (Plex/Jellyfin/Emby)
   • Configure asset paths

4. First Run

   # Docker
   docker exec -it posterizarr pwsh /app/Posterizarr.ps1 -Testing
   
   # Windows (as Admin) & Linux
   ./Posterizarr.ps1 -Testing
   

5. Access Web UI

   • Open http://localhost:8000 in your browser
   • Default credentials: none required
   • Troubleshooting: Cannot access the Web UI from another device? See the Networking section.

For detailed setup instructions, see the full walkthrough.