Readme Updates #12
Closed
Readme Updates #12
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
fix missing - and add nice-to-haves for n00bs
add warning about not using an IP for Plex.
jsclayton
requested changes
Jul 16, 2023
| @@ -6,16 +6,21 @@ Expose library playback, storage, and host metrics in a Prometheus format. | |||
|
|
|||
| The exporter is configured via required environment variables: | |||
|
|
|||
| - `PLEX_SERVER`: The full URL where your server can be reached, including the scheme and port (if not 80 or 443). For example `http://192.168.0.10:32400` or `https://my.plex.tld`. | |||
| - `PLEX_SERVER`: The full URL where your server can be reached, including the scheme and port (if not 80 or 443). For example `http://192.168.0.10:32400`. | |||
There was a problem hiding this comment.
https://my.plex.tld is an acceptable example URL if configured correctly. Perhaps instead, add a note that the URL needs to be reachable relative to where the exporter is running?
| - `PLEX_TOKEN`: A [Plex token](https://support.plex.tv/articles/204059436-finding-an-authentication-token-x-plex-token/) belonging to the server administrator. | ||
|
|
||
| > **Note** | ||
| > If you don't use an IP address for the Plex URL, all the dashboard stats won't populate. |
There was a problem hiding this comment.
This isn't the case. If you're having issues please open an issue with details of your setup.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixed a typo in the docker CLI command and added a new "nice-to-haves" for n00bies. Also, added a warning about not using a FQDN in the Plex URL or stats won't fully populate.