github.com/sagernet/sing-box@v1.9.0-rc.20/docs/configuration/experimental/clash-api.zh.md (about)

     1  !!! quote "sing-box 1.8.0 中的更改"
     2  
     3      :material-delete-alert: [store_mode](#store_mode)  
     4      :material-delete-alert: [store_selected](#store_selected)  
     5      :material-delete-alert: [store_fakeip](#store_fakeip)  
     6      :material-delete-alert: [cache_file](#cache_file)  
     7      :material-delete-alert: [cache_id](#cache_id)
     8  
     9  ### 结构
    10  
    11  ```json
    12  {
    13    "external_controller": "127.0.0.1:9090",
    14    "external_ui": "",
    15    "external_ui_download_url": "",
    16    "external_ui_download_detour": "",
    17    "secret": "",
    18    "default_mode": "",
    19    
    20    // Deprecated
    21    
    22    "store_mode": false,
    23    "store_selected": false,
    24    "store_fakeip": false,
    25    "cache_file": "",
    26    "cache_id": ""
    27  }
    28  ```
    29  
    30  ### Fields
    31  
    32  #### external_controller
    33  
    34  RESTful web API 监听地址。如果为空，则禁用 Clash API。
    35  
    36  #### external_ui
    37  
    38  到静态网页资源目录的相对路径或绝对路径。sing-box 会在 `http://{{external-controller}}/ui` 下提供它。
    39  
    40  #### external_ui_download_url
    41  
    42  静态网页资源的 ZIP 下载 URL，如果指定的 `external_ui` 目录为空，将使用。
    43  
    44  默认使用 `https://github.com/MetaCubeX/Yacd-meta/archive/gh-pages.zip`。
    45  
    46  #### external_ui_download_detour
    47  
    48  用于下载静态网页资源的出站的标签。
    49  
    50  如果为空，将使用默认出站。
    51  
    52  #### secret
    53  
    54  RESTful API 的密钥（可选）
    55  通过指定 HTTP 标头 `Authorization: Bearer ${secret}` 进行身份验证
    56  如果 RESTful API 正在监听 0.0.0.0，请始终设置一个密钥。
    57  
    58  #### default_mode
    59  
    60  Clash 中的默认模式，默认使用 `Rule`。
    61  
    62  此设置没有直接影响，但可以通过 `clash_mode` 规则项在路由和 DNS 规则中使用。
    63  
    64  #### store_mode
    65  
    66  !!! failure "已在 sing-box 1.8.0 废弃"
    67  
    68      `store_mode` 已在 Clash API 中废弃，且默认启用当 `cache_file.enabled`。
    69  
    70  将 Clash 模式存储在缓存文件中。
    71  
    72  #### store_selected
    73  
    74  !!! failure "已在 sing-box 1.8.0 废弃"
    75  
    76      `store_selected` 已在 Clash API 中废弃，且默认启用当 `cache_file.enabled`。
    77  
    78  !!! note ""
    79  
    80      必须为目标出站设置标签。
    81  
    82  将 `Selector` 中出站的选定的目标出站存储在缓存文件中。
    83  
    84  #### store_fakeip
    85  
    86  !!! failure "已在 sing-box 1.8.0 废弃"
    87  
    88      `store_selected` 已在 Clash API 中废弃，且已迁移到 `cache_file.store_fakeip`。
    89  
    90  将 fakeip 存储在缓存文件中。
    91  
    92  #### cache_file
    93  
    94  !!! failure "已在 sing-box 1.8.0 废弃"
    95   
    96      `cache_file` 已在 Clash API 中废弃，且已迁移到 `cache_file.enabled` 和 `cache_file.path`。
    97  
    98  缓存文件路径，默认使用`cache.db`。
    99  
   100  #### cache_id
   101  
   102  !!! failure "已在 sing-box 1.8.0 废弃"
   103   
   104      `cache_id` 已在 Clash API 中废弃，且已迁移到 `cache_file.cache_id`。
   105  
   106  缓存 ID。
   107  
   108  如果不为空，配置特定的数据将使用由其键控的单独存储。