jellyfin-model/org.jellyfin.sdk.model.api/NetworkConfiguration

NetworkConfiguration

@Serializable

data class NetworkConfiguration(val baseUrl: String, val enableHttps: Boolean, val requireHttps: Boolean, val certificatePath: String, val certificatePassword: String, val internalHttpPort: Int, val internalHttpsPort: Int, val publicHttpPort: Int, val publicHttpsPort: Int, val autoDiscovery: Boolean, val enableUPnP: Boolean, val enableIPv4: Boolean, val enableIPv6: Boolean, val enableRemoteAccess: Boolean, val localNetworkSubnets: List<String>, val localNetworkAddresses: List<String>, val knownProxies: List<String>, val ignoreVirtualInterfaces: Boolean, val virtualInterfaceNames: List<String>, val enablePublishedServerUriByRequest: Boolean, val publishedServerUriBySubnet: List<String>, val remoteIpFilter: List<String>, val isRemoteIpFilterBlacklist: Boolean)

Defines the MediaBrowser.Common.Net.NetworkConfiguration.

Constructors

constructor(baseUrl: String, enableHttps: Boolean, requireHttps: Boolean, certificatePath: String, certificatePassword: String, internalHttpPort: Int, internalHttpsPort: Int, publicHttpPort: Int, publicHttpsPort: Int, autoDiscovery: Boolean, enableUPnP: Boolean, enableIPv4: Boolean, enableIPv6: Boolean, enableRemoteAccess: Boolean, localNetworkSubnets: List<String>, localNetworkAddresses: List<String>, knownProxies: List<String>, ignoreVirtualInterfaces: Boolean, virtualInterfaceNames: List<String>, enablePublishedServerUriByRequest: Boolean, publishedServerUriBySubnet: List<String>, remoteIpFilter: List<String>, isRemoteIpFilterBlacklist: Boolean)

Properties

autoDiscovery

@SerialName(value = "AutoDiscovery")

val autoDiscovery: Boolean

A value indicating whether Autodiscovery is enabled.

baseUrl

@SerialName(value = "BaseUrl")

val baseUrl: String

A value used to specify the URL prefix that your Jellyfin instance can be accessed at.

certificatePassword

@SerialName(value = "CertificatePassword")

val certificatePassword: String

The password required to access the X.509 certificate data in the file specified by MediaBrowser.Common.Net.NetworkConfiguration.CertificatePath.

certificatePath

@SerialName(value = "CertificatePath")

val certificatePath: String

The filesystem path of an X.509 certificate to use for SSL.

enableHttps

@SerialName(value = "EnableHttps")

val enableHttps: Boolean

A value indicating whether to use HTTPS.

enableIPv4

@SerialName(value = "EnableIPv4")

val enableIPv4: Boolean

A value indicating whether IPv6 is enabled.

enableIPv6

@SerialName(value = "EnableIPv6")

val enableIPv6: Boolean

A value indicating whether IPv6 is enabled.

enablePublishedServerUriByRequest

@SerialName(value = "EnablePublishedServerUriByRequest")

val enablePublishedServerUriByRequest: Boolean

A value indicating whether the published server uri is based on information in HTTP requests.

enableRemoteAccess

@SerialName(value = "EnableRemoteAccess")

val enableRemoteAccess: Boolean

A value indicating whether access from outside of the LAN is permitted.

enableUPnP

@SerialName(value = "EnableUPnP")

val ~~enableUPnP~~: Boolean

A value indicating whether to enable automatic port forwarding.

ignoreVirtualInterfaces

@SerialName(value = "IgnoreVirtualInterfaces")

val ignoreVirtualInterfaces: Boolean

A value indicating whether address names that match MediaBrowser.Common.Net.NetworkConfiguration.VirtualInterfaceNames should be ignored for the purposes of binding.

internalHttpPort

@SerialName(value = "InternalHttpPort")

val internalHttpPort: Int

The internal HTTP server port.

internalHttpsPort

@SerialName(value = "InternalHttpsPort")

val internalHttpsPort: Int

The internal HTTPS server port.

isRemoteIpFilterBlacklist

@SerialName(value = "IsRemoteIPFilterBlacklist")

val isRemoteIpFilterBlacklist: Boolean

A value indicating whether P:MediaBrowser.Common.Net.NetworkConfiguration.RemoteIPFilter contains a blacklist or a whitelist. Default is a whitelist.

knownProxies

@SerialName(value = "KnownProxies")

val knownProxies: List<String>

The known proxies.

localNetworkAddresses

@SerialName(value = "LocalNetworkAddresses")

val localNetworkAddresses: List<String>

The interface addresses which Jellyfin will bind to. If empty, all interfaces will be used.

localNetworkSubnets

@SerialName(value = "LocalNetworkSubnets")

val localNetworkSubnets: List<String>

The subnets that are deemed to make up the LAN.

publicHttpPort

@SerialName(value = "PublicHttpPort")

val publicHttpPort: Int

The public HTTP port.

publicHttpsPort

@SerialName(value = "PublicHttpsPort")

val publicHttpsPort: Int

The public HTTPS port.

publishedServerUriBySubnet

@SerialName(value = "PublishedServerUriBySubnet")

val publishedServerUriBySubnet: List<String>

Gets or sets the PublishedServerUriBySubnet Gets or sets PublishedServerUri to advertise for specific subnets.

remoteIpFilter

@SerialName(value = "RemoteIPFilter")

val remoteIpFilter: List<String>

The filter for remote IP connectivity. Used in conjunction with P:MediaBrowser.Common.Net.NetworkConfiguration.IsRemoteIPFilterBlacklist.

requireHttps

@SerialName(value = "RequireHttps")

val requireHttps: Boolean

A value indicating whether the server should force connections over HTTPS.

virtualInterfaceNames

@SerialName(value = "VirtualInterfaceNames")

val virtualInterfaceNames: List<String>

A value indicating the interface name prefixes that should be ignored. The list can be comma separated and values are case-insensitive. P:MediaBrowser.Common.Net.NetworkConfiguration.IgnoreVirtualInterfaces.