Browse Source

unraid doc fixes (#405)

pull/406/head
Jason Dove 4 years ago committed by GitHub
parent
commit
d3086264c7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 15
      ErsatzTV.Application/Streaming/Commands/StartFFmpegSessionHandler.cs
  2. 2
      README.md
  3. BIN
      docs/images/unraid-docker-ersatz-branches.png
  4. BIN
      docs/images/unraid-docker-ersatz-hwtranscoding.png
  5. BIN
      docs/images/unraid-docker-install-ersatz.png
  6. BIN
      docs/images/unraid-docker-media-map.png
  7. BIN
      docs/images/unraid-install-community-apps.png
  8. BIN
      docs/images/unraid-path-to-configuration-data.png
  9. BIN
      docs/images/unraid-path-to-media-share.png
  10. 2
      docs/user-guide/configure-clients.md
  11. 3
      docs/user-guide/create-channels.md
  12. 19
      docs/user-guide/install.md

15
ErsatzTV.Application/Streaming/Commands/StartFFmpegSessionHandler.cs

@ -50,16 +50,9 @@ namespace ErsatzTV.Application.Streaming.Commands @@ -50,16 +50,9 @@ namespace ErsatzTV.Application.Streaming.Commands
return Unit.Default;
}
private async Task<Validation<BaseError, Unit>> Validate(StartFFmpegSession request)
{
Validation<BaseError, Unit> existResult = await ProcessMustNotExist(request);
if (existResult.IsFail)
{
return existResult;
}
return await FolderMustBeEmpty(request);
}
private Task<Validation<BaseError, Unit>> Validate(StartFFmpegSession request) =>
ProcessMustNotExist(request)
.BindT(_ => FolderMustBeEmpty(request));
private Task<Validation<BaseError, Unit>> ProcessMustNotExist(StartFFmpegSession request) =>
Optional(_ffmpegSegmenterService.ProcessExistsForChannel(request.ChannelNumber))
@ -71,7 +64,7 @@ namespace ErsatzTV.Application.Streaming.Commands @@ -71,7 +64,7 @@ namespace ErsatzTV.Application.Streaming.Commands
private Task<Validation<BaseError, Unit>> FolderMustBeEmpty(StartFFmpegSession request)
{
string folder = Path.Combine(FileSystemLayout.TranscodeFolder, request.ChannelNumber);
_logger.LogInformation("Preparing transcode folder {Folder}", folder);
_logger.LogDebug("Preparing transcode folder {Folder}", folder);
_localFileSystem.EnsureFolderExists(folder);
_localFileSystem.EmptyFolder(folder);

2
README.md

@ -1,6 +1,6 @@ @@ -1,6 +1,6 @@
# ErsatzTV
**ErsatzTV** is pre-alpha software for configuring and streaming custom live channels using your media library. The software is currently unstable and under active development.
**ErsatzTV** is alpha software for configuring and streaming custom live channels using your media library. The software is currently unstable and under active development.
Documentation is available at [ersatztv.org](https://ersatztv.org/).

BIN
docs/images/unraid-docker-ersatz-branches.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

After

Width:  |  Height:  |  Size: 57 KiB

BIN
docs/images/unraid-docker-ersatz-hwtranscoding.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 191 KiB

After

Width:  |  Height:  |  Size: 152 KiB

BIN
docs/images/unraid-docker-install-ersatz.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 602 KiB

After

Width:  |  Height:  |  Size: 510 KiB

BIN
docs/images/unraid-docker-media-map.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

BIN
docs/images/unraid-install-community-apps.png

Binary file not shown.

Before

Width:  |  Height:  |  Size: 315 KiB

After

Width:  |  Height:  |  Size: 268 KiB

BIN
docs/images/unraid-path-to-configuration-data.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

BIN
docs/images/unraid-path-to-media-share.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

2
docs/user-guide/configure-clients.md

@ -15,6 +15,8 @@ For all clients, the `M3U` and/or the `XMLTV` urls are needed and can be copied @@ -15,6 +15,8 @@ For all clients, the `M3U` and/or the `XMLTV` urls are needed and can be copied
A [Plex Pass](https://www.plex.tv/plex-pass/) is required for ErsatzTV to work with Plex.
The only channel streaming mode supported directly by Plex clients is `MPEG-TS`.
### Add DVR
From Plex Settings, click `Live TV & DVR` and `Set Up Plex DVR` to add a new DVR.

3
docs/user-guide/create-channels.md

@ -8,11 +8,12 @@ Channel numbers can be whole numbers or can contain one decimal, like `500` or ` @@ -8,11 +8,12 @@ Channel numbers can be whole numbers or can contain one decimal, like `500` or `
### Streaming Mode
Three streaming modes are currently supported: `MPEG-TS` (Transport Stream), `HLS Direct` (HTTP Live Streaming Direct) and `HLS Hybrid` (HTTP Live Streaming Hybrid).
Four streaming modes are currently supported: `MPEG-TS` (Transport Stream), `HLS Direct` (HTTP Live Streaming Direct), `HLS Hybrid` (HTTP Live Streaming Hybrid) and `HLS Segmenter` (HTTP Live Streaming Segmenter).
* `MPEG-TS` transcodes content and supports watermarks, though some clients will have issues at program boundaries
* `HLS Direct` does not transcode content and can perform better on low power systems, but does not support watermarks and some clients will have issues at program boundaries
* `HLS Hybrid` transcodes content and supports watermarks, and can perform very well at program boundaries with some clients
* `HLS Segmenter` is currently *experimental*, and is the only "proper" HLS mode. It transcodes content, supports watermarks and offers the best performance at program boundaries.
### FFmpeg Profile

19
docs/user-guide/install.md

@ -58,20 +58,29 @@ https://raw.githubusercontent.com/Squidly271/community.applications/master/plugi @@ -58,20 +58,29 @@ https://raw.githubusercontent.com/Squidly271/community.applications/master/plugi
```
![Community Applications Install](../images/unraid-install-community-apps.png)
2. Click on the `Apps` tab in UnRAID, search for `ersatztv`, and click the `install` button.
![Search Community Applications ErsatzTV](../images/unraid-docker-install-ersatz.png)
3. Choose an appropriate branch (Use `vaapi` for video acceleration for AMD GPUs and Intel CPUs with QuickSync, use `nvidia` for video acceleration for nVidia GPUs)
![ErsatzTV Docker branches](../images/unraid-docker-ersatz-branches.png)
<div align="center">`VAAPI` and `nVidia` branches are for hardware acceleration. See [latest release tags](install.md#latest-release-tags)</div>
4. Map your path to shared media
`VAAPI` and `nVidia` branches are for hardware acceleration. See [latest release tags](install.md#latest-release-tags)
4. Map your path to ErsatzTV configuration data
![Media Mapping](../images/unraid-path-to-configuration-data.png)
![Media Mapping](../images/unraid-docker-media-map.png)
5. <B>OPTIONAL</B> In advanced view, add extra parameters for video acceleration. **NOTE** The [nVidia-Driver plugin](https://forums.unraid.net/topic/98978-plugin-nvidia-driver/) must be installed prior to this step.
5. Add another path for each media share
![Media Mapping](../images/unraid-path-to-media-share.png)
6. **OPTIONAL** In advanced view, add extra parameters for video acceleration. **NOTE** The [nVidia-Driver plugin](https://forums.unraid.net/topic/98978-plugin-nvidia-driver/) must be installed prior to this step.
![Adding video acceleration options](../images/unraid-docker-ersatz-hwtranscoding.png)
6. Open your browser to `http://[docker-ip]:8409` (First run may take a few minutes to be available.)
7. Open your browser to `http://[docker-ip]:8409` (First run may take a few minutes to be available.)
## Windows

Loading…
Cancel
Save