doc: 更新加速服务使用说明，添加配置示例 from @8odream
cute-omega
parent
4d6be465c7
commit
1eca6cbc9d
|
|
@ -26,28 +26,91 @@
|
|||
## 4.1. 拦截器类型：
|
||||
|
||||
### 1）请求拦截器：
|
||||
| 请求拦截器名称 | 拦截器配置名 | 请求拦截优先级 | 作用 |
|
||||
| ----------------- | -------------- | ------------- | --------- |
|
||||
| OPTIONS请求拦截器 | options | 101 | 直接响应200，不发送该OPTIONS请求 |
|
||||
| 快速成功拦截器 | success | 102 | 直接响应200，不发送该请求 |
|
||||
| 快速失败拦截器 | abort | 103 | 直接响应403，不发送该请求 |
|
||||
| 缓存请求拦截器 | cacheXxx | 104 | 如果缓存还生效，直接响应304，不发送该请求<br>如果缓存已过期或无缓存，则发送请求<br>注：只对GET请求生效！ |
|
||||
| 重定向拦截器 | redirect | 105 | 重定向到指定地址，直接响应302，不发送该请求 |
|
||||
| 请求篡改拦截器 | requestReplace | 111 | 篡改请求头，达到想要的目的 |
|
||||
| 代理拦截器 | proxy | 121 | 将请求转发到指定地址 |
|
||||
| SNI拦截器 | sni | 122 | 设置 `servername`，用于避开GFW |
|
||||
| 请求拦截器名称 | 拦截器配置名 | 请求拦截优先级 | 作用 |
|
||||
|----------------|----------------|----------------|---------------------------------------------------------------------------------------------------|
|
||||
| OPTIONS请求拦截器 | options | 101 | 直接响应200，不发送该OPTIONS请求 |
|
||||
| 快速成功拦截器 | success | 102 | 直接响应200，不发送该请求 |
|
||||
| 快速失败拦截器 | abort | 103 | 直接响应403，不发送该请求 |
|
||||
| 缓存请求拦截器 | cacheXxx | 104 | 如果缓存还生效，直接响应304，不发送该请求<br>如果缓存已过期或无缓存，则发送请求<br>注：只对GET请求生效！ |
|
||||
| 重定向拦截器 | redirect | 105 | 重定向到指定地址，直接响应302，不发送该请求 |
|
||||
| 请求篡改拦截器 | requestReplace | 111 | 篡改请求头，达到想要的目的 |
|
||||
| 代理拦截器 | proxy | 121 | 将请求转发到指定地址 |
|
||||
| SNI拦截器 | sni | 122 | 设置 `servername`，用于避开GFW |
|
||||
|
||||
### 2）响应拦截器：
|
||||
| 响应拦截器名称 | 拦截器配置名 | 响应拦截优先级 | 作用 |
|
||||
| ---------------- | --------------- | ------------- | --------- |
|
||||
| OPTIONS响应拦截器 | options | 201 | 设置跨域所需的响应头，避免被浏览器的跨域策略阻拦 |
|
||||
| 缓存响应拦截器 | cacheXxx | 202 | 设置缓存所需的响应头，使浏览器缓存当前请求<br>注：只对GET请求生效！ |
|
||||
| 响应篡改拦截器 | responseReplace | 203 | 篡改响应头，避免被浏览器的安全策略阻拦 |
|
||||
| 脚本拦截器 | script | 211 | 注入JavaScript脚本到页面中，如：Github油猴脚本 |
|
||||
| 响应拦截器名称 | 拦截器配置名 | 响应拦截优先级 | 作用 |
|
||||
|--------------|-----------------|----------------|----------------------------------------------------------------|
|
||||
| OPTIONS响应拦截器 | options | 201 | 设置跨域所需的响应头，避免被浏览器的跨域策略阻拦 |
|
||||
| 缓存响应拦截器 | cacheXxx | 202 | 设置缓存所需的响应头，使浏览器缓存当前请求<br>注：只对GET请求生效！ |
|
||||
| 响应篡改拦截器 | responseReplace | 203 | 篡改响应头，避免被浏览器的安全策略阻拦 |
|
||||
| 脚本拦截器 | script | 211 | 注入JavaScript脚本到页面中，如：Github油猴脚本 |
|
||||
|
||||
## 4.2. 拦截配置说明书：
|
||||
|
||||
TODO：内容待完善
|
||||
配置示例:
|
||||
```json
|
||||
"*.example.com": {
|
||||
".*":{ //后续url匹配规则
|
||||
// 请求篡改配置
|
||||
"requestReplace": {
|
||||
"headers": {
|
||||
"User-Agent": "Mozilla/5.0", // 替换User-Agent
|
||||
"Referer": "[remove]" // 删除Referer头
|
||||
},
|
||||
"doDownload": true // 启用下载请求处理.要转换为下载请求，需要 responseReplace 拦截器的配合使用
|
||||
},
|
||||
|
||||
// 代理配置
|
||||
"proxy": "proxy.example.com", // 代理目标地址
|
||||
"backup": [ // 备用代理服务器列表
|
||||
"backup1.example.com",
|
||||
"backup2.example.com"
|
||||
],
|
||||
|
||||
//"proxy": "https://$1.proxy.com",
|
||||
//"replace": "https://(.*?)\\.example\\.com"
|
||||
//使用${path}数组捕获和替换,
|
||||
|
||||
"sni": "example.com", // SNI服务器名称指示
|
||||
"unVerifySsl": true, // 跳过SSL证书验证
|
||||
|
||||
// 基本拦截配置
|
||||
"abort": false, // 是否拦截请求(返回403)
|
||||
"success": true, // 是否快速返回成功(返回200)
|
||||
|
||||
"cacheDays": 365, // 缓存天数
|
||||
//cache系列包含如下关键词:cacheSecods,cacheMinutes,cacheHours,cacheDays,cacheWeeks,cacheMonths,cacheYears
|
||||
|
||||
// OPTIONS请求配置
|
||||
"options": {
|
||||
"headers": {
|
||||
"Access-Control-Allow-Origin": "*",
|
||||
"Access-Control-Allow-Methods": "GET", //不设置默认返回GET,POST,PUT,DELETE,HEAD,OPTIONS,PATCH
|
||||
"Access-Control-Allow-Headers": "Content-Type, X-Requested-With, X-Custom-Header", //不设置默认返回*
|
||||
"Access-Control-Max-Age": "86400" //不设置默认一个月
|
||||
}
|
||||
}
|
||||
|
||||
// 响应篡改配置
|
||||
"responseReplace": {
|
||||
"headers": {
|
||||
"Cache-Control": "no-cache", // 禁用缓存
|
||||
"X-Powered-By": "[remove]", // 删除服务器信息头
|
||||
"Access-Control-Allow-Origin": "*" // 添加CORS头
|
||||
},
|
||||
"doDownload": true // 强制响应为文件下载
|
||||
},
|
||||
"cacheExcludeStatusCodeList":[200], // 缓存排除状态码列表
|
||||
"cacheMinStatusCode": 200, // 缓存最小状态码,默认200
|
||||
"cacheMaxStatusCode": 303, // 缓存最大状态码,默认303
|
||||
"cacheControlType": "public", // 缓存控制类型,默认public,可选private
|
||||
"cacheImmutable": true,
|
||||
|
||||
"tampermonkeyScript": "UrlOrPathToTampermonkeyScript.js", // 注入Tampermonkey
|
||||
"script" : "UrlOrPathToYourScript.js" //支持数组,填入多个地址
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
# 5. 域名白名单：
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue