Now-subconverter 使用指南
原文地址 blogsue.vercel.app
生成一个 repo 权限的 github token。 具体步骤见官方文档,其中第 7 步只勾选第一个钩 (repo),保存好生成的 token 待用。
- github 账号
- vercel 账号 (可使用 github 账号登录)
- 能理解本篇指南的智力
- 基础的电脑操作能力
- 能够在 github 上编辑修改项目文件
- 对 subconverter 与 sub-web 项目有一定了解,知道它们的配置方法
生成一个 repo 权限的 github token。 具体步骤见官方文档,其中第 7 步只勾选第一个钩 (repo),保存好生成的 token 待用。
纯傻瓜式搭建
- 搭建自己的包含前端 + 后端的完整订阅转换接口
- 前端 sub-web 项目修改后,now-subconverter 项目自动更新其中的 sub-web 部分
一、Fork 项目
- 在 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 仓库做以下操作: 1. 点击你的仓库右上角的 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(简单)
- 将你要使用的配置文件(包括但不限于
pref.ini
)放入now-subconverter
仓库的files
目录下 - 任务运行时会自动将
/files
目录下所有文件复制到subconverter/
内
四、修改 now-subconverter 中的 sub-web 源
编辑 /.github/workflows/sub-web.yml 文件中的 25 行,修改为你的 sub-web 项目;51 行的 commit 信息可以自定义修改。
五、修改 sub-web 项目文件
- 修改
/.github/workflows/build.yml
中的 39 行,其中的链接为.../zhongfly/now-subconverter/...
即我的 now-subconverter 项目,请修改成你的项目地址. - 自定义修改 sub-web 项目满足你的个人需要,请参考 sub-web 的 readme.md,此处不过多介绍。当在你的 sub-web 项目中提交修改后,会自动触发你的 now-subconverter 项目更新其中的 sub-web 文件
六、部署到 vercel
- 打开 vercel
- 选择 Import Project – Import Git Repository,输入你的 now-subconverter 项目地址
- 一路下一步即可
补充:手动更新后端 (subconverter)
当需要更新后端时,进入 now-subconverter 项目的 action 页面,在左侧选择 Update subconverter,点击页面右侧的 Run workflow→Run now,设置好相关参数,点击绿色按键即可开始运行
tindy2013/subconverter 更新后,本项目自动更新
参考项目 wiki
点 star 或定时运行任务
参见 /.github/workflows/
下的 main.yml
中的 on:
下的触发条件设置