最近更新: 2022-11-06
适用版本: 3.7.5
文档地址: https://github.com/elecV2/elecV2P-dei/blob/master/docs/10-config.md
elecV2P 配置文件默认保存目录为 ./script/Lists/config.json。
请尽量在 webUI->SETTING/设置相关 界面进行修改，而不是手动编辑。
实际配置文件为严格的 JSON 格式，不包含任何注释。以下注释仅为说明，非注释版本查看 config.json 示例文件
{
"anyproxy": { // anyproxy 相关设置。用于 MITM
"enable": false, // 是否启用。默认 false 关闭
"port": 8001, // anyproxy 代理端口
"webPort": 8002 // anyproxy 网络请求查看端口
},
"CONFIG_FEED": { // 通知相关设置
"enable": true, // 是否开启默认通知
"rss": {
"enable": true, // 是否将通知输出为 feed/rss
"homepage": "" // feed/rss 主页。同最外层 homepage 参数
},
"iftttid": {
"enable": false, // 是否启用 IFTTT 通知
"key": "" // IFTTT 对应 key 值
},
"barkkey": {
"enable": false, // 是否启用 BARK 通知
"key": ""
},
"custnotify": {
"enable": false, // 是否启用自定义通知
"url": "", // 自定义通知 URL
"type": "GET", // 自定义通知内容发送方式
"data": "" // 自定义通知内容
},
"runjs": {
"enable": false, // 通知时触发脚本，即通过自定义脚本发送通知
"list": "notify.js" // 通知时运行脚本
},
"merge": {
"enable": true, // 是否合并默认通知
"gaptime": 60, // 合并该时间段内通知。单位：秒
"number": 10, // 合并通知条数
"andor": false // 时间段和通知条数合并逻辑。true: 同时满足，false: 满足任一
},
"maxbLength": 1200, // 最大通知内容长度。超过后将分段发送
"webmessage": {
"enable": true // 是否在 webUI 前端显示通知
}
},
"CONFIG_RUNJS": { // 脚本运行相关设置
"timeout": 5000, // 脚本运行时间。单位：毫秒 0 表示不设定超时时间
"intervals": 86400, // 远程脚本最低更新时间间隔，单位：秒。 默认：86400(一天)。0 表示有则不更新
"numtofeed": 50, // 每运行 { numtofeed } 次脚本, 发送一个默认通知。0 表示不通知
"jslogfile": true, // 是否保存脚本运行日志
"eaxioslog": false, // 是否保存网络请求 url 到日志中
"proxy": true, // 是否应用网络请求相关设置中的代理（如有）
"white": {
"enable": false, // 是否启用白名单脚本。放行脚本内所有网络请求
"list": ["softupdate.js"]
}
},
"CONFIG_Axios": { // 网络请求相关设置
"proxy": {
"enable": false, // 是否使用 http 代理
"host": "", // 代理服务器
"port": 8001 // 代理端口
},
"timeout": 5000, // 网络请求超时时间。单位：毫秒
"uagent": "iPhone", // 默认 User-Agent，相关列表位于 script/Lists/useragent.list
"block": {
"enable": false, // 是否阻止部分网络请求。匹配方式 new RegExp('regexp').test(url)
"regexp": ""
},
"only": {
"enable": false, // 当前启用时，表示仅允许符合该规则的 url 通过
"regexp": ""
},
"reject_unauthorized": true // process.env['NODE_TLS_REJECT_UNAUTHORIZED'] 设置。仅当为 false 时，对应值为 0。v3.7.4 增加
},
"eapp": { // EAPP 相关设置。详见 https://github.com/elecV2/elecV2P-dei/blob/master/docs/dev_note/webUI%20首页快捷运行程序%20eapp.md
"enable": true, // EAPP 是否在首页显示
"logo_type": 1, // EAPP 默认图标风格
"apps": [{ // EAPP 列表
"name": "EAPP 名称",
"type": "js", // EAPP 类型。共 js|efh|shell|url|eval 五种
"target": "efss/efh", // EAPP 最终执行内容
"hash": "xxxxx", // EAPP hash 值，自动生成，手动设置无效
}, {
"name": "PM2LS",
"type": "shell",
"target": "pm2 ls",
"run": "auto", // 首次加载时运行方式。仅当为 auto 时表示自动运行一次（v3.7.3 增加
"note": "显示 PM2 信息" // EAPP 备注信息（v3.7.3 增加
}]
},
"efss": { // EFSS 相关设置
"enable": true, // 是否启用
"directory": "./efss", // EFSS 对应文件夹
"dotshow": {
"enable": false // 是否显示以点(.) 开头的文件
},
"max": 600, // 最大显示文件数
"skip": {
"folder": [ // 跳过显示部分文件夹内文件
"node_modules"
],
"file": [] // 路过显示部分文件
},
"favend": {
"efh": {
"key": "efh", // favend 访问关键字。efss/efh
"name": "efh 初版",
"type": "runjs", // favend 类型。runjs 执行脚本|favorite 收藏目录
"target": "elecV2P.efh",
"enable": true // 是否启用
},
"logs": {
"key": "logs",
"name": "查看日志",
"type": "favorite", // favorite 列出 target 目录下的所有文件
"target": "logs",
"enable": true
}
},
"favendtimeout": 5000 // favend 脚本运行超时时间
},
"env": { // 环境变量相关设置（在 elecV2P 启动后自动添加
"path": "", // 该项内容会和 process.env.PATH 合并，并自动更新
"acookie": "myappcookie" // 其他环境变量会自动添加，process.env.acookie = "myappcookie"
},
"gloglevel": "info", // 后台日志显示等级。可选值 error|notify|info|debug，默认 info
"glogslicebegin": 5, // 日志时间显示格式。0: 默认，5: 不显示年份，11: 不显示年月日
"homepage": "http://127.0.0.1", // 主页地址。用于 RSS 订阅及脚本中的 __home 参数
"init": {
"checkupdate": false, // elecV2P 启动时，是否检测更新。默认 true
"runjsenable": true, // elecV2P 启动时，是否自动运行脚本（v3.7.4 增加）仅在为 false 时，表示不运行
"runjs": "" // elecV2P 启动时，自动运行脚本。多个脚本使用逗号(,)隔开，比如 test.js, 0body.js
},
"lang": "zh-CN", // 语言偏好。zh-CN 中文|en 英文（多语言翻译龟速进行中...
"minishell": true, // 是否开启 minishell。默认 false 关闭
"SECURITY": { // 安全相关设置
"enable": false, // 默认不开启（建议在首次打开 webUI 后手动启用
"blacklist": [ // 禁止访问的 IP 列表。* 表示禁止所有访问（除了下面的 whitelist
"*"
],
"whitelist": [ // 允许访问的 IP 列表。优先级高于 blacklist
"127.0.0.1",
"::1"
],
"cookie": { // 是否允许通过 cookie 访问。仅当 enable 对应值为 false 时表示不允许
"enable": true
},
"tokens": { // 临时访问 token，可限制访问路径（v3.7.4 增加
"md5(token)": { // 临时 token 的 MD5 hash 对应值（启动后会进行自动修复
"enable": true, // 是否启用该临时 token
"token": "xxxxx", // 访问 token。比如：efss/hi?token=xxxx, /logs?token=xxxxx
"path": "^/(efss|logs?)", // 限制可访问的路径。匹配方式 new RegExp(path, 'i').test(req.path)。留空表示不限制
"note": "给 xxx 的", // 备注说明
"times": 0 // 授权访问次数统计
},
"token2": { // 支持设置多个临时访问 token。直接删除即可取消授权
"enable": true,
"token": "xxxxxx", // 首次访问成功后，会生成一个有效期为 7 天的 cookie（增加 &cookie=long 有效期为 365 天
"path": "/efss/hi" // 生成的 cookie 可访问路径同样受此参数限制
}
},
"numtofeed": 1, // 有几次非法访问时出一个默认通知。0: 表示不通知
"webhook_only": false // 仅允许 webhook 接口访问
},
"TZ": "Asia/Shanghai", // 时区设置。将会赋值到 process.env.TZ
"update_check": false, // 是否检测更新
"update_check_gap": 0, // 检测更新最低时间间隔。单位 ms。默认 1000*60*30（30 分钟
"wbrtoken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", // webhook token，uuid 格式（建议）。当省略时自动生成。在启动时可通过 env.TOKEN 赋值
"webhook": {
"script": { // 当 webhook type 类型无匹配时的最终处理脚本
"enable": false, // 更多说明参考 https://github.com/elecV2/elecV2P-dei/blob/master/docs/09-webhook.md
"target": "webhook.js"
},
"token": "xxxxxxxx-xxx" // 当前 wbrtoken 缺省时，会使用该值代替(v3.7.4 添加
},
"webUI": { // webUI 主界面相关设置
"port": 80, // webUI 运行端口
"tls": {
"enable": false, // 是否开启 TLS 访问。默认 false 不启用。启用时，建议端口使用 443
"host": "e.dev" // 自签 TLS 证书域名
},
"logo": {
"enable": true, // 是否使用自定义 LOGO
"src": "//x.xx/x.png", // LOGO 替换。当该 LOGO 加载失败时，将生成默认 LOGO 头像
"name": "elecV2" // LOGO 旁边显示的文字
},
"nav": { // webUI 导航相关设置
"overview": {
"show": true, // 是否显示该导航条目
"name": "基础信息" // 具体显示的导航文字
},
"task": {
"show": true,
"name": "定时任务"
},
"mitm": {
"show": false
},
"rules": {
"show": false
},
"rewrite": {
"show": true,
"name": "重写请求"
},
"jsmanage": {
"show": true,
"name": "脚本管理"
},
"setting": {
"show": true, // SETTING/设置 导航项默认不能关闭
"name": "设置相关"
},
"cfilter": {
"show": false,
"name": ""
},
"about": {
"show": false,
"name": "简介说明"
},
"donation": {
"show": true,
"name": "赞助打赏"
}
},
"theme": { // webUI 自定义主题（测试功能，部分用户可用
"simple": { // 当前应用主题
"enable": false, // 是否启用
"name": "椰树背景", // 主题名称
"mainbk": "#2E3784", // 主要背景色彩
"maincl": "#6E77FB", // 主要文字色彩
"appbk": "url(https://images.unsplash.com/photo-1649256651398-46408de2f095?auto=format&fit=crop&w=1964)", // 背景
"style": ".eapp_item .eapp_name {color: var(--main-fc);}" // 其他附加样式
},
"list": [{ // 保存的主题列表。对应值为上面 simple 中除 enable 外的其他值
}]
}
},
// 规则/脚本/常量等个人数据保存目录（v3.7.4 增加）
// 对应值应为某个文件夹。当不存在时，将自动生成
// 支持相对路径和绝对路径 path.resolve(__dirname, path_lists || 'script/Lists')
"path_lists": "myLists", // 规则、定时任务等保存文件夹
"path_script": "/elecv2p/script", // 脚本文件保存路径
"path_store": "E:\\elecV2P\\Store", // store/cookie 常量保存目录
"path_shell": "./efss/myShell", // shell 指令默认执行目录
// 以下为 elecV2P 启动后自动生成的值，预先设置无效（v3.7.4 之后被全部移除
"path": "/xx/config.json", // 当前配置文件保存路径。path.join('./script/Lists/config.json')
"start": 1666488300114, // 当前 elecV2P 启动时间。Date.now()
"userid": "md5hash", // 用户 ID。对应值为 md5(webhook token)
"version": "3.7.3", // 当前版本。require('./package.json').version
"vernum": 373, // 当前版本的数字表达。Number(version.replace(/\D/g, ''))
"newversion": "3.7.4" // 检测到的新版本（如果存在的话
}配置文件可在启动时通过环境变量(env) CONFIG 来指定更改，最终路径为 path.resolve('script/Lists', process.env.CONFIG || 'config.json')。比如 set CONFIG=123.json&&node index.js, 则最终配置文件为 xxx/script/Lists/123.json。支持绝对路径，比如 CONFIG=/elecV2P/config.json node index.js，则最终配置文件为 /elecV2P/config.json。
在启动时使用以下环境变量(ENV)，可增加或覆盖配置文件中的相关值。
- CONFIG : 指定配置文件路径
- PORT : webUI 使用端口
- PROXYEN : 启动时打开代理 anyproxy enable（v3.7.5 增加）
- TOKEN : webhook token，对应配置文件中的 wbrtoken 项
- TZ : 时区设置，默认 Asia/Shanghai