sing-box/docs/configuration/experimental/index.md

112 lines
2.2 KiB
Markdown
Raw Normal View History

2022-08-25 13:08:29 +00:00
# Experimental
2022-07-19 23:36:06 +00:00
### Structure
```json
{
"experimental": {
"clash_api": {
"external_controller": "127.0.0.1:9090",
"external_ui": "folder",
2022-09-10 14:42:20 +00:00
"secret": "",
2022-10-01 03:48:46 +00:00
"direct_io": false,
2022-09-10 14:42:20 +00:00
"default_mode": "rule",
"store_selected": false,
"cache_file": "cache.db"
2022-10-01 03:48:46 +00:00
},
"v2ray_api": {
"listen": "127.0.0.1:8080",
"stats": {
"enabled": true,
"direct_io": false,
"inbounds": [
"socks-in"
],
"outbounds": [
"proxy",
"direct"
]
}
2022-07-19 23:36:06 +00:00
}
}
}
```
2022-10-01 03:48:46 +00:00
!!! note ""
Traffic statistics and connection management can degrade performance.
2022-07-19 23:36:06 +00:00
### Clash API Fields
!!! error ""
2022-08-23 15:15:56 +00:00
Clash API is not included by default, see [Installation](/#installation).
2022-07-19 23:36:06 +00:00
#### external_controller
2022-09-10 14:42:20 +00:00
RESTful web API listening address. Clash API will be disabled if empty.
2022-07-19 23:36:06 +00:00
#### external_ui
A relative path to the configuration directory or an absolute path to a
directory in which you put some static web resource. sing-box will then
2022-07-19 23:36:06 +00:00
serve it at `http://{{external-controller}}/ui`.
#### secret
Secret for the RESTful API (optional)
Authenticate by spedifying HTTP header `Authorization: Bearer ${secret}`
2022-09-10 14:42:20 +00:00
ALWAYS set a secret if RESTful API is listening on 0.0.0.0
2022-10-01 03:48:46 +00:00
#### direct_io
Allows lossless relays like splice without real-time traffic reporting.
2022-09-10 14:42:20 +00:00
#### default_mode
Default mode in clash, `rule` will be used if empty.
This setting has no direct effect, but can be used in routing and DNS rules via the `clash_mode` rule item.
#### store_selected
!!! note ""
The tag must be set for target outbounds.
Store selected outbound for the `Selector` outbound in cache file.
#### cache_file
2022-10-01 03:48:46 +00:00
Cache file path, `cache.db` will be used if empty.
### V2Ray API Fields
!!! error ""
V2Ray API is not included by default, see [Installation](/#installation).
#### listen
gRPC API listening address. V2Ray API will be disabled if empty.
#### stats
Traffic statistics service settings.
#### stats.enabled
Enable statistics service.
#### stats.direct_io
Allows lossless relays like splice without real-time traffic reporting.
#### stats.inbounds
Inbound list to count traffic.
#### stats.outbounds
Outbound list to count traffic.