wrapperr/README.md

Plex Wrapped

Introduction

A website-based platform and API for collecting Plex user stats within a set timeframe using Tautulli. The data is displayed as a stat-summary, sort of like Spotify Wrapped. Yes, you need Tautulli to have been running beforehand and currently for this to work.

Features

• Custom timeframes
• Custom introduction
• Movies, shows & music
• Caching of results
• Friendly, dynamic display for statistics with nice illustrations
• Email and username search
• Admin page with authentication for settings
• Pre-caching of data

Credit

• Beautiful illustrations downloaded from FreeWebIllustrations
• Amazing statistics gathered using Tautulli
• Wonderful loading icon from icons8

Instructions

This is a web-based platform. Place it in a webserver like Apache or Nginx and make sure it processes PHP content.

Manual

There are multiple settings you must configure! They will be stored in config/config.json, but can be configured easily at your-domain-or-ip/admin through the interface.

PHP will have issues with this API based on the data available in Tautulli and your settings. If you have a large time frame for your wrapped period (like a full year), and there are a huge amount of Tautulli entries, you can have multiple issues. Pre-caching deals with a lot of these problems, so make sure you have it enabled, but configuring PHP might still be necessary. In your php.ini file you may have to change:

• max_execution_time=enough seconds for the script to finish. The longer the timeframe and the less info that is cached, the more execution time. Every unique date in your timeframe is a new Tautulli API call.
• memory_limit=enough M for the script to handle JSON data. If there is a lot of data, PHP needs to have enough memory to manage it without crashing. This still applies if caching is on, as PHP needs to be able to read the cache without crashing.
• max_input_time=enough seconds for the script to parse JSON data. You might not need to change this, depending on Tautulli connection speed.

You need to give PHP permission to read and write to files in the directory called config!

• The config directory contains sensitive information that must be accessed by the PHP scripts! There is an .htaccess file included that is effective with Apache, but if you are using Nginx you must add a directory deny in your Nginx configuration!
• The cache is stored in config/cache.json, but can be cleared using the admin menu previously mentioned.
• Your password is hashed and stored in the config/config.json.

If you visit your-domain-or-ip/caching you can do a pre-caching. This is very useful if you want to prepare for a lot of traffic and have a large timeframe with entries. I recommend setting up the platform at the admin page and then running a pre-cache immediately. The cache is updated automatically if new data in the timeframe is available.

Docker

Docker sets up the environment, but I recommend reading the manual section for info about PHP configuration and explanation of functionality!

Docker makes it easy, but you might want to change the setup. The pre-configured Dockerfile is in the docker folder of this repo. It's a really simple configuration, so modify it if you want and then build it. If you just want to launch the pre-built image of Plex-Wrapped, simply execute this docker command, pulling the image from Docker Hub and exposing it on port 80:

docker run -p '80:80' --name 'plex-wrapped' aunefyren/plex-wrapped:latest

It should now be accessable on: http://localhost

If you use Docker Compose you could do something like this in your docker-compose.yml:

version: '3.3'
services:
    plex-wrapped:
        ports:
            - '80:80'
        container_name: plex-wrapped
        image: 'aunefyren/plex-wrapped:latest'

And launch the file with

docker-compose up

Need help?

If you have any issues feel free to contact me. I am always trying to improve the project. If I can't, many people on several forums (including /r/plex) might be able to assist you.

Goodybye.