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

Updated Frequently Asked Questions (FAQ) (markdown)

an3k
2016-02-01 22:35:33 +01:00
parent 80c88eb442
commit f19396ab19
1 changed files with 49 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -1,21 +1,33 @@
## General FAQs
* [Why does PlexPy not work with my reverse proxy setup?](#cat1-q1)
* [This is question 2?](#cat1-q2)
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!
## Windows specific FAQs
* [This is question 1?](#cat2-q1)
## General
* [I have some weird Python errors!](#cat1-q1)
* [Why does PlexPy not work with my reverse proxy setup?](#cat1-q2)
* [I forgot my username and/or password!](#cat1-q3)
* [I can't reach the web interface!](#cat1-q4)
* [I can't get Notifications working! Is there a magic trick?](#cat1-q5)
## Windows
* [I enabled HTTPS but received a warning that the pyOpenSSL module is missing. How do I fix this?](#cat2-q1)
* [This is question 2?](#cat2-q2)
## Linux specific FAQs
## Linux
* [This is question 1?](#cat3-q1)
* [This is question 2?](#cat3-q2)
## Mac OSX
* [This is question 1?](#cat4-q1)
* [This is question 2?](#cat4-q2)
---
### Category 1
### General
#### <a name="cat1-q1">Q:</a> Why does PlexPy not work with my reverse proxy setup?
**A:** PlexPy uses CherryPy as it's webserver, 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 webserver (e.g. nginx or apache) is sending the standard `X-` headers to CherryPy. For nginx, the configuration would look like this:
#### <a name="cat1-q1">Q:</a> I have some weird Python errors!
**A:** Please make sure you have Python 2.7.x installed.
#### <a name="cat1-q2">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:
```
# Standard proxying headers
@@ -25,7 +37,7 @@ proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
```
If you are having issues with an HTTPS-terminating proxy setup (e.g. `Internet--->https://Nginx--->http://plexpy`), you should ensure that your proxy webserver is also including these two SSL-specific `X-` headers
If you are having issues with an HTTPS-terminating proxy setup (e.g. `Internet--->https://Nginx--->http://plexpy`), you should ensure that your proxy web server is also including these two SSL-specific `X-` headers
```
# Used by Cherry-Py (different versions look for different headers)
@@ -33,24 +45,35 @@ proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Ssl on;
```
Don't forget to clear your web browser's cache *every* time you update your webserver configuration.
Don't forget to clear your web browser's cache *every* time you update your web server configuration.
#### <a name="cat1-q2">Q:</a> This is question 2?
**A:** This is an answer.
#### <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?
**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.
---
### Category 2
### Windows
#### <a name="cat2-q1">Q:</a> This is question 1?
**A:** This is an answer.
#### <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:** 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:\
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="cat2-q2">Q:</a> This is question 2?
**A:** This is an answer.
---
### Category 3
### Linux
#### <a name="cat3-q1">Q:</a> This is question 1?
**A:** This is an answer.
@@ -58,5 +81,14 @@ Don't forget to clear your web browser's cache *every* time you update your webs
#### <a name="cat3-q2">Q:</a> This is question 2?
**A:** This is an answer.
---
### Mac OSX
#### <a name="cat4-q1">Q:</a> This is question 1?
**A:** This is an answer.
#### <a name="cat4-q2">Q:</a> This is question 2?
**A:** This is an answer.