Mirrors/wrapperr
2
0
Fork 0
mirror of https://github.com/aunefyren/wrapperr synced 2024-12-14 05:12:27 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge branch 'main' of https://github.com/aunefyren/Plex-Wrapped-2020 into main

Browse source
This commit is contained in:
aunefyren 2020-12-22 17:34:08 +01:00
commit 2510f49477
1 changed files with 18 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
README.md
View file

@ -1,49 +1,29 @@
# Plex Wrapped
A website and API for collecting Plex user stats within a set timeframe using Tautulli.
# Plex Wrapped 2020
A website for collecting Plex user stats from 2020 using Tautulli.
## Warning
I made this for fun and I am currently working on perfecting it. All feedback and tips are welcome.
## Warning!
I made this for fun, in a very limited timeframe. This was not intended to be a public tool. It might not work with your system, the code is not perfect. My main concern is if your Tautulli is configured differently. I made this using my system, and tested it with my system. <b>Use this code as inspiration</b>.
## Instructions
There are multiple settings you must configure! They are all located in <b>config.json</b>.
<br><br>
<b>Tautulli API key</b><br>
API key generated by Tautulli.
There are multiple settings you must configure!
<b>Tautulli IP</b><br>
The IP address of the Tautulli server.
<b>config.json</b><br>
This file needs multiple values. Most importantly your Tautulli IP, port and API key. I made this using HTTP, if you use HTTPS you have to modify the API.
<b>Tautulli Port</b><br>
The port for the Tautulli server. Can be left as "".
<b>api/get_stats_2020.php</b><br>
This file needs to know the ID of your movie and show library. It only supports two libraries. The ID can be found in your url when you open the library on the Tautulli website.
<b>SSL</b><br>
This is supposed to enable HTTPS support, but it does not function at this time. Leave as false.
If you are lucky, it could be functional now.
<br><br><br>
If you want to change something:
* The website is built in "get_stats_2020.js"
* All values and processing is done in "/api/get_stats_2020.php"
* The CSS is a mess, and located in "/assets/css/main.css"
<b>Tautulli Root</b><br>
If using reverse proxy with a set root, add it here. Do not add "/" before or after.
<b>Library ID Movies</b><br>
The ID of your movie library in Tautulli. You can find it in the URL when visiting the library on the Tautulli website.
<b>Library ID Shows</b><br>
The ID of your show library in Tautulli. You can find it in the URL when visiting the library on the Tautulli website.
<b>Library ID Movies</b><br>
The id of your movie library in Tautulli. You can find it in the URL when visiting the library on the Tautulli website.
<b>Wrapped Start</b><br>
The beginning of the wrapped time period. Written in Epoch. Conversion can be done here https://www.epochconverter.com/.
<b>Wrapped End</b><br>
The end of the wrapped time period. Written in Epoch. Conversion can be done here https://www.epochconverter.com/.
<b>Get_... Settings</b><br>
Disables or enables different methods in the API. Will probably break the website without reconfiguration.
<b>Tautulli Length</b><br>
The number of items in your Tautulli database. Needed so API knows amount of data to load.
## Need help?
If you contact me I might have time to help you. Or maybe not. If not, many people on several forums (including /r/plex) might be able to assist you.
This idea was quite popular, so I might create a better, public solution in the future.
<b>Goodybye.</b>