now-subconverter使用指南

[zhongfly]

需要的东西

• github账号
• vercel 账号(可使用github账号登录)
• 能理解本篇指南的智力
• 基础的电脑操作能力
• 能够在github上编辑修改项目文件
• 对subconverter与sub-web项目有一定了解，知道它们的配置方法

预先准备

生成一个repo权限的github token。 具体步骤见官方文档，其中第7步只勾选第一个钩(repo)，保存好生成的token待用。

纯傻瓜式搭建

点击即可，一路无脑选择下一步，等待部署成功。

基础使用指南

• 搭建自己的包含前端+后端的完整订阅转换接口
• 前端sub-web项目修改后，now-subconverter项目自动更新其中的sub-web部分

  一、Fork项目

  1.在github上fork我的now-subconverter项目 2.在github上fork一个你喜欢的subconverter前端项目，此处推荐sub-web，其常见的修改版有leosam2048。不过为满足需要，仅以我修改的版本为例，在sub-web提交修改后会自动推送修改给你预设的now-subconverter仓库。

二、启用并配置项目的github action

github action可视为github提供的自动化服务，可以自行设置触发事件，然后执行你需要的操作(例如编译版本/自动关闭issue)。

对以上fork的项目做以下操作：

1. 点击你的仓库右上角的 Settings，打开Actions这一项，Actions permissions中勾选Allow all actions

如果fork了我的sub-web项目还需要对你fork的sub-web仓库做以下操作：

• 点击你的仓库右上角的 Settings，找到 Secrets 这一项，添加一个名为REPO_TOKEN的变量，值是有repo权限的github token(预先准备中获得的)

三、now-subconverter项目的参数设置

详细见/.github/workflows/下的main.yml 中 env 下各参数的注释 env下为自动触发时默认使用的设置 workflow_dispatch 中各参数的default一项为手动触发时使用的默认设置，手动触发时还可以自定义设置

3.1 message

提交说明的内容

3.2 branch

从何处更新subconverter

可选值	含义
release	从release中下载稳定版本，可用下面的tag参数指定版本
action	从最新代码所关联github action的Artifacts里下载已经编译好的
build	拉取最新代码自己编译

3.3 tag

当branch参数设置为release时，这个参数指定下载的版本 设置为latest时，自动选择最新版本release

3.4 modify_method

自定义配置文件的方法 不建议直接修改subconverter/内的pref.ini等配置文件，因为会在更新后端（subconverter）时被全新的文件覆盖 ，配置就丢失了。

可选值	含义
sed	在Modify pref.ini by sed步骤中，用sed命令修改配置文件
files	使用本项目中/files文件夹中的文件覆盖

3.4.1 sed（需要有相关知识）

/.github/workflows/下的main.yml中的步骤Modify pref.ini by sed使用sed命令修改subconverter的默认配置pref.ini的方法 仿照此示例即可

3.4.2 files（简单）

1. 将你要使用的配置文件（包括但不限于pref.ini）放入now-subconverter仓库的files目录下
2. 任务运行时会自动将/files目录下所有文件复制到subconverter/内

四、修改now-subconverter中的sub-web源

编辑/.github/workflows/sub-web.yml文件中的25行，修改为你的sub-web项目;51行的commit信息可以自定义修改。

五、修改sub-web项目文件

1. 修改/.github/workflows/build.yml 中的39行，其中的链接为.../zhongfly/now-subconverter/...即我的now-subconverter项目，请修改成你的项目地址.
2. 自定义修改sub-web项目满足你的个人需要，请参考sub-web的readme.md，此处不过多介绍. 当在你的sub-web项目中提交修改后，会自动触发你的now-subconverter项目更新其中的sub-web文件

六、部署到vercel

1. 打开vercel
2. 选择Import Project – Import Git Repository，输入你的now-subconverter项目地址
3. 一路下一步即可

补充：手动更新后端(subconverter)

当需要更新后端时，进入now-subconverter项目的action页面，在左侧选择Update subconverter，点击页面右侧的Run workflow→Run now，设置好相关参数，点击绿色按键即可开始运行

进阶用法

tindy2013/subconverter更新后，本项目自动更新

参考项目wiki

点star或定时运行任务

参见/.github/workflows/下的main.yml中的on:下的触发条件设置