From 387fa474aa8ee8e237648ab0ea3130b8b35cf92f Mon Sep 17 00:00:00 2001
From: Mark Monteiro <marknr.monteiro@protonmail.com>
Date: Thu, 2 Apr 2020 17:45:33 -0400
Subject: Document HTTPS configuration options

---
 Emby.Server.Implementations/HttpServer/HttpListenerHost.cs | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'Emby.Server.Implementations/HttpServer')

diff --git a/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs b/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs
index e3f8ec014..dc542af78 100644
--- a/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs
+++ b/Emby.Server.Implementations/HttpServer/HttpListenerHost.cs
@@ -420,6 +420,10 @@ namespace Emby.Server.Implementations.HttpServer
             return true;
         }
 
+        /// <summary>
+        /// Validate a connection from a remote IP address to a URL to see if a redirection to HTTPS is required.
+        /// </summary>
+        /// <returns>True if the request is valid, or false if the request is not valid and an HTTPS redirect is required.</returns>
         private bool ValidateSsl(string remoteIp, string urlString)
         {
             if (_config.Configuration.RequireHttps && _appHost.ListenWithHttps)
-- 
cgit v1.2.3