Milky 相关配置

Milky.AccessToken

• 类型: string?
• 默认值: null

Milky 服务用于验证的 Token
设置为 null 关闭验证

{
    "Milky": {
        "AccessToken": null
    }
}

Milky.HttpServer.Host

• 类型: string

Milky 服务监听的地址
基于 C# HttpListener 的 Prefix
因此监听所有接口应使用 "*" 或 "+" 而不是 "0.0.0.0" 具体参考 Microsoft Learn - System.Net.HttpListener
大部分使用使用 "*" 即可

注意

在 Windows 中, 监听所有接口需要管理员权限

在非 Windows 中, 监听的 Host 必须和请求的 Host 请求头一致 (如访问 localhost 则必须设置监听 localhost) 这是因为 C# HttpListener 的设置, 但你可以设置 "*", "+" 或者使用 nginx 等代理技术规避

{
    "Milky": {
        "HttpServer": {
            "Host": "127.0.0.1"
        }
    }
}

Milky.HttpServer.Port

• 类型: number

Milky 服务监听的端口

{
    "Milky": {
        "HttpServer":{
            "Port": 3000
        }
    }
}

Milky.Api.Http.Enabled

• 类型: boolean
• 默认值: false

是否开启 Api 的 Http 服务
必须显示设置开启才会监听对应路径

{
    "Milky": {
        "Api": {
            "Http": {
                "Enabled": false
            }
        }
    }
}

Milky.Api.Http.AllowCorsOrigins

• 类型: string?
• 默认值: null

Api 的 Http 服务提供服务时带上的 Access-Control-Allow-Origin 头
设置为 null 时不会带上

{
    "Milky": {
        "Api": {
            "Http": {
                "AllowCorsOrigins": null
            }
        }
    }
}

Milky.Event.WebSocket.Enabled

• 类型: boolean
• 默认值: false

是否开启 Event 的 WebSocket 服务
必须显示设置开启才会监听对应路径

{
    "Milky": {
        "Event": {
            "WebSocket": {
                "Enabled": false
            }
        }
    }
}

Milky.Event.SSE.Enabled

• 类型: boolean
• 默认值: false

是否开启 Event 的 SSE 服务
必须显示设置开启才会监听对应路径

{
    "Milky": {
        "Event": {
            "SSE": {
                "Enabled": false
            }
        }
    }
}

Milky.Event.SSE.AllowCorsOrigins

• 类型: string?
• 默认值: null

Event 的 SSE 服务提供服务时带上的 Access-Control-Allow-Origin 头
设置为 null 时不会带上

{
    "Milky": {
        "Event": {
            "SSE": {
                "AllowCorsOrigins": null
            }
        }
    }
}

Milky.Event.SSE.HeartbeatIntervalSeconds

• 类型: ulong
• 默认值: 60

Event 的 SSE 服务会发送注释消息用作心跳, 无法关闭

{
    "Milky": {
        "Event": {
            "SSE": {
                "HeartbeatIntervalSeconds": 60
            }
        }
    }
}

Milky.Event.WebHook.Enabled

• 类型: boolean
• 默认值: false

是否开启 Event 的 WebHook 服务
必须显示设置开启才会发送请求

{
    "Milky": {
        "Event": {
            "WebHook": {
                "Enabled": false
            }
        }
    }
}

Milky.Event.WebHook.TargetUrls

• 类型: string[]
• 默认值: []

Event 的 WebHook 服务请求的地址

{
    "Milky": {
        "Event": {
            "WebHook": {
                "TargetUrls": []
            }
        }
    }
}