black-internet-days-ahead/sing-box
1
0
Fork 0
mirror of https://github.com/SagerNet/sing-box.git synced 2024-11-28 19:41:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
sing-box/docs/configuration/experimental.md
世界 45643fbed1
Add documentation for clash_api
2022-07-20 07:37:50 +08:00

912 B
Raw Blame History

Structure

{
  "experimental": {
    "clash_api": {
      "external_controller": "127.0.0.1:9090",
      "external_ui": "folder",
      "secret": ""
    }
  }
}

Clash API Fields

!!! error ""

Clash API is not included by default, see [Installation](/#Installation).

!!! note ""

Traffic statistics and connection management will disable TCP splice in linux and reduce performance, use at your own risk.

external_controller

RESTful web API listening address. Disabled if empty.

external_ui

A relative path to the configuration directory or an absolute path to a directory in which you put some static web resource. Clash core will then serve it at http://{{external-controller}}/ui.

secret

Secret for the RESTful API (optional) Authenticate by spedifying HTTP header Authorization: Bearer ${secret} ALWAYS set a secret if RESTful API is listening on 0.0.0.0