/elecV2P

一款基于 NodeJS,可通过 JS 修改网络请求,以及定时运行脚本或 SHELL 指令的网络工具。

Primary LanguageJavaScript

简介

elecV2P - customize personal network. 一款基于 NodeJS,可通过 JS 修改网络请求,以及定时运行脚本或 SHELL 指令的网络工具。

基础功能

  • 查看/修改网络请求 (MITM)
  • 定时执行 JS/SHELL 脚本
  • FEED/IFTTT/自定义 通知
  • EFSS 基础文件管理(v0.1)

安装/INSTALL

程序开放权限较大,建议局域网使用。网络部署,风险自负

方法一:直接 NODEJS 运行

git clone https://github.com/elecV2/elecV2P.git
cd elecV2P

yarn
yarn start

# 或者使用 PM2 运行,方便状态查看及管理
yarn global add pm2
pm2 start index.js

# 升级
# - 先备份好个人数据,比如 script 中的 JSFile/Store/Lists/Shell 等文件夹,和 efss 文件夹等
# - 然后再从 Github 拉取最新的代码进行覆盖升级
# - 最后再把备份好的文件复制到原来的位置

方法二:DOCKER

  • 基础镜像:elecv2/elecv2p
  • ARM镜像:(适用于 N1/OPENWRT/树莓派等 ARM 架构的系统)
    • elecv2/elecv2p:arm64
    • elecv2/elecv2p:arm32
# 基础使用命令
docker run --restart=always -d --name elecv2p -p 80:80 -p 8001:8001 -p 8002:8002 elecv2/elecv2p

# 更改时区和映射端口
docker run --restart=always -d --name elecv2p -e TZ=Asia/Shanghai -p 8100:80 -p 8101:8001 -p 8102:8002 elecv2/elecv2p:arm32

# 使用 ARM 镜像及持久化存储
docker run --restart=always -d --name elecv2p -e TZ=Asia/Shanghai -p 8100:80 -p 8101:8001 -p 8102:8002 -v /elecv2p/JSFile:/usr/local/app/script/JSFile -v /elecv2p/Store:/usr/local/app/script/Store elecv2/elecv2p:arm64

# 以上命令仅供参考,根据实际情况更改映射端口/时区/镜像等参数。

# 升级 Docker 镜像。(如果没有使用持久化存储,升级后所有个人数据会丢失,请提前备份)
docker rm -f elecv2p           # 先删除旧的容器
docker pull elecv2/elecv2p     # 再下载新的镜像。镜像名注意要和之前使用的相对应
# 再使用之前的 docker run xxxx 命令重新启动一下

方法三:DOCKER-COMPOSE (推荐)

mkdir /elecv2p && cd /elecv2p
curl -sL https://git.io/JLw7s > docker-compose.yaml
docker-compose up -d

# 注意:默认的 docker-compose.yaml 文件使用的是基础镜像,如果是 ARM 平台请使用下面的文件手动进行修改。
# 另外,默认把 80/8001/8002 端口分别映射成了 8100/8101/8102,以防出现端口占用的情况,访问时注意。
# 如果需要调整为其他端口,可以自行修改下面的内容然后手动保存。

或者将以下内容手动保存为 docker-compose.yaml 文件。

version: '3.7'
services:
  elecv2p:
    image: elecv2/elecv2p
    container_name: elecv2p
    restart: always
    environment:
      - TZ=Asia/Shanghai
    ports:
      - "8100:80"
      - "8101:8001"
      - "8102:8002"
    volumes:
      - "/elecv2p/JSFile:/usr/local/app/script/JSFile"
      - "/elecv2p/Lists:/usr/local/app/script/Lists"
      - "/elecv2p/Store:/usr/local/app/script/Store"
      - "/elecv2p/Shell:/usr/local/app/script/Shell"
      - "/elecv2p/rootCA:/usr/local/app/rootCA"
      - "/elecv2p/efss:/usr/local/app/efss"
  • 具体使用的镜像 image、端口映射和 volumes 目录,根据个人情况进行调整
  • 部分用户反映,在某些设备上需要调整 version 的版本才能启动。如果启动出现问题,可以尝试把文件开头的 version: '3.7' 更改为 version: '3.3'。

然后在 docker-compose.yaml 同目录下执行以下任一命令

# 直接启动。(首次启动命令)
docker-compose up -d

# 更新镜像并重新启动。 (docker-compose 已使用 volumes 映射存储了个人数据,无需再手动备份)
docker-compose pull elecv2p && docker-compose up -d

其他 docker 相关指令

# 查看是否启动及对应端口
docker ps

# 查看运行日志
docker logs elecv2p -f

默认端口

  • 80: 后台管理界面。添加规则/JS 文件管理/定时任务管理/MITM 证书 等
  • 8001: ANYPROXY 代理端口
  • 8002: ANYPROXY 代理请求查看端口

80 端口可使用环境变量 PORT 进行修改,其他端口的修改可在 config.js 文件中进行。如果是使用 Docker 相关的安装方式,建议修改对应的映射端口,而不是直接修改源文件。

根证书相关 - HTTPS 解密

  • 如果不使用 RULES/REWRITE 相关功能,此步骤可跳过。
  • 升级启动后,如果不是使用之前的证书,需要重新下载安装信任根证书。

安装证书

选择以下任一种方式下载证书,然后安装信任证书

  • 直接打开 :80/crt
  • :80 -> MITM -> 安装证书
  • :8002 -> RootCA

根证书物理存储目录位于 $HOME/.anyproxy/certificates,可用自签证书进行替换。

windows 平台的证书存储位置选择 浏览->受信任的根证书颁发机构

启用自签证书

任选一种方式

  • 将根证书(rootCA.crt/rootCA.key)复制到本项目 rootCA 目录,然后打开 webUI -> MITM -> 启用自签证书
  • 直接将根证书复制到 $HOME/.anyproxy/certificates 目录下

然后重启服务。使用新的证书后,记得重新下载安装信任证书,并清除由之前根证书签发的域名证书。

RULES - 网络请求修改

rules

详细说明参考: docs/03-rules.md

定时任务

task

目前支持两种定时方式:

  • 倒计时
  • cron 定时

时间格式:

  • 倒计时 30 999 3 2 (以空格分开的四个数字,后三项可省略)
30(秒) 999(次) 3(秒) 2(次)
基础倒计时时间 重复次数(可选) 增加随机时间(可选) 增加随机重复次数(可选)

当重复次数大于等于 999 时,无限循环。

示例: 40 8 10 3 ,表示倒计时40秒,随机10秒,所以具体倒计时时间位于 40-50 秒之间,重复运行 8-11 次

  • cron 定时

时间格式:* * * * * * (五/六位 cron 时间格式)

* (0-59) * (0-59) * (0-23) * (1-31) * (1-12) * (0-7)
秒(可选) 小时 星期

可执行任务类型

  • 运行 JS
  • 开始/停止 其他定时任务
  • 基础 shell 指令。比如 rm -f *, python test.py, reboot 等等

更多说明参考:docs/06-task.md

通知

目前支持通知方式:

  • FEED/RSS 订阅
  • IFTTT WEBHOOK
  • BARK 通知
  • 自定义通知

FEED/RSS 订阅地址为 :80/feed。

通知内容:

  • 定时任务开始/结束
  • 定时任务 JS 运行次数
  • 脚本中的自主调用通知

IFTTT/BARK/自定义通知等相关设置参考: 07-feed&notify

DOCUMENTS&EXAMPLES

说明文档及一些例程:https://github.com/elecV2/elecV2P-dei

TG 交流群:https://t.me/elecV2G (主要为方便群友使用交流,群主24小时不在线,也不负责解答任何问题。)

如果遇到问题还是建议开一个 issue,并注明使用平台,版本,以及附上相关的错误日志。

简单声明

该项目仅用于学习交流,任何使用,风险自负。

贡献参考