2022-07-20 07:36:06 +08:00
|
|
|
### Structure
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
"experimental": {
|
|
|
|
|
"clash_api": {
|
|
|
|
|
"external_controller": "127.0.0.1:9090",
|
|
|
|
|
"external_ui": "folder",
|
|
|
|
|
"secret": ""
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Clash API Fields
|
|
|
|
|
|
|
|
|
|
!!! error ""
|
|
|
|
|
|
2022-08-23 23:15:56 +08:00
|
|
|
Clash API is not included by default, see [Installation](/#installation).
|
2022-07-20 07:36:06 +08:00
|
|
|
|
|
|
|
|
!!! 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
|
2022-08-24 16:23:21 +08:00
|
|
|
directory in which you put some static web resource. sing-box will then
|
2022-07-20 07:36:06 +08:00
|
|
|
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
|
