Skip to content

netplexflix/Plex-Wrapped-for-Tautulli

Repository files navigation

Image
GitHub Release Docker Pulls Discord



A year-in-review wrapped report for your Plex server, powered by Tautulli data. Self hosted with Docker.
Beautiful, animated/dynamic statistics and fun facts. With exportable slides for social media sharing.


A few examples of what it looks like on mobile:

Prerequisites

  • Docker and Docker Compose installed
  • A running Tautulli instance

Quick Start

  1. Download the docker-compose.yml file from this repository
  2. Pull the latest image:
docker-compose pull
  1. Start the container:
docker-compose up -d

Configuration

Tautulli Connection

  1. Access the app at http://localhost:2025.
  2. Open the Admin Panel and set your Admin password
  3. Enter your Tautulli IP:PORT and API Key (Find this in Tautulli → Settings → Web Interface → API Key)

Optional Settings

  • Custom Logo: Upload your custom logo to be used in reports and export slides. You can adjust the size with the slider.
  • Custom Title: Use a custom title instead of "Plex Wrapped".
  • Discreet Mode: Replaces the user dropdown with a username input field. Users need to enter their exact username. (NOT 'Friendly name')
  • Allow 'All Users' in Discreet Mode: Will auto-load the "All Users" report when visiting the site.
  • Password Protect Users: Generates passwords for each user. (See UsersTab)
  • Normalize Tautulli Anomalies: Fixes duration anomalies found in Tautulli history by capping watch times to actual runtime.

Note

When not closed correctly, sessions in Tautulli can keep 'counting', resulting in sometimes days or weeks worth of 'watch history' for a single session. This option detects such anomalies and normalizes the session durations to the runtime of the item that was watched. To check if you have such anomalies you can check your history tab in Tautulli and sort by duration and look for unrealistically high values:

image
  • Streaming Locations: Will show a world map of where streaming sessions originated from.
  • Show Leaderboard: Will show a user leaderboard in the "All Users" web report.

Build a Cache

The app builds and uses a cache file for faster report generation.
On your first use, it's highly recommended to generate a report for All Users for All Time. Depending on your history, this can take quite some time. Once completed, subsequent reports will generate consciderably faster especially if you enabled Normalize Tautulli Anomalies.

Export Slides

In the Admin Panel you can export individual user reports.

  • Full Image exports one long report with all stats.
  • Story Slides exports nine 9:16 slides for social media reels.
  • You can select multiple users at a time.
  • Users will see an Export Slides button at the bottom of the web version of their wrapped report to quickly export their own slides.
Image

⚠️ Do you Need Help or have Feedback?


❤️ Support the Project

If you like this project, please ⭐ star the repository and share it with the community!


"Buy Me A Coffee"

About

Beautiful Plex Wrapped reports based on Tautulli data

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors