request: document unix socket binding

[sielicki]

unix socket binding was added in jellyfin/jellyfin#3532 (and extended in further commits(?)) by @daullmer, but requires setting specific Kestrel environment variables which are not immediately obvious. Document this properly.

[sielicki]

        /// <summary>
        /// The key for a setting that indicates whether kestrel should bind to a unix socket.
        /// </summary>
        public const string BindToUnixSocketKey = "kestrel:socket";

        /// <summary>
        /// The key for the unix socket path.
        /// </summary>
        public const string UnixSocketPathKey = "kestrel:socketPath";

        /// <summary>
        /// The permissions for the unix socket.
        /// </summary>
        public const string UnixSocketPermissionsKey = "kestrel:socketPermissions";

jellyfin/MediaBrowser.Controller/Extensions/ConfigurationExtensions.cs                                                                                                                      ```

[sielicki]

Per https://jellyfin.org/docs/general/administration/configuration/

Environment variables: The documentation provided by Microsoft explains how to set these configuration options via environment variables. Jellyfin uses its own custom JELLYFIN_ prefix for these variables. For example, to set a value for the HttpListenerHost:DefaultRedirectPath setting, you would set a value for the JELLYFIN_HttpListenerHost__DefaultRedirectPath environment variable.

So the above would be:

• JELLYFIN_kestrel__socketPermissions
• JELLYFIN_kestrel__socketPath
• JELLYFIN_kestrel__socket

Not immediately obvious what values are expected to bind here and how parsing works, though. Is it JELLYFIN_kestrel__socket=1? JELLYFIN_kestrel__socket=YES? JELLYFIN_kestrel__socket=true? JELLYFIN_kestrel__socketPermissions=0777? etc.

[sielicki]

    "JELLYFIN_kestrel__socketPermissions=0777"
    "JELLYFIN_kestrel__socketPath=${socketPath}"
    "JELLYFIN_kestrel__socket=true"

This is what is working for me.

[felix920506]

Hi, Please just make the edits and submit a PR to this repo if you already got it to work.