Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix headings in the README #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix headings in the README #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,25 @@ Plex Export allows you to produce an HTML page with information on the media con
* View additional item information on click


## Instructions
## Instructions

1. You must have PHP installed on your system for this to work (PLEX Export does not have to be run on the system containing Plex Media Server however)
2. In your preferred shell/terminal enter the following command: `php cli.php`
3. If Plex Media Server is running on a different machine, specify it's URL with the `-plex-url` parameter e.g. `php cli.php -plex-url=http://other-machine.local:32400`
4. Upon completion your plex-data directory will now contain a .js file and any related thumbnails. Access the index.html file in your web browser and enjoy :)


## Notes
## Notes

* The website is designed for modern browsers (Safari, Chrome, Firefox)
* You may need to chmod cli.php to allow for executables
* Delete cli.php if you upload PLEX Export to any public location
* If your Plex Server is running in Home mode, we need to authenticate via a token
* To get a valid token for your system, look here: https://support.plex.tv/hc/en-us/articles/204059436-Finding-your-account-token-X-Plex-Token
* Then when running cli.php, add a parameter like: -token=<Your Token>
* Then when running cli.php, add a parameter like: `-token=<Your Token>`


## Features
## Features

* Filter by genre, actors etc
* Sort by name, year, rating etc
Expand Down