mirror of
https://github.com/Tautulli/Tautulli.git
synced 2025-03-12 04:35:40 -07:00
75 lines
4.3 KiB
Markdown
75 lines
4.3 KiB
Markdown
# PlexPy
|
|
|
|
[](https://gitter.im/drzoidberg33/plexpy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
|
|
A python based web application for monitoring, analytics and notifications for Plex Media Server (www.plex.tv).
|
|
|
|
This project is based on code from [Headphones](https://github.com/rembo10/headphones) and [PlexWatchWeb](https://github.com/ecleese/plexWatchWeb).
|
|
|
|
* PlexPy [forum thread](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program)
|
|
|
|
## Features
|
|
* Responsive web design viewable on desktop, tablet and mobile web browsers.
|
|
* Themed to complement Plex/Web.
|
|
* Easy configuration setup (no separate web server required).
|
|
* Monitor current Plex Media Server activity.
|
|
* Fully customizable notifications for stream activity and recently added media.
|
|
* Top statistics on home page with configurable duration and measurement metric.
|
|
* Global watching history with search/filtering & dynamic column sorting.
|
|
* Full user list with general information and comparison stats.
|
|
* Individual user information including devices IP addresses.
|
|
* Complete library statistics and media file information.
|
|
* Rich analytics presented using Highcharts graphing.
|
|
* Beautiful content information pages.
|
|
* Full sync list data on all users syncing items from your library.
|
|
* And many more!!
|
|
|
|
## Installation and Support
|
|
|
|
* [Installation Guides](https://github.com/drzoidberg33/plexpy/wiki/Installation) shows you how to install PlexPy.
|
|
* [FAQs](https://github.com/drzoidberg33/plexpy/wiki/Frequently-Asked-Questions-(FAQ)) in the wiki can help you with common problems.
|
|
|
|
**Support** the project by implementing new features, solving support tickets and provide bug fixes.
|
|
|
|
## Issues
|
|
|
|
##### Many issues can simply be solved by:
|
|
|
|
- Making sure you update to the latest version.
|
|
- Turning your device off and on again.
|
|
- Analyzing your logs, you just might find the solution yourself!
|
|
- Using the **search** function to see if this issue has already been reported/solved.
|
|
- Checking the [Wiki](https://github.com/drzoidberg33/plexpy/wiki) for
|
|
[ [Installation] ](https://github.com/drzoidberg33/plexpy/wiki/Installation) and
|
|
[ [FAQs] ](https://github.com/drzoidberg33/plexpy/wiki/Frequently-Asked-Questions-(FAQ)).
|
|
- For basic questions try asking on [Gitter](https://gitter.im/drzoidberg33/plexpy) or the [Plex Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) first before opening an issue.
|
|
|
|
##### If nothing has worked:
|
|
|
|
1. Open a new issue on the GitHub [issue tracker](http://github.com/drzoidberg33/plexpy/issues).
|
|
2. Provide a clear title to easily help identify your problem.
|
|
3. Use proper [markdown syntax](https://help.github.com/articles/github-flavored-markdown) to structure your post (i.e. code/log in code blocks).
|
|
4. Make sure you provide the following information:
|
|
- [ ] Branch
|
|
- [ ] Version/Commit hash
|
|
- [ ] Your operating system and python version
|
|
- [ ] What you did?
|
|
- [ ] What happened?
|
|
- [ ] What you expected?
|
|
- [ ] How can we reproduce your issue?
|
|
- [ ] What are your (relevant) settings?
|
|
- [ ] Include a link to your **FULL** (not just a few lines!) log file that has the error. Please use [Gist](http://gist.github.com) or [Pastebin](http://pastebin.com/).
|
|
5. Close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it.
|
|
|
|
## Feature Requests
|
|
|
|
1. Search for similar existing 'issues', feature requests can be recognized by the blue `enhancement` label.
|
|
2. If a similar request exists, post a comment (+1, or add a new idea to the existing request).
|
|
3. If no similar requests exist, you can create a new one.
|
|
4. Provide a clear title to easily identify the feature request.
|
|
5. Tag your feature request with `[Feature Request]` so it can be identified easily.
|
|
|
|
## License
|
|
This is free software under the GPL v3 open source license. Feel free to do with it what you wish, but any modification must be open sourced. A copy of the license is included.
|
|
|
|
This software includes Highsoft software libraries which you may freely distribute for non-commercial use. Commerical users must licence this software, for more information visit https://shop.highsoft.com/faq/non-commercial#non-commercial-redistribution. |