跳到主要内容

模块

在 Egern 中，模块是预设定的配置片段，用户可以方便地启用或禁用一组特定的网络处理规则。模块的功能覆盖范围广泛，可以包含规则、URL 重写、头部重写、主体重写、脚本、MITM 和 HTTP 抓取等。当启用模块后，模块内的配置将会被合并到 Egern 的主配置中。

配置说明​

字段名类型是否必填描述
namestring是模块的名称。
urlstring是模块文件的地址，可以是本地文件路径或远程链接。
update_intervalinteger否当模块文件是远程链接时，此参数指定模块的更新间隔（以秒为单位）。默认值为 86400（即一天）。
enabledboolean否控制模块是否启用。若设为 true，则模块中的配置将生效；若设为 false，则模块中的配置不会生效。默认值为 true。

使用模块​

创建模块文件​

首先，你需要创建一个模块文件。模块文件是一个 YAML 格式的文件，其中可以包含 Egern 支持的各种配置项。例如，你可以在模块文件中定义一组 URL 重写规则，或者定义一个 HTTP 请求脚本等。

引用模块文件​

在主配置文件（例如 Egern.yaml）中，你可以通过以下方式引用模块文件：

modules:
  - url: "path/to/your/module.yaml"
    update_interval: 86400
    enabled: true

这里的 url 可以是模块文件的本地路径，也可以是一个远程链接。如果 url 是一个远程链接，Egern 将会定期（根据 update_interval 参数）从这个链接下载更新。

设置 enabled 参数为 true 可以启用模块，将模块中的配置合并到主配置中。如果你想临时禁用模块中的配置，只需要将 enabled 设置为 false 即可。