anonfunc/JellyPy
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added more questions/answers and recategoriezed

JonnyWong16
2016-03-24 11:02:34 -07:00
parent df04aca213
commit 480e227037
1 changed files with 137 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

159
Frequently-Asked-Questions-(FAQ).md

@@ -1,25 +1,74 @@
Welcome to the PlexPy FAQ. Please note that most answers are not added yet. If you can't find a solution here, please ask in the [Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) and don't forget to highlight an3k (simply write @an3k somewhere). Thank you! Welcome to the PlexPy FAQ. Please note that most answers are not added yet. If you can't find a solution here, please ask on [Gitter](https://gitter.im/drzoidberg33/plexpy) or the [Forums](https://forums.plex.tv/discussion/169591/plexpy-another-plex-monitoring-program) and don't forget to highlight an3k (simply write @an3k somewhere). Thank you!
## General ## General
* [I have some weird Python errors!](#cat1-q1) * [I have some weird Python errors!](#cat-gen-q1)
* [Why does PlexPy not work with my reverse proxy setup?](#cat1-q2) * [I am receiving some weird datatable warnings.](#cat-gen-q2)
* [I forgot my username and/or password!](#cat1-q3) * [I forgot my username and/or password!](#cat-gen-q3)
* [I can't reach the web interface!](#cat1-q4) * [I can't reach the web interface!](#cat-gen-q4)
* [I can't get Notifications working! Is there a magic trick?](#cat1-q5) * [When I try to update PlexPy, it keeps telling me that "A newer version is available. You're XX commits behind."](#cat-gen-q5)
* [How do I enable displaying of Bitrates in the Activity pane?](#cat1-q6) * [What does the warning "Unable to retrieve data" mean? Is this a problem?](#cat-gen-q6)
* [What does the warning "Unable to retrieve data" mean? Is this a problem?](#cat1-q7) * [My libraries are duplicated! How do I remove them?](#cat-gen-q7)
* [How can I access PlexPy outside my home network?](#cat-gen-q8)
* [Why does PlexPy not work with my reverse proxy setup?](#cat-gen-q9)
## Activity and History Logging
* [How do I enable displaying of Bitrates in the Activity pane?](#cat-his-q1)
* [What is the grey progress bar under the current activity?](#cat-his-q2)
* [I can see the streams on the homepage, but nothing is being logged.](#cat-his-q3)
* [Do I need to keep PlexPy running to record history?](#cat-his-q4)
* [Watch history isn't showing up under "Last Watched" on the homepage.](#cat-his-q5)
## Notifications
* [I can't get Notifications working! Is there a magic trick?](#cat-not-q1)
* [Can I disable recently added notifications for TV Shows/Movies?](#cat-not-q2)
* [All my recently added notifications are showing `S00E01`.](#cat-not-q3)
## Windows ## Windows
* [I enabled HTTPS but received a warning that the pyOpenSSL module is missing. How do I fix this?](#cat2-q1) * [I enabled HTTPS but received a warning that the pyOpenSSL module is missing. How do I fix this?](#cat-win-q1)
* [PlexPy keeps telling me "You're running an unknown version of PlexPy."](#cat-win-q2)
* [I am getting a "DatabaseError: file is encrypted of is not a database"!](#cat-win-q3)
## iOS
* [PlexPy isn't logging my history from my iOS device!](#cat-ios-q1)
## QNAP
* [How do I set the Plex Logs Folder on QNAP?](#cat-qnap-q1)
--- ---
### General ### General
#### <a name="cat1-q1">Q:</a> I have some weird Python errors! #### <a name="cat-gen-q1">Q:</a> I have some weird Python errors!
**A:** Please make sure you have Python 2.7.x installed. **A:** Please make sure you have the latest version of Python 2.7.x installed.
#### <a name="cat1-q2">Q:</a> Why does PlexPy not work with my reverse proxy setup? #### <a name="cat-gen-q2">Q:</a> I am receiving some weird datatable warnings.
**A:** Most datatable warnings can be solved by doing a force refresh in your browser (Ctrl+F5 or Option+Reload in Safari). If that doesn't work, try clearing your browser's cache.
#### <a name="cat-gen-q3">Q:</a> I forgot my username and/or password!
**A:** Open PlexPy's config.ini with your preferred editor and search for `http_username` and `http_password`. The value after the equal sign is the data you are looking for.
#### <a name="cat-gen-q4">Q:</a> I can't reach the web interface!
**A:** Open PlexPy's config.ini with your preferred editor, search for `http_host` and `http_port` and remove everything after the equal sign for each entry. Then restart PlexPy and it will listen on any IP address and standard port 8181.
#### <a name="cat-gen-q5">Q:</a> When I try to update PlexPy, it keeps telling me that "A newer version is available. You're XX commits behind."
**A:** Try run `git reset --hard HEAD` using the shell/command line first, then either update from the PlexPy interface or `git pull`.
#### <a name="cat-gen-q6">Q:</a> What does the warning "Unable to retrieve data" mean? Is this a problem?
**A:** No, not necessarily. It means that you requested data that is not available, for example when you view the profile or history of a user who hasn't watched anything yet. PlexPy can't know what have happened before it got installed (still no magic involved) and only starts logging from the time of its installation.
#### <a name="cat-gen-q7">Q:</a> My libraries are duplicated! How do I remove them?
**A:** This usually happens when you try to reinstall or switch your Plex Media Server. You can visit the following url to remove all libraries not associated with the current Plex server connected to PlexPy.
```
http://localhost:8181/delete_duplicate_libraries
```
#### <a name="cat-gen-q8">Q:</a> How can I access PlexPy outside my home network?
**A:** You need to forward an external port on your router to the internal port used by PlexPy (default is `8181`). Visit [Port Forward](http://portforward.com/) for instructions for your particular router.
#### <a name="cat-gen-q9">Q:</a> Why does PlexPy not work with my reverse proxy setup?
**A:** PlexPy uses CherryPy as it's web server, and CherryPy includes support for reverse proxies. However, you may need to locate your plexpy `config.ini` file and toggle the value `http_proxy` to `1`. You should also ensure that your proxy web server (e.g. nginx or apache) is sending the standard `X-` headers to CherryPy. For nginx, the configuration would look like this: **A:** PlexPy uses CherryPy as it's web server, and CherryPy includes support for reverse proxies. However, you may need to locate your plexpy `config.ini` file and toggle the value `http_proxy` to `1`. You should also ensure that your proxy web server (e.g. nginx or apache) is sending the standard `X-` headers to CherryPy. For nginx, the configuration would look like this:
``` ```
@@ -40,26 +89,51 @@ proxy_set_header X-Forwarded-Ssl on;
Don't forget to clear your web browser's cache *every* time you update your web server configuration. Don't forget to clear your web browser's cache *every* time you update your web server configuration.
#### <a name="cat1-q3">Q:</a> I forgot my username and/or password!
**A:** Open PlexPy's config.ini with your preferred editor and search for `http_username` and `http_password`. The value after the equal sign is the data you are looking for.
#### <a name="cat1-q4">Q:</a> I can't reach the web interface! ---
**A:** Open PlexPy's config.ini with your preferred editor, search for `http_host` and `http_port` and remove everything after the equal sign for each entry. Then restart PlexPy and it will listen on any IP address and standard port 8181.
#### <a name="cat1-q5">Q:</a> I can't get Notifications working! Is there a magic trick? ### Activity and History Logging
#### <a name="cat-his-q1">Q:</a> How do I enable displaying of Bitrates in the Activity pane?
**A:** You can't because it is not possible since such information is not supplied by the Plex API.
#### <a name="cat-his-q2">Q:</a> What is the grey progress bar under the current activity?
**A:** The yellow progress bar is the current stream progress, and the grey bar is the current transcoder progress (not the available buffer on the client device).
#### <a name="cat-his-q3">Q:</a> I can see the streams on the homepage, but nothing is being logged.
**A:** History is only logged if all those following conditions are satisfied:
* After the stream is stopped.
* If the total stream duration is longer than the "Ignore interval" you set in the settings.
* If "Keep History" for the user is enabled (Users > Edit Mode > Toggle Keep History)
* If "Keep History" for the library is enabled (Libraries > Edit Mode > Toggle Keep History)
#### <a name="cat-his-q4">Q:</a> Do I need to keep PlexPy running to record history?
**A:** Yes. PlexPy cannot "see" your Plex activity if it isn't running, or retroactivily import old history.
#### <a name="cat-his-q5">Q:</a> Watch history isn't showing up under "Last Watched" on the homepage.
**A:** "Last Watched" only shows history that is considered as "watched" (exceed the watched percent that you specify in the settings).
---
### Notifications
#### <a name="cat-not-q1">Q:</a> I can't get Notifications working! Is there a magic trick?
**A:** To be honest: Yes. To be very honest: No. You probably forgot to click on the gray bell icon next to the Notification Agent. On the popup you have to check for which notification the selected agent should be used for. After you checked at least one notification type and clicked on Close the bell turns satisfying orange-ish. **A:** To be honest: Yes. To be very honest: No. You probably forgot to click on the gray bell icon next to the Notification Agent. On the popup you have to check for which notification the selected agent should be used for. After you checked at least one notification type and clicked on Close the bell turns satisfying orange-ish.
#### <a name="cat1-q6">Q:</a> How do I enable displaying of Bitrates in the Activity pane? #### <a name="cat-not-q2">Q:</a> Can I disable recently added notifications for TV Shows/Movies?
**A:** You can't because it is not possible since such information is not supplied by the Plex Media Server. **A:** You can control which libraries are included in recently added notifications by going to Libraries > Edit mode > Toggle Recently Added.
#### <a name="cat-not-q3">Q:</a> All my recently added notifications are showing `S00E01`.
**A:** You probably have "Group notifications for recently added TV Shows or Music" checked in the notification settings. No Season/Episode or Album/Track metadata will be available with this setting enabled.
#### <a name="cat1-q7">Q:</a> What does the warning "Unable to retrieve data" mean? Is this a problem?
**A:** No, not necessarily. It means that you requested data that is not available, for example when you view the profile or history of a user who hasn't watched anything yet. PlexPy can't know what have happened before it got installed (still no magic involved) and only starts logging from the time of its installation.
--- ---
### Windows ### Windows
#### <a name="cat2-q1">Q:</a> I enabled HTTPS but received a warning that the pyOpenSSL module is missing. How do I fix this? #### <a name="cat-win-q1">Q:</a> I enabled HTTPS but received a warning that the pyOpenSSL module is missing. How do I fix this?
**A:** The pyOpenSSL module is not bundled with Python. Follow the two simple steps below to manually install it. **A:** The pyOpenSSL module is not bundled with Python. Follow the two simple steps below to manually install it.
1. Download https://github.com/pyca/pyopenssl/archive/0.15.1.zip and save it to C:\ 1. Download https://github.com/pyca/pyopenssl/archive/0.15.1.zip and save it to C:\
@@ -67,4 +141,45 @@ Don't forget to clear your web browser's cache *every* time you update your web
If you have installed Python into a different directory or downloaded pyopenssl to somewhere else you have to modify the above command in step 2 accordingly. If you have installed Python into a different directory or downloaded pyopenssl to somewhere else you have to modify the above command in step 2 accordingly.
#### <a name="cat-win-q2">Q:</a> PlexPy keeps telling me "You're running an unknown version of PlexPy."
**A:** You most likely forgot the following step when installing Git for Windows. Run the Git installer again, making sure you include the step below.
> Run the installer, select all the defaults except for the section called "Adjusting your PATH environment" - here select **"Use Git from the Windows command prompt"**
#### <a name="cat-win-q3">Q:</a> I am getting a "DatabaseError: file is encrypted of is not a database"!
**A:** This seems to be a version mismatch with the packaged Python sqlite3 libraries. Download the latest "Precompiled Binaries for Windows" from [here](https://www.sqlite.org/download.html) and place the extrated `sqlite3.dll`s file in `C:\Python27\DLLs`.
---
### iOS
#### <a name="cat-ios-q1">Q:</a> PlexPy isn't logging my history from my iOS device!
**A:** Check if your iOS device has any [special characters](https://terpconnect.umd.edu/~zben/Web/CharSet/htmlchars.html) in it's name. This is a know bug with the iOS app ([#212](https://github.com/drzoidberg33/plexpy/issues/212)). This iOS beta app also has a special character (`ß`) in the app name. The only solution is to remove the special character or use the non-beta app.
---
### QNAP
#### <a name="cat-qnap-q1">Q:</a> How do I set the Plex Logs Folder on QNAP?
**A:** When running a Plex Media Server on a QNAP, Plex writes logs into a non-shared location with the `/share/.qpkg` path. PlexPy cannot be pointed to this location and you need to create a symbolic link.
1. SSH into your QNAP device.
2. Create a directory in a shared folder that will be accessible:
```
mkdir /share/MD0_DATA/PATH/TO/VALID/SHARE/FOLDER/PlexLogs
```
3. Create symbolic link between unshared log folder and new shared folder:
```
ln -s "/share/MD0_DATA/.qpkg/PlexMediaServer/Library/Plex Media Server/Logs/" "/share/MD0_DATA/PATH/TO/VALID/SHARE/FOLDER/PlexLogs"
```
4. Your new location is now usable in Settings > Plex Media Server > Plex Logs > Logs Folder:
```
\\<ipaddress>\PATH\TO\VALID\SHARE\FOLDER\PlexLogs
```