.idea | ||
api | ||
assets | ||
config | ||
.gitattributes | ||
.htaccess | ||
admin.html | ||
admin.js | ||
caching.html | ||
caching.js | ||
CODE_OF_CONDUCT.md | ||
get_config.js | ||
get_functions.js | ||
get_stats.js | ||
index.html | ||
index.js | ||
README.md | ||
set_config.js |
Plex Wrapped
Introduction
A website-based platform and API for collecting Plex user stats within a set timeframe using Tautulli. The data is displayed 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
- Caching of results
- Friendly, dynamic display for statistics with nice illustrations
- Email and username search
- Admin page with authentication for settings
- Pre-caching of results
Credit
- Beautiful illustrations downloaded from https://freewebillustrations.com/
- Amazing statistics gathered using Tautulli
Instructions
This is a web-based platform. Place it in a webserver like Apache or Nginx and make sure it processes PHP content.
There are multiple settings you must configure! They will be stored in config/config.json, but can be configured easily at you-domain-or-ip.com/admin.
PHP will have issues with this API based on the results you want. If you have a large time frame for your wrapped period and there is a huge amount of Tautulli entries you can have multiple issues. In your php.ini file you may have to change:
- max_execution_time=enough seconds for the script to finish
- memory_limit=enough M for the script to handle JSON data
- max_input_time=enough seconds for the script to parse JSON data
You need to give PHP permission to edit files in the directory called config
The cache is stored at config/cache.json, but can be cleared using the admin menu.
If you visit you-domain-or-ip.com/caching you can do a pre-caching of a set of users. This is very useful if you want to prepare for a lot of traffic.
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.