Browse Source

update docs for jellyfin [no docker]

pull/186/head
Jason Dove 5 years ago
parent
commit
fc5bedc70b
  1. 2
      README.md
  2. BIN
      docs/images/jellyfin-api-key.png
  3. BIN
      docs/images/jellyfin-create-api-key-button.png
  4. BIN
      docs/images/jellyfin-libraries-synchronize-switch.png
  5. BIN
      docs/images/jellyfin-media-source-edit-libaries-icon.png
  6. BIN
      docs/images/jellyfin-media-source-edit-path-replacements-icon.png
  7. BIN
      docs/images/jellyfin-media-source-path-replacements.png
  8. 65
      docs/user-guide/add-media-items.md

2
README.md

@ -15,11 +15,11 @@ Want to join the community or have a question? Join us on [Discord](https://disc @@ -15,11 +15,11 @@ Want to join the community or have a question? Join us on [Discord](https://disc
- Powerful scheduling options such as chronological collection playback throughout the day or over multiple days
- [Hardware-accelerated transcoding](#Hardware-Transcoding) options (QSV, NVENC, VAAPI)
- [Plex](https://www.plex.tv/) media and metadata
- [Jellyfin](https://jellyfin.org/) media and metadata
- Music video libraries
## Planned Features
- [Jellyfin](https://jellyfin.org/) media and metadata
- Run as a Windows service
- Spots to fill unscheduled gaps

BIN
docs/images/jellyfin-api-key.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

BIN
docs/images/jellyfin-create-api-key-button.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

BIN
docs/images/jellyfin-libraries-synchronize-switch.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/images/jellyfin-media-source-edit-libaries-icon.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.7 KiB

BIN
docs/images/jellyfin-media-source-edit-path-replacements-icon.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.7 KiB

BIN
docs/images/jellyfin-media-source-path-replacements.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

65
docs/user-guide/add-media-items.md

@ -1,5 +1,5 @@ @@ -1,5 +1,5 @@
ErsatzTV needs to know about your media items in order to create channels.
Two library kinds are currently supported: [Local](#local-libraries) and [Plex](#plex-libraries).
Three library kinds are currently supported: [Local](#local-libraries), [Plex](#plex-libraries) and [Jellyfin](#jellyfin-libraries).
## Local Libraries
@ -35,7 +35,7 @@ With Plex libraries, Plex provides all metadata. @@ -35,7 +35,7 @@ With Plex libraries, Plex provides all metadata.
#### Sign In
The add media items from Plex under `Media Sources` > `Plex`, click the `Sign in to Plex` button and sign in with your Plex account.
To add media items from Plex, under `Media Sources` > `Plex` click the `Sign in to Plex` button and sign in with your Plex account.
#### Synchronize Libraries
@ -66,6 +66,67 @@ Click `Save Changes` after you have created all needed path replacements. @@ -66,6 +66,67 @@ Click `Save Changes` after you have created all needed path replacements.
![Plex Path Replacements](../images/plex-media-source-path-replacements.png)
## Jellyfin Libraries
Jellyfin libraries provide a way to synchronize your media (metadata) from Jellyfin to ErsatzTV. This synchronization process is one-way: changes made within Jellyfin are synchronized to ErsatzTV. ErsatzTV will never make any modifications to your Jellyfin configuration or media.
### Metadata
With Jellyfin libraries, Jellyfin provides all metadata.
### Add Media Items
#### Connect to Server
Connecting to a Jellyfin server requires two settings: the server address and an api key.
##### Server Address
The server address is the address that you type in your web browser to access your Jellyfin server.
##### API Key
To create a Jellyfin API Key, from the `Admin / Dashboard` in Jellyfin, select `Advanced / API Keys` and click the `+` button near the top.
![Jellyfin Create API Key Button](../images/jellyfin-create-api-key-button.png)
Give the API Key a name like `ErsatzTV` and click `Ok`. The API key is then displayed.
![Jellyfin API Key](../images/jellyfin-api-key.png)
##### Configuration
Finally, in ErsatzTV, under `Media Sources` > `Jellyfin` click the `Connect Jellyfin` button, enter the `Address` and `Api Key` and click `Save Changes` to connect to your Jellyfin server.
#### Synchronize Libraries
After connecting, select which libraries you would like to synchronize from Jellyfin to ErsatzTV by clicking the `Edit Libraries` button for the desired Jellyfin server.
![Jellyfin Edit Libraries Icon](../images/jellyfin-media-source-edit-libaries-icon.png)
In the libraries listing, click the `Synchronize` switch for all libraries you would like to synchronize from Jellyfin to ErsatzTV, and click the `Save Changes` button to start the synchronization process.
![Jellyfin Libraries Synchronize Switch](../images/jellyfin-libraries-synchronize-switch.png)
### Path Replacements
Media items are not streamed from Jellyfin media sources. Instead, ErsatzTV will attempt to play media items from disk using the same path that Jellyfin uses to play the media item.
There are two ways to make this work:
1. Ensure ErsatzTV has access to exactly the same shares and mounts as Jellyfin
2. Configure path replacements to tell ErsatzTV where it should look on its file system for a given Jellyfin folder
Option 1 is recommended as it will "just work" without any further configuration.
To configure path replacements for a Jellyfin media source, click the `Edit Path Replacements` button in the
![Jellyfin Edit Path Replacements Icon](../images/jellyfin-media-source-edit-path-replacements-icon.png)
Click `Add Path Replacement` to add a new path replacement, and enter the `Jellyfin Path` along with the equivalent `Local Path` for ErsatzTV.
Click `Save Changes` after you have created all needed path replacements.
![Jellyfin Path Replacements](../images/jellyfin-media-source-path-replacements.png)
## Collections
ErsatzTV does not schedule individual media items; only collections of items can be scheduled.

Loading…
Cancel
Save