Skip to content

Commit 33a0f72

Browse files
ciryuciryu
authored
docx:update configure description (#44)
1 parent 1085e43 commit 33a0f72

File tree

1 file changed

+63
-5
lines changed

1 file changed

+63
-5
lines changed

‎docs/configure.md

Lines changed: 63 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@ HSTS 配置
301301
302302
| 名称 | 必选 | 类型 | 默认 | 描述 |
303303
| :----------- | ---- | :---------------------------------- | :--- | :----------------------------------------------------------- |
304-
| RulePaths | 是 | Array of string | | CacheType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / |
304+
| RulePaths | 是 | string[] | | CacheType 对应类型下的匹配内容： file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / |
305305
| RuleType | 是 | string | | 规则类型： file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页 |
306306
| FullUrlCache | 是 | string | | 是否开启全路径缓存 on：开启全路径缓存（即关闭参数忽略） off：关闭全路径缓存（即开启参数忽略） |
307307
| IgnoreCase | 是 | string | | 是否忽略大小写缓存 |
@@ -324,7 +324,7 @@ HSTS 配置
324324
325325
| 名称 | 必选 | 类型 | 默认 | 描述 |
326326
| :---------- | ---- | :----------------------------------------------------------- | :--- | :------------------- |
327-
| SimpleCache | 否 | [SimpleCache](https://cloud.tencent.com/document/api/228/30987#SimpleCache) | | 基础缓存过期时间配置 |
327+
| SimpleCache | 否 | [SimpleCache](#SimpleCache) | | 基础缓存过期时间配置 |
328328
| RuleCache | 否 | [RuleCache](#RuleCache)[] | | 高级路径缓存配置 |
329329
330330
#### SimpleCache
@@ -335,11 +335,30 @@ HSTS 配置
335335
| :----------------- | ---- | :------------------------------------ | :--- | :----------------------------------------------------------- |
336336
| CacheRules | 是 | [SimpleCacheRule](#SimpleCacheRule)[] | | 缓存过期时间规则 |
337337
| FollowOrigin | 是 | string | | 遵循源站 Cache-Control: max-age 配置 on：开启 off：关闭 |
338-
| IgnoreCacheControl | 是 | string | off | 强制缓存 on：开启 off：关闭，开启后，源站返回的 no-store、no-cache 资源，也将按照 CacheRules 规则进行缓存 |
339-
| IgnoreSetCookie | 是 | string | off | 忽略源站的Set-Cookie头部 on：开启 off：关闭 |
340-
| CompareMaxAge | 是 | string | off | 高级缓存过期配置，开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间，取最小值在节点进行缓存 on：开启 off：关闭 |
338+
| IgnoreCacheControl | 是 | string | | 强制缓存 on：开启 off：关闭，开启后，源站返回的 no-store、no-cache 资源，也将按照 CacheRules 规则进行缓存 |
339+
| IgnoreSetCookie | 是 | string | | 忽略源站的Set-Cookie头部 on：开启 off：关闭 |
340+
| CompareMaxAge | 是 | string | | 高级缓存过期配置，开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间，取最小值在节点进行缓存 on：开启 off：关闭 |
341341
| Revalidate | 否 | [Revalidate](#Revalidate) | | 总是回源站校验 |
342342
343+
#### SimpleCacheRule
344+
345+
缓存过期规则配置
346+
347+
| 名称 | 必选 | 类型 | 默认 | 描述 |
348+
| :------------ | ---- | :------- | :--- | :----------------------------------------------------------- |
349+
| CacheType | 是 | string | | 规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页 |
350+
| CacheContents | 是 | string[] | | CacheType 对应类型下的匹配内容： all 时填充 * file 时填充后缀名，如 jpg、txt directory 时填充路径，如 /xxx/test path 时填充绝对路径，如 /xxx/test.html index 时填充 / |
351+
| CacheTime | 是 | number | | 缓存过期时间设置 单位为秒，最大可设置为 365 天 |
352+
353+
#### Revalidate
354+
355+
是否回源站校验
356+
357+
| 名称 | 必选 | 类型 | 默认 | 描述 |
358+
| :----- | ---- | :----- | :--- | :------------------------- |
359+
| Switch | 是 | String | | on \| off 是否总是回源校验 |
360+
| Path | 否 | String | | 只在特定请求路径回源站校验 |
361+
343362
#### RuleCache
344363
345364
缓存配置分路径版本
@@ -350,6 +369,45 @@ HSTS 配置
350369
| RuleType | 是 | string | | 规则类型： all：所有文件生效 file：指定文件后缀生效 directory：指定路径生效 path：指定绝对路径生效 index：首页 |
351370
| CacheConfig | 是 | [RuleCacheConfig](#RuleCacheConfig) | | 缓存配置 |
352371
372+
#### RuleCacheConfig
373+
374+
路径缓存缓存配置（三种缓存模式中选取一种）
375+
376+
| 名称 | 必选 | 类型 | 默认 | 描述 |
377+
| :----------- | ---- | :-------------------------------------------------- | :--- | :----------- |
378+
| Cache | 是 | [CacheConfigCache](#CacheConfigCache) | | 缓存配置 |
379+
| NoCache | 是 | [CacheConfigNoCache](#CacheConfigNoCache) | | 不缓存配置 |
380+
| FollowOrigin | 是 | [CacheConfigFollowOrigin](#CacheConfigFollowOrigin) | | 遵循源站配置 |
381+
382+
#### CacheConfigCache
383+
384+
路径缓存缓存配置
385+
386+
| 名称 | 必选 | 类型 | 默认 | 描述 |
387+
| :----------------- | ---- | :----- | :--- | :----------------------------------------------------------- |
388+
| Switch | 是 | string | | 缓存配置开关 on：开启 off：关闭 |
389+
| CacheTime | 是 | number | | 缓存过期时间设置 单位为秒，最大可设置为 365 天 |
390+
| CompareMaxAge | 是 | string | | 高级缓存过期配置，开启时会对比源站返回的 max-age 值与 CacheRules 中设置的缓存过期时间，取最小值在节点进行缓存 on：开启 off：关闭 |
391+
| IgnoreCacheControl | 是 | string | | 强制缓存 on：开启 off：关闭 默认为关闭状态，开启后，源站返回的 no-store、no-cache 资源，也将按照 CacheRules 规则进行缓存 |
392+
| IgnoreSetCookie | 是 | string | | 当源站返回Set-Cookie头部时，节点是否缓存该头部及body on：开启，不缓存该头部及body off：关闭，遵循用户自定义的节点缓存规则 |
393+
394+
#### CacheConfigNoCache
395+
396+
路径缓存不缓存配置
397+
398+
| 名称 | 必选 | 类型 | 默认 | 描述 |
399+
| :--------- | ---- | :----- | :--- | :-------------------------------- |
400+
| Switch | 是 | string | | 不缓存配置开关 on：开启 off：关闭 |
401+
| Revalidate | 是 | string | | 总是回源站校验 on：开启 off：关闭 |
402+
403+
#### CacheConfigFollowOrigin
404+
405+
路径缓存遵循源站配置
406+
407+
| 名称 | 必选 | 类型 | 默认 | 描述 |
408+
| :----- | ---- | :----- | :--- | :---------------------------------- |
409+
| Switch | 是 | string | | 遵循源站配置开关 on：开启 off：关闭 |
410+
353411
#### Referer
354412
355413
Referer 黑白名单配置，默认为关闭状态

0 commit comments

Comments
 (0)