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

Add more questions and answers

JonnyWong16
2016-03-24 15:49:25 -07:00
parent 21b3fe1510
commit 9ca1d3b144
1 changed files with 116 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,74 +1,88 @@
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
* [I have some weird Python errors!](#cat-gen-q1)
* [I am receiving some weird datatable warnings.](#cat-gen-q2)
* [I forgot my username and/or password!](#cat-gen-q3)
* [I can't reach the web interface!](#cat-gen-q4)
* [When I try to update PlexPy, it keeps telling me that "A newer version is available. You're XX commits behind."](#cat-gen-q5)
* [What does the warning "Unable to retrieve data" mean? Is this a problem?](#cat-gen-q6)
* [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)
* [I have some weird Python errors!](#general-q1)
* [I am receiving some weird datatable warnings.](#general-q2)
* [I forgot my username and/or password!](#general-q3)
* [I can't reach the web interface!](#general-q4)
* [When I try to update PlexPy, it keeps telling me that "A newer version is available. You're XX commits behind."](#general-q5)
* [When I try to update PlexPy, it keeps telling me "Please, commit your changes or stash them before you can merge."](#general-q6)
* [What does the warning "Unable to retrieve data" mean? Is this a problem?](#general-q7)
* [My libraries are duplicated! How do I remove them?](#general-q8)
* [How can I access PlexPy outside my home network?](#general-q9)
* [Why does PlexPy not work with my reverse proxy setup?](#general-q10)
* [I need to reinstall PlexPy. Can I keep my history and statistcs?](#general-q11)
* [Help! I accidentally deleted a user/library! How can I add it back?](#general-q12)
## 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)
* [How do I enable displaying of bitrates in the Activity pane?](#history-q1)
* [What is the grey progress bar under the current activity?](#history-q2)
* [I can see the streams on the homepage, but nothing is being logged.](#history-q3)
* [Do I need to keep PlexPy running to record history?](#history-q4)
* [Can PlexPy import history from before it was installed?](#history-q5)
* [Watch history isn't showing up under "Last Watched" on the homepage.](#history-q6)
* [After resuming a media item, it shows up as two plays in PlexPy.](#history-q7)
## 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)
* [I can't get Notifications working! Is there a magic trick?](#notifications-q1)
* [Can I disable recently added notifications for TV Shows/Movies?](#notifications-q2)
* [All my recently added notifications are showing `S00E01`.](#notifications-q3)
* [I can't seem to setup Gmail notifications. Help?](#notifications-q4)
## Windows
* [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)
* [I enabled HTTPS but received a warning that the pyOpenSSL module is missing. How do I fix this?](#windows-q1)
* [PlexPy keeps telling me "You're running an unknown version of PlexPy."](#windows-q2)
* [I am getting a "DatabaseError: file is encrypted of is not a database"!](#windows-q3)
* [How can I run PlexPy without the command prompt staying open?](#windows-q4)
## iOS
* [PlexPy isn't logging my history from my iOS device!](#cat-ios-q1)
* [PlexPy isn't logging my history from my iOS device!](#ios-q1)
## QNAP
* [How do I set the Plex Logs Folder on QNAP?](#cat-qnap-q1)
* [How do I set the Plex Logs Folder on QNAP?](#qnap-q1)
## FreeNAAS
* [When trying to start PlexPy as a service, I get the message "PID file '/usr/local/share/plexpy/plexpy.pid' already exists. Exiting."](#freenas-q1)
---
### General
#### <a name="cat-gen-q1">Q:</a> I have some weird Python errors!
#### <a name="general-q1">Q:</a> I have some weird Python errors!
**A:** Please make sure you have the latest version of Python 2.7.x installed.
#### <a name="cat-gen-q2">Q:</a> I am receiving some weird datatable warnings.
#### <a name="general-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 name="general-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="general-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 the default 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 name="general-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 name="general-q6">Q:</a> When I try to update PlexPy, it keeps telling me "Please, commit your changes or stash them before you can merge."
**A:** See the answer to the previous question.
#### <a name="general-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.
#### <a name="cat-gen-q7">Q:</a> My libraries are duplicated! How do I remove them?
#### <a name="general-q8">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 name="gen-q9">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 name="general-q10">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:
```
@@ -89,18 +103,38 @@ 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.
#### <a name="general-q11">Q:</a> I need to reinstall PlexPy. Can I keep my history and statistcs?
**A:** Yes, all you need to do is copy your `plexpy.db` database file somewhere safe (make sure PlexPy is shut down when doing this). Then after reinstalling, place the file back inside the PlexPy folder before starting up PlexPy again.
#### <a name="general-q12">Q:</a> Help! I accidentally deleted a user/library! How can I add it back?
**A:** First, you need to find the `user_id` for the user ([here](https://plex.tv/api/users)) or `section_id` for the library (the last number in the URL of the library in Plex Web). (This will also work with the `section_name` or `username` but will be less accurate). Once you have the correct data, visit the corresponding address below:
* Undelete a user:
```
http://localhost:8181/undelete_user?user_id=<user_id>
http://localhost:8181/undelete_user?username=<username>
```
* Undelete a library:
```
http://localhost:8181/undelete_library?section_id=<section_id>
http://localhost:8181/undelete_library?section_name=<section_name>
```
---
### Activity and History Logging
#### <a name="cat-his-q1">Q:</a> How do I enable displaying of Bitrates in the Activity pane?
#### <a name="history-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 name="history-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 name="history-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.
@@ -108,53 +142,72 @@ Don't forget to clear your web browser's cache *every* time you update your web
* 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="history-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 retroactively import old history.
#### <a name="cat-his-q5">Q:</a> Watch history isn't showing up under "Last Watched" on the homepage.
#### <a name="history-q5">Q:</a> Can PlexPy import history from before it was installed?
**A:** No, unless you had plexWatch installed previously and import the database, PlexPy can only start logging history after it is installed.
#### <a name="history-q6">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).
#### <a name="history-q7">Q:</a> After resuming a media item, it shows up as two plays in PlexPy.
**A:** Enable "Group Table and Watch Statistics History" in Settings > General.
---
### 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 name="notifications-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. Also, make sure the "Global Notification Toggles" are enabled under Settings > Notifications.
#### <a name="cat-not-q2">Q:</a> Can I disable recently added notifications for TV Shows/Movies?
#### <a name="notifications-q2">Q:</a> Can I disable recently added notifications for TV Shows/Movies?
**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 name="notifications-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="notifications-q4">Q:</a> I can't seem to setup Gmail notifications. Help?
**A:** Here are the settings for Gmail. If you don't use 2-factor authentication, you may need to allow less secure apps to access your account. (See Option 2 [here](https://support.google.com/accounts/answer/6010255?hl=en&ref_topic=2401957)).
```
SMTP Server: smtp.gmail.com
SMTP Port: 587
SMTP User: MyEmail@gmail.com
SMTP Password: Your Gmail password or app password if you use 2-factor authentication (https://security.google.com/settings/security/apppasswords)
TLS: checked
```
---
### Windows
#### <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 name="windows-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.
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:\`
2. Run `C:\Python27\Scripts\pip.exe install C:\pyopenssl-0.15.1.zip`
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 name="windows-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`.
#### <a name="windows-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 extracted `sqlite3.dll`s file in `C:\Python27\DLLs`.
#### <a name="windows-q4">Q:</a> How can I run PlexPy without the command prompt staying open?
**A:** Please refer to the instructions under the [Installation as a Daemon](https://github.com/drzoidberg33/plexpy/wiki/Install-as-a-daemon#windows) wiki.
---
### iOS
#### <a name="cat-ios-q1">Q:</a> PlexPy isn't logging my history from my iOS device!
#### <a name="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.
@@ -162,7 +215,7 @@ If you have installed Python into a different directory or downloaded pyopenssl
### QNAP
#### <a name="cat-qnap-q1">Q:</a> How do I set the Plex Logs Folder on QNAP?
#### <a name="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.
@@ -182,4 +235,17 @@ If you have installed Python into a different directory or downloaded pyopenssl
```
\\<ipaddress>\PATH\TO\VALID\SHARE\FOLDER\PlexLogs
```
```
---
### FreeNAS
#### <a name="freenas-q1">Q:</a> When trying to start PlexPy as a service, I get the message "PID file '/usr/local/share/plexpy/plexpy.pid' already exists. Exiting."
**A:** Make sure PlexPy is stopped then run:
```
rm -f /usr/local/share/plexpy/plexpy.pid
service plexpy start
```