daerup / plex-rewind

Present Plex user statistics and habits in a beautiful and organized manner.

Plex Rewind

A Plex Rewind application inspired by the likes of Spotify Wrapped and Tautulli.

Present Plex user statistics and habits in a beautiful and organized manner - as a web application application powered by Next.js and Tailwind.css, using data from Tautulli, Overseerr and Plex. You can also disable the Rewind functionality and just use it as an easily sharable Dashboard for your Plex users or vice versa!

Features

• 📱 Fully responsive - viewable, usable & enjoyable on desktop, tablet or mobile, courtesy of Tailwind.css.
• 🔄 Fully dynamic - the data your're viewing will always be the latest available.
• 📆 Rewind - allows your Plex users view their statistics and habits for a given year.
• 👀 Dashboard - provides an easily glanceable overview of activity on your server for all your libraries.
• ✨ Beautiful animations with Framer Motion.
• 📊 Fuelled by data from Tautulli - the backbone responsible for the heavy lifting regarding stats.
• 🔗 Integrates with Overseerr - show request breakdowns and totals.
• 🔐 Log in with Plex - uses NextAuth.js to enable secure login and session management with your Plex account.
• 🚀 PWA support - installable on mobile devices and desktops thanks to Serwist.
• 🐳 Easy deployment - run the application in a containerized environment with Docker.
• ⭐ All of this and more - powered by Next.js.

Keep an eye on the issues page to see what new features have already been requested or to make your own request!

Preview

Getting started

1. Create a docker-compose.yml in your location of choice and run docker compose up -d. The app will be available at http://localhost:8383.

services:
  plex-rewind:
    image: ghcr.io/raunot/plex-rewind:latest # :develop for the latest development version
    container_name: plex-rewind
    # user: 1000:1000 # change to your user and group id if you are running into permissions issues
    environment:
      - NEXTAUTH_SECRET= # (required) used to encrypt auth JWT token, generate one with `openssl rand -base64 32`
      - NEXTAUTH_URL=http://localhost:8383 # (required) change to your domain if you are exposing the app to the internet
      - NEXT_PUBLIC_SITE_URL=http://localhost:8383 # (required) change to your domain if you are exposing the app to the internet
      - NEXT_PUBLIC_STATISTICS_START_DATE=2018-01-01 # (optional) starting date for "all time" option (YYYY-MM-DD)
    volumes:
      - ./config:/app/config
    ports:
      - 8383:8383
    restart: unless-stopped

NOTE: If you run into authentication issues, try setting NEXTAUTH_URL and NEXT_PUBLIC_SITE_URL to your external Docker IP, instead of localhost. For example http://192.168.1.1:8383.

Unraid

Plex Rewind is available in the Community Apps store for Unraid. Search for "Plex Rewind" and install it from grtgbln's repository.

As noted in the installation instructions, you will need to download a copy of settings.json into the associated settings path before running the application. To download the file, you can open a terminal, enter the directory and run the following command:

curl -o settings.json https://raw.githubusercontent.com/RaunoT/plex-rewind/main/config/settings.example.json

Updating

To update, run docker compose pull and then docker compose up -d.

Donate

If you like this project and wish to support it, you can do so by donating via Patreon or PayPal. Thank you! ❤️

Please note that supporting does not guarantee any support or future developments.

Learn More

To learn more about some of the tools used in this project, take a look at the following resources:

• Tautulli API reference
• Overseerr API reference
• Next.js docs
• NextAuth.js docs