Mirrors/wrapperr
2
0
Fork 0
mirror of https://github.com/aunefyren/wrapperr synced 2024-09-20 14:12:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
No description
32 commits 1 branch 28 tags 6.1 MiB
JavaScript 46.7%
Go 39.3%
HTML 9.5%
CSS 4.4%
Find a file
aunefyren 023158a619 Optional API logging 
All the different PHP APIs can now log successful activity to a log file in the config directory. The logging of Wrapped activity includes the ID of the user. Enabled/disabled in the admin menu.
2021-09-21 15:01:14 +02:00
.idea Cache reuse of server-wide stats, fixed footer, trimming string 2021-04-20 11:55:11 +02:00
api Optional API logging 2021-09-21 15:01:14 +02:00
assets CSS fix 2021-09-21 12:56:13 +02:00
config Re-adding config files 2021-05-16 22:00:40 +02:00
.gitattributes Initial commit 2020-12-19 17:04:43 +01:00
.htaccess Caching, admin page, username search, flexible results 2021-03-08 19:45:06 +01:00
admin.html Optional API logging 2021-09-21 15:01:14 +02:00
admin.js Optional API logging 2021-09-21 15:01:14 +02:00
caching.html Caching, admin page, username search, flexible results 2021-03-08 19:45:06 +01:00
caching.js Auto file-creation, trimming and lowercase-compare on inputs, better instructions and labels 2021-09-21 12:40:54 +02:00
CODE_OF_CONDUCT.md Added code of conduct 2021-03-10 00:50:23 +01:00
get_config.js Optional API logging 2021-09-21 15:01:14 +02:00
get_functions.js Caching, admin page, username search, flexible results 2021-03-08 19:45:06 +01:00
get_stats.js Changed category-titles and fixed typo in readme 2021-08-11 18:07:05 +02:00
index.html Caching of server-wide stats improved, fixed merging error 2021-08-11 17:34:25 +02:00
index.js Remove error when searching 2021-03-09 16:22:41 +01:00
README.md Optional API logging 2021-09-21 15:01:14 +02:00
set_config.js Optional API logging 2021-09-21 15:01:14 +02:00

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.

alt text

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 user-sets

alt text

Credit

alt text

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 your-domain-or-ip/admin.html.

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 read and write to files in the directory called config.

The cache is stored in config/cache.json, but can be cleared using the admin menu.

Your password is hashed and stored in the config.json.

If you visit your-domain-or-ip/caching.html 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.