# YumeBox

## 文档

### 开始

- [YumeBox](https://yumebox.gal.tf/index.md)
- [更新日志](https://yumebox.gal.tf/update/history.md)

### 指南

- [快速开始](https://yumebox.gal.tf/guide/quickstart.md)
- [服务配置](https://yumebox.gal.tf/guide/runtime.md)

### 覆写

- [覆写](https://yumebox.gal.tf/override/overview.md)

#### 语法

- [YAML 语法概览](https://yumebox.gal.tf/override/yaml.md)
- [字段行为](https://yumebox.gal.tf/override/yaml/fields.md)
- [列表与规则](https://yumebox.gal.tf/override/yaml/lists.md)
- [示例与排错](https://yumebox.gal.tf/override/yaml/examples.md)
- [JavaScript 语法概览](https://yumebox.gal.tf/override/js-override.md)
- [内置 API](https://yumebox.gal.tf/override/js-override/api.md)
- [示例与排错](https://yumebox.gal.tf/override/js-override/examples.md)

### 更多

- [自定义应用图标](https://yumebox.gal.tf/guide/icon-builder.md)
- [构建](https://yumebox.gal.tf/guide/build.md)
- [FAQ](https://yumebox.gal.tf/guide/faq.md)
- [工作流程](https://yumebox.gal.tf/guide/workflow.md)

## API 参考

### 日志

- [获取实时日志](https://yumebox.gal.tf/api-reference/日志/获取实时日志.md): 获取实时日志.标准模式每行推送一个 JSON（type/payload）；format=structured 时为 time/level/message/fields.

### 流量信息

- [获取实时流量](https://yumebox.gal.tf/api-reference/流量信息/获取实时流量.md): 获取实时流量.GET/WS，每秒推送一次.

### 内存信息

- [获取实时内存占用](https://yumebox.gal.tf/api-reference/内存信息/获取实时内存占用.md): 获取实时内存占用.GET/WS，每秒推送一次.

### 版本信息

- [获取版本信息](https://yumebox.gal.tf/api-reference/版本信息/获取版本信息.md)

### 缓存

- [清除 FakeIP 缓存](https://yumebox.gal.tf/api-reference/缓存/清除-fakeip-缓存.md)
- [清除 DNS 缓存](https://yumebox.gal.tf/api-reference/缓存/清除-dns-缓存.md)

### 运行配置

- [获取基本配置](https://yumebox.gal.tf/api-reference/运行配置/获取基本配置.md): 获取基本配置.返回当前运行配置 JSON，包含 port、socks-port、mixed-port、mode、log-level、allow-lan、ipv6、tun 等字段.
- [重新加载基本配置](https://yumebox.gal.tf/api-reference/运行配置/重新加载基本配置.md): 重新加载基本配置.可选 ?force=true.
- [更新基本配置](https://yumebox.gal.tf/api-reference/运行配置/更新基本配置.md): 更新基本配置.示例：{"mixed-port": 7890}.
- [更新 GEO 数据库](https://yumebox.gal.tf/api-reference/运行配置/更新-geo-数据库.md): 更新 GEO 数据库.
- [重启内核](https://yumebox.gal.tf/api-reference/运行配置/重启内核.md): 重启内核.

### 更新

- [更新内核](https://yumebox.gal.tf/api-reference/更新/更新内核.md): 更新内核.可选 ?channel=xxx、?force=true.
- [更新面板](https://yumebox.gal.tf/api-reference/更新/更新面板.md): 更新面板（须设置 external-ui）.
- [更新 GEO 数据库](https://yumebox.gal.tf/api-reference/更新/更新-geo-数据库.md): 更新 GEO 数据库.

### 策略组

- [获取所有策略组](https://yumebox.gal.tf/api-reference/策略组/获取所有策略组.md)
- [获取指定策略组](https://yumebox.gal.tf/api-reference/策略组/获取指定策略组.md)
- [测试策略组内节点延迟](https://yumebox.gal.tf/api-reference/策略组/测试策略组内节点延迟.md): 对指定策略组内的节点/策略组进行测试，返回新的延迟信息，并清除自动策略组的 fixed 选择.必填 query：url、timeout；可选 expected（如 200-299）.

### 代理

- [获取所有代理](https://yumebox.gal.tf/api-reference/代理/获取所有代理.md): 获取代理信息.返回 { proxies: { name: Proxy } }.策略组额外含 now/all/testUrl/hidden/icon/emptyFallback/expectedStatus/fixed 等字段.
- [获取指定代理](https://yumebox.gal.tf/api-reference/代理/获取指定代理.md)
- [选择代理节点](https://yumebox.gal.tf/api-reference/代理/选择代理节点.md)
- [清除固定选择](https://yumebox.gal.tf/api-reference/代理/清除固定选择.md)
- [测试代理延迟](https://yumebox.gal.tf/api-reference/代理/测试代理延迟.md): 对指定代理进行测试并返回延迟.必填 query：url、timeout；可选 expected.

### 代理集合

- [获取所有代理集合](https://yumebox.gal.tf/api-reference/代理集合/获取所有代理集合.md): 获取所有代理集合的所有信息.
- [获取指定代理集合](https://yumebox.gal.tf/api-reference/代理集合/获取指定代理集合.md): 获取特定代理集合的信息.
- [更新代理集合](https://yumebox.gal.tf/api-reference/代理集合/更新代理集合.md): 更新代理集合.成功返回 HTTP 204.
- [代理集合健康检查](https://yumebox.gal.tf/api-reference/代理集合/代理集合健康检查.md): 触发特定代理集合的健康检查.成功返回 HTTP 204.
- [获取代理集合内指定代理](https://yumebox.gal.tf/api-reference/代理集合/获取代理集合内指定代理.md): 获取代理集合内指定代理的信息.路径形如 /providers/proxies/{providerName}/{name}.
- [测试代理集合内指定代理延迟](https://yumebox.gal.tf/api-reference/代理集合/测试代理集合内指定代理延迟.md): 对代理集合内指定代理进行延迟测试.必填 query：url、timeout.

### 规则

- [获取所有规则](https://yumebox.gal.tf/api-reference/规则/获取所有规则.md): 获取规则信息.
- [临时禁用规则](https://yumebox.gal.tf/api-reference/规则/临时禁用规则.md): 临时禁用规则：key 为规则索引，value 为是否禁用；重启后失效.

### 规则集合

- [获取所有规则集合](https://yumebox.gal.tf/api-reference/规则集合/获取所有规则集合.md): 获取所有规则集合的所有信息.
- [更新规则集合](https://yumebox.gal.tf/api-reference/规则集合/更新规则集合.md): 更新规则集合.成功返回 HTTP 204.

### 连接

- [获取连接信息](https://yumebox.gal.tf/api-reference/连接/获取连接信息.md): 获取连接信息.GET / WebSocket 均按 interval（毫秒，默认 1000）持续推送连接快照.
- [关闭所有连接](https://yumebox.gal.tf/api-reference/连接/关闭所有连接.md): 关闭所有连接.成功返回 HTTP 204.
- [关闭指定连接](https://yumebox.gal.tf/api-reference/连接/关闭指定连接.md): 关闭特定连接.成功返回 HTTP 204.

### 域名查询

- [DNS 查询](https://yumebox.gal.tf/api-reference/域名查询/dns-查询.md): 获取指定名称和类型的 DNS 查询数据.必填 query：name、type（如 A）.

### 存储

- [获取存储值](https://yumebox.gal.tf/api-reference/存储/获取存储值.md): 获取指定 key 的存储值，不存在时返回 null.
- [写入存储值](https://yumebox.gal.tf/api-reference/存储/写入存储值.md): 写入指定 key 的存储值，数据须为合法 JSON，最大 1MB.
- [删除存储值](https://yumebox.gal.tf/api-reference/存储/删除存储值.md): 删除指定 key 的存储值.

### DEBUG

- [主动 GC](https://yumebox.gal.tf/api-reference/debug/主动-gc.md): 进行主动 GC.需内核日志级别为 debug.
- [查看 pprof 调试信息](https://yumebox.gal.tf/api-reference/debug/查看-pprof-调试信息.md): 查看 pprof 调试页面.需内核日志级别为 debug；具体 profile 可从页面进入.

## OpenAPI Specs

- [openapi](/api/openapi.json)

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [English (56 pages)](https://yumebox.gal.tf/_llms/en.md): Documentation for English.
- [Japanese (15 pages)](https://yumebox.gal.tf/_llms/ja.md): Documentation for Japanese.
- [Russian (15 pages)](https://yumebox.gal.tf/_llms/ru.md): Documentation for Russian.