Browse Source

Cleanup and sort NetworkConfiguration

Shadowghost 2 years ago
parent
commit
8075cb4e99
1 changed files with 73 additions and 78 deletions
  1. 73 78
      Jellyfin.Networking/Configuration/NetworkConfiguration.cs

+ 73 - 78
Jellyfin.Networking/Configuration/NetworkConfiguration.cs

@@ -21,21 +21,6 @@ namespace Jellyfin.Networking.Configuration
 
         private string _baseUrl = string.Empty;
 
-        /// <summary>
-        /// Gets or sets a value indicating whether the server should force connections over HTTPS.
-        /// </summary>
-        public bool RequireHttps { get; set; }
-
-        /// <summary>
-        /// Gets or sets the filesystem path of an X.509 certificate to use for SSL.
-        /// </summary>
-        public string CertificatePath { get; set; } = string.Empty;
-
-        /// <summary>
-        /// Gets or sets the password required to access the X.509 certificate data in the file specified by <see cref="CertificatePath"/>.
-        /// </summary>
-        public string CertificatePassword { get; set; } = string.Empty;
-
         /// <summary>
         /// Gets or sets a value used to specify the URL prefix that your Jellyfin instance can be accessed at.
         /// </summary>
@@ -70,16 +55,28 @@ namespace Jellyfin.Networking.Configuration
         }
 
         /// <summary>
-        /// Gets or sets the public HTTPS port.
+        /// Gets or sets a value indicating whether to use HTTPS.
         /// </summary>
-        /// <value>The public HTTPS port.</value>
-        public int PublicHttpsPort { get; set; } = DefaultHttpsPort;
+        /// <remarks>
+        /// In order for HTTPS to be used, in addition to setting this to true, valid values must also be
+        /// provided for <see cref="CertificatePath"/> and <see cref="CertificatePassword"/>.
+        /// </remarks>
+        public bool EnableHttps { get; set; }
 
         /// <summary>
-        /// Gets or sets the HTTP server port number.
+        /// Gets or sets a value indicating whether the server should force connections over HTTPS.
         /// </summary>
-        /// <value>The HTTP server port number.</value>
-        public int HttpServerPortNumber { get; set; } = DefaultHttpPort;
+        public bool RequireHttps { get; set; }
+
+        /// <summary>
+        /// Gets or sets the filesystem path of an X.509 certificate to use for SSL.
+        /// </summary>
+        public string CertificatePath { get; set; } = string.Empty;
+
+        /// <summary>
+        /// Gets or sets the password required to access the X.509 certificate data in the file specified by <see cref="CertificatePath"/>.
+        /// </summary>
+        public string CertificatePassword { get; set; } = string.Empty;
 
         /// <summary>
         /// Gets or sets the HTTPS server port number.
@@ -88,13 +85,16 @@ namespace Jellyfin.Networking.Configuration
         public int HttpsPortNumber { get; set; } = DefaultHttpsPort;
 
         /// <summary>
-        /// Gets or sets a value indicating whether to use HTTPS.
+        /// Gets or sets the public HTTPS port.
         /// </summary>
-        /// <remarks>
-        /// In order for HTTPS to be used, in addition to setting this to true, valid values must also be
-        /// provided for <see cref="CertificatePath"/> and <see cref="CertificatePassword"/>.
-        /// </remarks>
-        public bool EnableHttps { get; set; }
+        /// <value>The public HTTPS port.</value>
+        public int PublicHttpsPort { get; set; } = DefaultHttpsPort;
+
+        /// <summary>
+        /// Gets or sets the HTTP server port number.
+        /// </summary>
+        /// <value>The HTTP server port number.</value>
+        public int HttpServerPortNumber { get; set; } = DefaultHttpPort;
 
         /// <summary>
         /// Gets or sets the public mapped port.
@@ -108,14 +108,19 @@ namespace Jellyfin.Networking.Configuration
         public bool UPnPCreateHttpPortMap { get; set; }
 
         /// <summary>
-        /// Gets or sets the UDPPortRange.
+        /// Gets or sets a value indicating whether Autodiscovery is enabled.
         /// </summary>
-        public string UDPPortRange { get; set; } = string.Empty;
+        public bool AutoDiscovery { get; set; } = true;
 
         /// <summary>
-        /// Gets or sets a value indicating whether IPv6 is enabled or not.
+        /// Gets or sets a value indicating whether Autodiscovery tracing is enabled.
         /// </summary>
-        public bool EnableIPV6 { get; set; }
+        public bool AutoDiscoveryTracing { get; set; }
+
+        /// <summary>
+        /// Gets or sets a value indicating whether to enable automatic port forwarding.
+        /// </summary>
+        public bool EnableUPnP { get; set; }
 
         /// <summary>
         /// Gets or sets a value indicating whether IPv6 is enabled or not.
@@ -123,17 +128,34 @@ namespace Jellyfin.Networking.Configuration
         public bool EnableIPV4 { get; set; } = true;
 
         /// <summary>
-        /// Gets or sets a value indicating whether detailed SSDP logs are sent to the console/log.
-        /// "Emby.Dlna": "Debug" must be set in logging.default.json for this property to have any effect.
+        /// Gets or sets a value indicating whether IPv6 is enabled or not.
         /// </summary>
-        public bool EnableSSDPTracing { get; set; }
+        public bool EnableIPV6 { get; set; }
 
         /// <summary>
-        /// Gets or sets the SSDPTracingFilter
-        /// Gets or sets a value indicating whether an IP address is to be used to filter the detailed ssdp logs that are being sent to the console/log.
-        /// If the setting "Emby.Dlna": "Debug" msut be set in logging.default.json for this property to work.
+        /// Gets or sets a value indicating whether access outside of the LAN is permitted.
         /// </summary>
-        public string SSDPTracingFilter { get; set; } = string.Empty;
+        public bool EnableRemoteAccess { get; set; } = true;
+
+        /// <summary>
+        /// Gets or sets the subnets that are deemed to make up the LAN.
+        /// </summary>
+        public string[] LocalNetworkSubnets { get; set; } = Array.Empty<string>();
+
+        /// <summary>
+        /// Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.
+        /// </summary>
+        public string[] LocalNetworkAddresses { get; set; } = Array.Empty<string>();
+
+        /// <summary>
+        /// Gets or sets the known proxies. If the proxy is a network, it's added to the KnownNetworks.
+        /// </summary>
+        public string[] KnownProxies { get; set; } = Array.Empty<string>();
+
+        /// <summary>
+        /// Gets or sets the UDPPortRange.
+        /// </summary>
+        public string UDPPortRange { get; set; } = string.Empty;
 
         /// <summary>
         /// Gets or sets the number of times SSDP UDP messages are sent.
@@ -156,19 +178,9 @@ namespace Jellyfin.Networking.Configuration
         public string VirtualInterfaceNames { get; set; } = "veth";
 
         /// <summary>
-        /// Gets or sets the time (in seconds) between the pings of SSDP gateway monitor.
-        /// </summary>
-        public int GatewayMonitorPeriod { get; set; } = 60;
-
-        /// <summary>
-        /// Gets a value indicating whether multi-socket binding is available.
-        /// </summary>
-        public bool EnableMultiSocketBinding { get; } = true;
-
-        /// <summary>
-        /// Gets or sets the ports that HDHomerun uses.
+        /// Gets or sets a value indicating whether the published server uri is based on information in HTTP requests.
         /// </summary>
-        public string HDHomerunPortRange { get; set; } = string.Empty;
+        public bool EnablePublishedServerUriByRequest { get; set; } = false;
 
         /// <summary>
         /// Gets or sets the PublishedServerUriBySubnet
@@ -177,14 +189,14 @@ namespace Jellyfin.Networking.Configuration
         public string[] PublishedServerUriBySubnet { get; set; } = Array.Empty<string>();
 
         /// <summary>
-        /// Gets or sets a value indicating whether Autodiscovery tracing is enabled.
+        /// Gets a value indicating whether multi-socket binding is available.
         /// </summary>
-        public bool AutoDiscoveryTracing { get; set; }
+        public bool EnableMultiSocketBinding { get; } = true;
 
         /// <summary>
-        /// Gets or sets a value indicating whether Autodiscovery is enabled.
+        /// Gets or sets the ports that HDHomerun uses.
         /// </summary>
-        public bool AutoDiscovery { get; set; } = true;
+        public string HDHomerunPortRange { get; set; } = string.Empty;
 
         /// <summary>
         /// Gets or sets the filter for remote IP connectivity. Used in conjuntion with <seealso cref="IsRemoteIPFilterBlacklist"/>.
@@ -197,33 +209,16 @@ namespace Jellyfin.Networking.Configuration
         public bool IsRemoteIPFilterBlacklist { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether to enable automatic port forwarding.
-        /// </summary>
-        public bool EnableUPnP { get; set; }
-
-        /// <summary>
-        /// Gets or sets a value indicating whether access outside of the LAN is permitted.
-        /// </summary>
-        public bool EnableRemoteAccess { get; set; } = true;
-
-        /// <summary>
-        /// Gets or sets the subnets that are deemed to make up the LAN.
-        /// </summary>
-        public string[] LocalNetworkSubnets { get; set; } = Array.Empty<string>();
-
-        /// <summary>
-        /// Gets or sets the interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.
-        /// </summary>
-        public string[] LocalNetworkAddresses { get; set; } = Array.Empty<string>();
-
-        /// <summary>
-        /// Gets or sets the known proxies. If the proxy is a network, it's added to the KnownNetworks.
+        /// Gets or sets a value indicating whether detailed SSDP logs are sent to the console/log.
+        /// "Emby.Dlna": "Debug" must be set in logging.default.json for this property to have any effect.
         /// </summary>
-        public string[] KnownProxies { get; set; } = Array.Empty<string>();
+        public bool EnableSSDPTracing { get; set; }
 
         /// <summary>
-        /// Gets or sets a value indicating whether the published server uri is based on information in HTTP requests.
+        /// Gets or sets the SSDPTracingFilter
+        /// Gets or sets a value indicating whether an IP address is to be used to filter the detailed ssdp logs that are being sent to the console/log.
+        /// If the setting "Emby.Dlna": "Debug" msut be set in logging.default.json for this property to work.
         /// </summary>
-        public bool EnablePublishedServerUriByRequest { get; set; } = false;
+        public string SSDPTracingFilter { get; set; } = string.Empty;
     }
 }