unraid doc fixes (#405)

ErsatzTV.Application/Streaming/Commands/StartFFmpegSessionHandler.cs

@@ -50,16 +50,9 @@ namespace ErsatzTV.Application.Streaming.Commands
             return Unit.Default;
         }
 
-        private async Task<Validation<BaseError, Unit>> Validate(StartFFmpegSession request)
+        private Task<Validation<BaseError, Unit>> Validate(StartFFmpegSession request) =>
-        {
+            ProcessMustNotExist(request)
-            Validation<BaseError, Unit> existResult = await ProcessMustNotExist(request);
+                .BindT(_ => FolderMustBeEmpty(request));
-            if (existResult.IsFail)
-            {
-                return existResult;
-            }
-
-            return await FolderMustBeEmpty(request);
-        }
 
         private Task<Validation<BaseError, Unit>> ProcessMustNotExist(StartFFmpegSession request) =>
             Optional(_ffmpegSegmenterService.ProcessExistsForChannel(request.ChannelNumber))
@@ -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);

README.md

@@ -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/).
 

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
 
 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.

docs/user-guide/create-channels.md

@@ -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
 

docs/user-guide/install.md

@@ -51,27 +51,36 @@ docker run -d \
 
 ### Unraid Docker
 
- 1. Install the Commuinity Applications plugin by pasting the following URL in the Plugins / Install Plugin section of UnRAID  
+1. Install the Commuinity Applications plugin by pasting the following URL in the Plugins / Install Plugin section of UnRAID  
 
-```
+    ```
-https://raw.githubusercontent.com/Squidly271/community.applications/master/plugins/community.applications.plg
+    https://raw.githubusercontent.com/Squidly271/community.applications/master/plugins/community.applications.plg
-```  
+    ```  
+
+    ![Community Applications Install](../images/unraid-install-community-apps.png)
 
- ![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)
+    ![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)
+    ![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>
+    `VAAPI` and `nVidia` branches are for hardware acceleration. See [latest release tags](install.md#latest-release-tags)
-4. Map your path to shared media
+
+4. Map your path to ErsatzTV configuration data
+
+    ![Media Mapping](../images/unraid-path-to-configuration-data.png)
+
+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.
 
-![Media Mapping](../images/unraid-docker-media-map.png)
+    ![Adding video acceleration options](../images/unraid-docker-ersatz-hwtranscoding.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.
 
-![Adding video acceleration options](../images/unraid-docker-ersatz-hwtranscoding.png)
+7. Open your browser to `http://[docker-ip]:8409` (First run may take a few minutes to be available.)
-6. Open your browser to `http://[docker-ip]:8409` (First run may take a few minutes to be available.)
 
 ## Windows