update Readme FIle
This commit is contained in:
xopenwrt
GitHub
parent
89d8670227
commit
d3293ff800
128
README.md
128
README.md
|
|
@ -1,127 +1,57 @@
|
|||
# OpenWrt-Actions & One-key AutoUpdate
|
||||
## **OpenWrt下载说明**
|
||||
- 可在 [Release](https://github.com/xopenwrt/X-OpenWrt-New/releases/tag/AutoUpdate) 页面下载 `img.gz` 格式的文件
|
||||
- 可在 [Cloud-Openwrt](https://openwrt.115115.xyz/)下载 `VMDK` 虚拟磁盘文件
|
||||
- 可直接使用系统内置的更新功能，可任意切换版本
|
||||
|
||||
|
||||
|
||||
## **发行说明**
|
||||
1. Github 项目地址：[AutoBuild-Action](https://github.com/xopenwrt/X-OpenWrt-New)
|
||||
2. 默认IP：`192.168.2.200`，用户名： `root` 密码：`password`, `N1` 盒子为 `10.0.0.1`
|
||||
3. `X` 版本（大全版）： `Dockerman Smartdns HelloWorld Clash Passwall AdGuardHome` 等以及更多主题
|
||||
4. `Y` 版本（适中版）： 基础包、常用软件及 `Docker`, 其中 `N1` 盒子版本软件包还在调整中
|
||||
6. `Z` 版本（极简版) ： 基础包及 `Smartdns Passwall AdGuardHome`
|
||||
7. 可修复 `Docker` 对 `udp` 的影响
|
||||
8. `x86` 默认 `rom` 分区大小为 `800M`，`Boot` 分区为`32M`。如果自行对路由器分区后请勿随意不同的发行版本，注意确认 `rom` 分区和 `Boot` 分区一致，否则会导致丢失硬盘其余分区数据。同一发行版本请放心更新、升级
|
||||
9. 本项目最新版本全部采用 `5.15` 内核，详情参见更新日志
|
||||
10. 本镜像基于 ：[AutoBuild-Action](https://github.com/Hyy2001X/AutoBuild-Actions) 项目，特别感谢!
|
||||
11. 代码调试仓库为：[AutoBuild-Action](https://github.com/kokeri/AutoBuild-Actions/)
|
||||
|
||||
AutoBuild-Actions 稳定版仓库地址: [AutoBuild-Actions-Template](https://github.com/Hyy2001X/AutoBuild-Actions-Template)
|
||||
## **Tips**
|
||||
由于编译Docker可能导致tproxy透明代理失效，可在` /etc/sysctl.conf `文件中加入
|
||||
|
||||
自用修改版软件包地址: [AutoBuild-Packages](https://github.com/Hyy2001X/AutoBuild-Packages)
|
||||
`net.bridge.bridge-nf-call-ip6tables = 0`
|
||||
|
||||
支持的 OpenWrt 源码: `coolsnowwolf/lede`、`immortalwrt/immortalwrt`、`openwrt/openwrt`、`lienol/openwrt`
|
||||
`net.bridge.bridge-nf-call-iptables = 0`
|
||||
|
||||
🔔 **Not a DaLao , just an User.**
|
||||
后执行 `sysctl -p` 修复，注意，此步骤会导致 Docker 内部无法正常 DNS 解析，需要手动下发默认 DNS 服务器。
|
||||
|
||||
## 维护设备列表
|
||||
|
||||
| 机型 | 配置文件 | 自用 | 是否发布 |
|
||||
| :----: | :----: | :----: | :----: |
|
||||
| [x86_64](./.github/workflows/AutoBuild-x86_64.yml) | [x86_64](./Configs/x86_64) | ✅ | ❎ |
|
||||
| [新路由3](./.github/workflows/AutoBuild-d-team_newifi-d2.yml) | [d-team_newifi-d2](./Configs/d-team_newifi-d2) | ❎ | ✅ |
|
||||
| [华硕 acrh17](./.github/workflows/AutoBuild-asus_rt-acrh17.yml) | [asus_rt-acrh17](./Configs/asus_rt-acrh17) | ❎ | ❎ |
|
||||
| [竞斗云 2.0](./.github/workflows/AutoBuild-p2w_r619ac-128m.yml) | [p2w_r619ac-128m](./Configs/p2w_r619ac-128m) | ❎ | ❎ |
|
||||
| [红米 AC2100](./.github/workflows/AutoBuild-xiaomi_redmi-router-ac2100.yml) | [xiaomi_redmi-router-ac2100](./Configs/xiaomi_redmi-router-ac2100) | ❎ | ❎ |
|
||||
| [小娱C1/3/5](./.github/workflows/AutoBuild-xiaoyu_xy-c5.yml) | [xiaoyu_xy-c5](./Configs/xiaoyu_xy-c5) | ❎ | ✅ |
|
||||
| [红米 AX6S](./.github/workflows/AutoBuild-xiaomi_redmi-router-ax6s.yml) | [xiaomi_redmi-router-ax6s](./Configs/xiaomi_redmi-router-ax6s) | ✅ | ❎ |
|
||||
|
||||
## 一、定制固件(可选)
|
||||
|
||||
🎈 **提示**: 文中的 **TARGET_PROFILE** 为要编译的设备名称, 例如: `d-team_newifi-d2`、`asus_rt-acrh17`
|
||||
|
||||
从本地获取: 在源码目录执行`egrep -o "CONFIG_TARGET.*DEVICE.*=y" .config | sed -r 's/.*DEVICE_(.*)=y/\1/'`
|
||||
|
||||
或执行`grep 'TARGET_PROFILE' .config`, 请先执行`make menuconfig`进行配置
|
||||
|
||||
1. 进入你的`AutoBuild-Actions`仓库, **下方所有操作都将在你的`AutoBuild-Actions`仓库下进行**
|
||||
|
||||
建议使用`Github Desktop`和`Notepad++`进行操作 [[Github Desktop](https://desktop.github.com/)] [[Notepad++](https://notepad-plus-plus.org/downloads/)]
|
||||
|
||||
2. 编辑`/Configs`目录下的配置文件, 若配置文件不存在则需要在本地生成`.config`重命名并上传
|
||||
|
||||
3. 编辑`/.github/workflows/某设备.yml`文件, 修改`第 7 行`为随便的名称
|
||||
|
||||
4. 编辑`/.github/workflows/某设备.yml`文件, 修改`第 32 行`为上传的`.config`配置文件名称
|
||||
|
||||
5. 按照需求且编辑 [/Scripts/AutoBuild_DiyScript.sh](./Scripts/AutoBuild_DiyScript.sh), `/Scripts`下的其他文件无需修改
|
||||
|
||||
**/Scripts/AutoBuild_DiyScript.sh: Firmware_Diy_Core() 函数中的变量解释:**
|
||||
```
|
||||
Author 作者名称, AUTO: [自动识别]
|
||||
|
||||
Author_URL 自定义作者网站或域名, AUTO: [自动识别]
|
||||
|
||||
Default_Flag 固件标签 (名称后缀), 适用不同配置文件, AUTO: [自动识别]
|
||||
|
||||
Default_Title Shell 终端首页显示的额外信息
|
||||
|
||||
Default_IP 固件 IP 地址
|
||||
|
||||
Short_Fw_Date 简短的固件日期, 例如 true: [20210601]; false: [202106012359]
|
||||
|
||||
x86_Full_Images 额外上传已检测到的 x86 虚拟磁盘镜像
|
||||
|
||||
Fw_Format 自定义固件格式; false: [自动识别]
|
||||
|
||||
Regex_Skip 输出固件时丢弃包含该内容的文件
|
||||
|
||||
AutoBuild_Features 自动添加 AutoBuild 固件特性, 例如 一键更新固件; 固件工具箱
|
||||
|
||||
注: 禁用某功能请将变量值修改为 false, 开启则为 true
|
||||
|
||||
```
|
||||
|
||||
## 二、编译固件(必选)
|
||||
|
||||
**手动编译** 点击上方`Actions`, 在左栏选择要编译的设备,点击右方`Run workflow`再点击`绿色按钮`即可开始编译
|
||||
|
||||
**一键编译** 删除`第 29-30 行`的注释并保存, 以后点击两次右上角的 **Star** 按钮即可一键编译
|
||||
|
||||
**定时编译** 删除`第 26-27 行`的注释, 然后按需修改时间并提交修改 [Corn 使用方法](https://www.runoob.com/w3cnote/linux-crontab-tasks.html)
|
||||
|
||||
**临时修改固件 IP 地址** 该功能仅在**手动编译**生效, 点击`Run workflow`后即可输入 IP 地址
|
||||
|
||||
**使用其他 [.config] 配置文件** 点击`Run workflow`后即可输入位于`/Configs`下的配置文件名称
|
||||
|
||||
🔔 **为了你的账号安全, 请不要使用 SSH 连接 Github Action**, `.config`配置以及固件定制等操作请务必在本地完成 🔔
|
||||
|
||||
## 三、部署云端日志(可选)
|
||||
|
||||
1. 下载本仓库中的 [Update_Logs.json](https://github.com/Hyy2001X/AutoBuild-Actions/releases/download/AutoUpdate/Update_Logs.json) 到本地 (如果有)
|
||||
|
||||
2. 以 **JSON** 格式编辑本地的`Update_Logs.json`
|
||||
|
||||
3. 手动上传修改后的`Update_Logs.json`到`Github Release`
|
||||
|
||||
4. 在本地执行`autoupdate --fw-log`测试
|
||||
## **更新日志**
|
||||
- 参见 [更新日志](https://github.com/xopenwrt/X-OpenWrt-New/blob/master/Download.md)
|
||||
|
||||
## 使用一键更新固件脚本
|
||||
|
||||
首先需要打开`TTYD 终端`或者使用`SSH`, 按需输入下方指令:
|
||||
|
||||
常规更新固件: `autoupdate`
|
||||
常规更新固件: `autoupdate`或完整指令`bash /bin/AutoUpdate.sh`
|
||||
|
||||
使用镜像加速更新固件: `autoupdate -P`
|
||||
|
||||
更新固件(不保留配置): `autoupdate -n`
|
||||
|
||||
强制刷写固件(危险): `autoupdate -F`
|
||||
强制刷入固件: `autoupdate -F`
|
||||
|
||||
强制下载并刷写固件: `autoupdate -f`
|
||||
"我不管, 我就是要更新!": `autoupdate -f`
|
||||
|
||||
更新脚本: `autoupdate -x`
|
||||
|
||||
打印运行日志: `autoupdate --log`
|
||||
|
||||
列出相关信息: `autoupdate --list`
|
||||
|
||||
检查运行环境: `autoupdate --chk`
|
||||
|
||||
查看脚本帮助: `autoupdate --help`
|
||||
查看所有可用参数: `autoupdate --help`
|
||||
|
||||
**注意: **部分参数可一起使用, 例如 `autoupdate -n -P -F --path /mnt/sda1`
|
||||
|
||||
## 使用 tools 固件工具箱
|
||||
|
||||
打开`TTYD 终端`或者使用`SSH`, 执行指令`tools`即可启动固件工具箱
|
||||
打开`TTYD 终端`或者使用`SSH`, 执行指令`tools`或`bash /bin/AutoBuild_Tools.sh`即可启动固件工具箱
|
||||
|
||||
当前支持以下功能:
|
||||
|
||||
|
|
@ -135,7 +65,7 @@ AutoBuild-Actions 稳定版仓库地址: [AutoBuild-Actions-Template](https://gi
|
|||
- 打印在线设备列表
|
||||
|
||||
## 鸣谢
|
||||
|
||||
- [AutoBuild-Action](https://github.com/Hyy2001X/AutoBuild-Actions)
|
||||
- [Lean's Openwrt Source code](https://github.com/coolsnowwolf/lede)
|
||||
|
||||
- [P3TERX's Blog](https://p3terx.com/archives/build-openwrt-with-github-actions.html)
|
||||
|
|
@ -145,5 +75,3 @@ AutoBuild-Actions 稳定版仓库地址: [AutoBuild-Actions-Template](https://gi
|
|||
- [eSir 's workflow template](https://github.com/esirplayground/AutoBuild-OpenWrt/blob/master/.github/workflows/Build_OP_x86_64.yml)
|
||||
|
||||
- [[openwrt-autoupdate](https://github.com/mab-wien/openwrt-autoupdate)] [[Actions-OpenWrt](https://github.com/P3TERX/Actions-OpenWrt)]
|
||||
|
||||
- 测试与建议: [CurssedCoffin](https://github.com/CurssedCoffin) [Licsber](https://github.com/Licsber) [sirliu](https://github.com/sirliu) [神雕](https://github.com/teasiu) [yehaku](https://www.right.com.cn/forum/space-uid-28062.html) [缘空空](https://github.com/NaiHeKK) [281677160](https://github.com/281677160)
|
||||
|
|
|
|||
Loading…
Reference in New Issue