Browse Source

update docs (#1277)

* tweak mkdocs config; update install

* path replacement doc updates
pull/1278/head
Jason Dove 2 years ago committed by GitHub
parent
commit
c27b906cd5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 12
      docs/user-guide/add-media-items.md
  2. 2
      docs/user-guide/create-collections.md
  3. 8
      docs/user-guide/install.md
  4. 5
      mkdocs.yml

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

@ -57,9 +57,9 @@ In the libraries listing, click the `Synchronize` switch for all libraries you w
![Plex Libraries Synchronize Switch](../images/plex-libraries-synchronize-switch.png) ![Plex Libraries Synchronize Switch](../images/plex-libraries-synchronize-switch.png)
### Path Replacements ### Streaming From Disk
Media items are not streamed from Plex media sources. Instead, ErsatzTV will attempt to play media items from disk using the same path that Plex uses to play the media item. Media items are streamed from Plex media sources by default. Instead, if you would like to stream from disk, ErsatzTV will check for media items using the same path that Plex uses to play the media item.
There are two ways to make this work: There are two ways to make this work:
1. Ensure ErsatzTV has access to exactly the same shares and mounts as Plex 1. Ensure ErsatzTV has access to exactly the same shares and mounts as Plex
@ -118,9 +118,9 @@ In the libraries listing, click the `Synchronize` switch for all libraries you w
![Jellyfin Libraries Synchronize Switch](../images/jellyfin-libraries-synchronize-switch.png) ![Jellyfin Libraries Synchronize Switch](../images/jellyfin-libraries-synchronize-switch.png)
### Path Replacements ### Streaming From Disk
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. Media items are streamed from Jellyfin media sources by default. Instead, if you would like to stream from disk, ErsatzTV will check for media items using the same path that Jellyfin uses to play the media item.
There are two ways to make this work: There are two ways to make this work:
1. Ensure ErsatzTV has access to exactly the same shares and mounts as Jellyfin 1. Ensure ErsatzTV has access to exactly the same shares and mounts as Jellyfin
@ -179,9 +179,9 @@ In the libraries listing, click the `Synchronize` switch for all libraries you w
![Emby Libraries Synchronize Switch](../images/emby-libraries-synchronize-switch.png) ![Emby Libraries Synchronize Switch](../images/emby-libraries-synchronize-switch.png)
### Path Replacements ### Streaming From Disk
Media items are not streamed from Emby media sources. Instead, ErsatzTV will attempt to play media items from disk using the same path that Emby uses to play the media item. Media items are streamed from Emby media sources by default. Instead, if you would like to stream from disk, ErsatzTV will check for media items using the same path that Emby uses to play the media item.
There are two ways to make this work: There are two ways to make this work:
1. Ensure ErsatzTV has access to exactly the same shares and mounts as Emby 1. Ensure ErsatzTV has access to exactly the same shares and mounts as Emby

2
docs/user-guide/create-collections.md

@ -9,7 +9,7 @@ ErsatzTV does not schedule individual media items; only collections of items can
### Collections ### Collections
Collections are created manually by adding individual media items to it. There is no restriction on media type. A collection can contain a single media type, eg. movies or any combination of media types. Collections are created manually by adding individual media items to it. There is no restriction on media type. A collection can contain a single media type, eg. movies or any combination of media types.
The items to be added can be found by browsing your libraries or by using ErsatzTV's powerful Search feature. An empty collection can be created under `Lists` > `Collections` > `Add Collection`. The items to be added can be found by browsing your libraries or by using ErsatzTV's powerful [Search](../search) feature. An empty collection can be created under `Lists` > `Collections` > `Add Collection`.
To create a collection, find the media items you would like to include and select them by clicking the selection button in the top left of the poster: To create a collection, find the media items you would like to include and select them by clicking the selection button in the top left of the poster:

8
docs/user-guide/install.md

@ -1,4 +1,4 @@
ErsatzTV is available as Docker images and as pre-built binary packages for Windows, MacOS and Linux. ErsatzTV is available as Docker images and as pre-built binary packages for Windows (x64), MacOS (x64, arm64) and Linux (x64, arm64, arm).
## Docker Images ## Docker Images
@ -10,7 +10,7 @@ Base (software transcoding): `jasongdove/ersatztv:latest`
Nvidia hardware-accelerated transcoding: `jasongdove/ersatztv:latest-nvidia` Nvidia hardware-accelerated transcoding: `jasongdove/ersatztv:latest-nvidia`
VAAPI hardware-accelerated transcoding: `jasongdove/ersatztv:latest-vaapi` VAAPI (Intel, AMD) hardware-accelerated transcoding: `jasongdove/ersatztv:latest-vaapi`
### Development Tags ### Development Tags
@ -20,7 +20,7 @@ Base (software transcoding): `jasongdove/ersatztv:develop`
Nvidia hardware-accelerated transcoding: `jasongdove/ersatztv:develop-nvidia` Nvidia hardware-accelerated transcoding: `jasongdove/ersatztv:develop-nvidia`
VAAPI hardware-accelerated transcoding: `jasongdove/ersatztv:develop-vaapi` VAAPI (Intel, AMD) hardware-accelerated transcoding: `jasongdove/ersatztv:develop-vaapi`
### Docker ### Docker
@ -44,7 +44,7 @@ docker run -d \
-e TZ=America/Chicago \ -e TZ=America/Chicago \
-p 8409:8409 \ -p 8409:8409 \
-v /path/to/config:/root/.local/share/ersatztv \ -v /path/to/config:/root/.local/share/ersatztv \
-v /path/to/shared/media:/path/to/shared/media:ro \ -v /path/to/local/media:/path/to/local/media:ro \
--restart unless-stopped \ --restart unless-stopped \
jasongdove/ersatztv jasongdove/ersatztv
``` ```

5
mkdocs.yml

@ -16,6 +16,7 @@ theme:
name: material name: material
palette: palette:
scheme: slate scheme: slate
primary: custom
logo: images/ersatztv-square-logo.png logo: images/ersatztv-square-logo.png
favicon: images/favicon-32x32.png favicon: images/favicon-32x32.png
features: features:
@ -37,6 +38,4 @@ extra:
- icon: fontawesome/brands/paypal - icon: fontawesome/brands/paypal
link: https://www.paypal.me/jasongdove link: https://www.paypal.me/jasongdove
name: Donate on PayPal name: Donate on PayPal
google_analytics:
- UA-193031642-1
- auto

Loading…
Cancel
Save