Wrapperr

Like the project? Have too much money? Buy me a coffee or something! ☕️

Introduction - What is this?

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

Features

• Custom timeframes for statistics
• Plex Auth for login
• Supports multiple Tautulli servers
• Friendly, dynamic presentation of statistics with nice illustrations
• Customizable text options
• Customizable appearance/results
• Statistics for movies, shows & music
• Caching of Tautulli results
• Admin interface for configuration
• Pre-caching of results before user interaction
• Shareable links with expiration

Credit

• Beautiful illustrations from FreeWebIllustrations
• Amazing statistics gathered using Tautulli
• Wonderful loading icon from icons8
• Splendid web icons from icons8
• Superb background image from Pexels

Explanation - How does it work?

This is a web-based platform. It gathers and displays statistics using an API (application programming interface) that interacts with the Tautulli API. Install Wrapperr, configure the essential options, and Wrapperr will do the rest. Based on your exact configuration, Wrapperr will gather unique statistics for each user interacting with the application.

In Wrapperr you configure a timeframe, from date-time A to date-time B. This is the timeframe from which the statistics are created. One could for instance have a wrap-up of multiple years of Tautulli data or just a week. If enabled, Wrapperr will verify the user with Plex to ensure personal data is kept private.

Most text is customizable through the Wrapperr admin interface which allows for regional translation. Certain statistics can be disabled and enabled based on relevance/interest. Users can if enabled, generate random URLs which can be shared between friends who want to see each other's statistics.

Instructions - How do I install this?

There are two main ways. Docker information can be found further below.

Download and start

There are multiple ways to install Wrapperr. The easiest is just to download the latest release from the Release Page which matches your operating system, move all the content to a directory, and start the wrapperr application located within the release. It should start right up, perhaps triggering some operating system or firewall warnings.

Build with Go

If you want to build Wrapperr yourself, you can download whatever version/tag/branch you want, and place the files in a directory. With Go installed, from the Wrapperr directory, run the following commands to build and execute Wrapperr:

$ go build
$ ./wrapperr

Note, if building on another operating system, the executable could have a different name. Such as wrapperr.exe on Windows.

Head to the website

If successful, Wrapperr should be accessible on http://localhost:8282. From there you can click on admin in the footer at the bottom, or go to /admin in the URL. From there you can configure everything about Wrapperr in the different sections of the menu.

Essential configuration options

A couple of configuration options are necessary for Wrapperr to function. First of all, Tautulli connection details. There is a test button available on the page to ensure you have entered the correct details. The second one is the time zone option on the Wrapperr Settings page.

It is recommended to keep Cache results for later use enabled on the Wrapperr Settings page, and head to the Caching page after configuration. Click the Cache button and wait for the caching to finish. This ensures a good, quick user experience.

Wrap away!

Wrapperr should now be functional. Based on your settings, you can now either search with username/e-mail or log in with Plex on the front page. Continue tweaking on the admin menu to get the appearance/language you desire.

Docker

Docker sets up the environment, but I recommend reading the start of the 'Essential configuration options' section for an explanation of the functionality/admin page!

Docker images are pre-built, but you might want to change the Dockerfile. The pre-configured Dockerfile is in the docker folder of this repo. It's a really simple configuration, so modify it as preferred and then build it. If you just want to launch the pre-built image of Wrapperr, simply execute this docker command, pulling the image from Docker Hub and exposing it on port 8282:

$ docker run -p '8282:8282' --name 'wrapperr' aunefyren/wrapperr:latest

It should now be accessible on: http://localhost:8282

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

version: '3.3'
services:
    wrapperr:
        ports:
            - '8282:8282'
        container_name: wrapperr
        image: aunefyren/wrapperr:latest
        restart: unless-stopped

And launch the file with:

$ docker-compose up

If you want to mount a volume for the config folder, you can do something like this:

version: '3.3'
services:
    wrapperr:
        ports:
            - '8282:8282'
        container_name: wrapperr
        image: aunefyren/wrapperr:latest
        restart: unless-stopped
        volumes:
            - './my-folder:/app/config'

Afterward, remember to chmod the mounted folder on the host so the Wrapperr can write to it:

$ sudo chmod -R 0777 ./my-folder

Frequently asked questions

Q: Why are the plays different on Wrapperr compared to Tautulli

A: Data is retrieved from the Tautulli API, but not necessarily processed in the same manner. The difference could for example be that you have history entries for the same media (a movie for example) split over different Tautulli items. For example, you could have two items for the movie 'Black Widow' from updating the file on Plex, leading Tautulli to interpret it as a new item/media. The easiest way to check for this is by going to the 'History' tab and searching for the title. This might display more entries than clicking into the movie item, which displays all history items for that particular item.

There is an option to merge different Tautulli items if this is your case.

What also could confuse is related to the Tautulli grouping feature. When you have grouping enabled, different plays are grouped on an API call basis. Meaning that when you display all history items for a movie on Tautulli, six different plays spanning three days might be placed into one group. Wrapperr calls the Tautulli API on 'day' based loop, meaning Tautulli's grouping never spans multiple days, potentially leading to an increase in plays because the groups are smaller in size.

Need help?

If you have any issues feel free to open an issue here on GitHub. 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.

Have fun.