Skip to content

Commit

Permalink
更新
Browse files Browse the repository at this point in the history
  • Loading branch information
xishang0128 committed Apr 7, 2024
1 parent 25db100 commit 9bec024
Show file tree
Hide file tree
Showing 7 changed files with 89 additions and 46 deletions.
32 changes: 24 additions & 8 deletions docs/config/proxy-providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,19 @@ proxy-providers:
url: "http://test.com"
path: ./proxy_providers/provider1.yaml
interval: 3600
proxy: DIRECT
header:
User-Agent:
- "Clash/v1.18.0"
- "mihomo/1.18.3"
Authorization:
- 'token 1231231'
health-check:
enable: true
url: https://www.gstatic.com/generate_204
interval: 300
timeout: 5000
lazy: true
expected-status: 204
override:
skip-cert-verify: true
Expand Down Expand Up @@ -59,15 +67,23 @@ proxy-providers:

更新`provider`的时间,单位为秒

## proxy

经过指定代理进行下载/更新

## header

自定义 http 请求头

## health-check

健康检查 (延迟测试)

### enable
### health-check.enable

是否启用,可选 `true/false`

### url
### health-check.url

健康检查地址,推荐使用以下地址之一

Expand All @@ -81,31 +97,31 @@ proxy-providers:
https://www.gstatic.com/generate_204
```

### interval
### health-check.interval

健康检查间隔时间,单位为秒

### timeout
### health-check.timeout

健康检查超时时间,单位为毫秒

## lazy
### health-check.lazy

懒惰状态,默认为`true`,不使用该集合节点时,不进行测试

### expected-status
### health-check.expected-status

参阅 [期望状态](../proxy-groups/index.md#expected-status)

## override

覆写节点内容,以下为支持的字段

### additional-prefix
### override.additional-prefix

为节点名称添加固定前缀

### additional-suffix
### override.additional-suffix

为节点名称添加固定后缀

Expand Down
5 changes: 5 additions & 0 deletions docs/config/rule-providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ rule-providers:
path: ./rule1.yaml
url: "https://raw.githubusercontent.com/../Google.yaml"
interval: 600
proxy: DIRECT
behavior: classical
format: yaml
```
Expand All @@ -33,6 +34,10 @@ rule-providers:

更新`provider`的时间,单位为秒

## proxy

经过指定代理进行下载/更新

## behavior

`behavior`参数有三种可选项:`domain` / `ipcidr` / `classical`,对应不同格式的 rule-set 文件格式,请按实际格式填写
Expand Down
File renamed without changes.
35 changes: 35 additions & 0 deletions docs/faq/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
hide:
# - navigation
- toc
---
# 常见问题

## alpha 和 meta 分支的区别

alpha 分支为最新提交分支,meta 分支每隔一段时间合并 alpha 分支的代码,meta 分支不一定比 alpha 分支更稳定。

## 我应该下载哪一个文件?

release 中,包的文件名中包含了多个信息,包括

* 程序名称(clash.meta)
* 操作系统(如 android、darwin、freebsd、linux、windows 等)
* 架构(如 386、amd64、arm32v7、arm64 等)
* 编译方式
>
> * `默认(无额外标识)`: 使用 GOAMD64=v3 标签编译的默认版本
> * `compatible`: 使用 GOAMD64=v1 标签进行编译。该版本是为了兼容特定的操作系统或架构而编译的。
> * `go120`: 使用 Golang1.20 版本进行编译。该版本是为了兼容特定的操作系统或架构而编译的。
> * `abi1/2`: `loongarch64`的 abi 版本
>
* 分支(alpha)
* 提交的 git hash 值(如 f90066f)

可以根据这些信息选择你需要下载的可执行文件。

👉[在此了解](https://github.com/golang/go/wiki/MinimumRequirements#amd64)更多关于 GOAMD64 标签的信息

👉[在此了解](https://go.dev/doc/go1.20#ports)更多关于 Golang1.20 版本的系统兼容性信息

👉[在此了解](http://www.loongnix.cn/zh/toolchain/Golang/downloads-Go1.21/index.html)更多关于`loongarch64`abi 版本的信息
22 changes: 21 additions & 1 deletion docs/faq/in.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,30 @@

## 流量传入的方式

代理软件基本上只有三种流量传入的方式,按接管流量的顺序区分,分别是 代理端口 / 透明代理 / 虚拟网卡
代理软件基本上只有三种流量传入的方式,按接管流量的顺序区分,分别是 代理端口 / 透明代理 / 虚拟网卡,处理效率在正常情况下顺序也是如此

### 代理端口

几乎所有代理软件都可以在本地监听一个代理端口用于接收流量,一般是 http 或者 socks5,用于本地的流量传输

代理端口一般配置于需要代理的软件之中,或者配置为系统代理,让软件直接使用系统代理

代理端口一般都可接受 IP 或者 FQDN (fully qualified domain name,完全限定域名) 入站

### 透明代理

透明代理是一种网络代理服务,其主要功能是在不需要客户端进行任何设置或配置的情况下,自动拦截并转发所有的网络请求。

在透明代理中,用户的网络流量被重定向到透明代理端口,而用户无需手动更改网络设置或配置任何代理信息。

透明代理会自动处理用户的网络请求,然后将其转发到目标服务器,并将响应再返回给用户,而用户对此过程是无感知的

透明代理端口只能接受 IP 入站,不能接受 FQDN (域名) 入站

透明代理需自行配置转发,自行学习 iptables/nftables 等

### 虚拟网卡

虚拟网卡是一种软件定义的网络设备,它允许用户空间程序通过标准网络套接字 API 与内核进行通信,实现对网络数据包的读取和发送

由于虚拟网卡是三层设备,所以只能接受 IP 入站,不能接受 FQDN (域名) 入站
36 changes: 1 addition & 35 deletions docs/faq/index.md
Original file line number Diff line number Diff line change
@@ -1,35 +1 @@
---
hide:
# - navigation
- toc
---
# 常见问题

## alpha 和 meta 分支的区别

alpha 分支为最新提交分支,meta 分支每隔一段时间合并 alpha 分支的代码,meta 分支不一定比 alpha 分支更稳定。

## 我应该下载哪一个文件?

release 中,包的文件名中包含了多个信息,包括

* 程序名称(clash.meta)
* 操作系统(如 android、darwin、freebsd、linux、windows 等)
* 架构(如 386、amd64、arm32v7、arm64 等)
* 编译方式
>
> * `默认(无额外标识)`: 使用 GOAMD64=v3 标签编译的默认版本
> * `compatible`: 使用 GOAMD64=v1 标签进行编译。该版本是为了兼容特定的操作系统或架构而编译的。
> * `go120`: 使用 Golang1.20 版本进行编译。该版本是为了兼容特定的操作系统或架构而编译的。
> * `abi1/2`: `loongarch64`的 abi 版本
>
* 分支(alpha)
* 提交的 git hash 值(如 f90066f)

可以根据这些信息选择你需要下载的可执行文件。

👉[在此了解](https://github.com/golang/go/wiki/MinimumRequirements#amd64)更多关于 GOAMD64 标签的信息

👉[在此了解](https://go.dev/doc/go1.20#ports)更多关于 Golang1.20 版本的系统兼容性信息

👉[在此了解](http://www.loongnix.cn/zh/toolchain/Golang/downloads-Go1.21/index.html)更多关于`loongarch64`abi 版本的信息
# 画饼
5 changes: 3 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,9 @@ nav:
- 创建运行服务: startup/service/index.md
- 第三方工具: startup/client/client.md
- 手册:
- 常见问题: faq/index.md
- 关于fakeip: faq/fakeip.md
- faq/index.md
- 常见问题: faq/faq.md
- 关于 fakeip: faq/fakeip.md
- 大致工作流程:
- 流量入站: faq/in.md
- 流量处理: faq/route.md
Expand Down

0 comments on commit 9bec024

Please sign in to comment.