Add documentation for clash_api

This commit is contained in:
世界
2022-07-20 07:36:06 +08:00
parent 6ac1b395cf
commit 45643fbed1
6 changed files with 72 additions and 10 deletions

View File

@@ -0,0 +1,39 @@
### Structure
```json
{
"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