diff --git a/README.md b/README.md index 92ae7ff..49c565a 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,18 @@ - 采用官方原版 [ImageBuilder](https://openwrt.org/docs/guide-user/additional-software/imagebuilder) 构建而非从源码构建,几分钟即可构建完成 - 集成 OpenClash,构建固件时只需要提供 clash 配置链接即可在刷机完成后,直接启动 OpenClash -- 可配置默认 LAN 口 IP,PPPoE 账号密码,刷机完成后,不用配置网络 +- 可配置默认 LAN 口 IP,PPPoE 账号密码,推荐的 IPv6 配置,刷机完成后,不用配置网络 - 可按照官方推荐的 uci 功能进行自定义,无需代码修改,您可以通过 uci 进行几乎任何自定义 +## 依赖 + +- Docker +- docker-compose v1 or v2 ## 使用 +本项目通过改变使用不同的 ImageBuilder 镜像,来构建不同的固件,镜像名可以从 [Docker Hub](https://hub.docker.com/r/openwrtorg/imagebuilder/tags) 上查看 +ImmortalWrt 的镜像名字可以从 [Docker Hub](https://hub.docker.com/r/immortalwrt/imagebuilder/tags) 查看 + ```bash git clone https://github.com/ekkog/OpenWrt.git cd OpenWrt @@ -16,59 +23,6 @@ cd OpenWrt ./run.sh --image=openwrtorg/imagebuilder:mvebu-cortexa9-22.03.3 --profile=linksys_wrt3200acm ``` -OpenWrt 的 image 名字可以从 [Docker Hub](https://hub.docker.com/r/openwrtorg/imagebuilder/tags) 上找到 - -ImmortalWrt 的 image 名字可以从 [Docker Hub](https://hub.docker.com/r/immortalwrt/imagebuilder/tags) 上找到 - -### 环境变量 - -```bash -# 设置 LAN 口 IP, 不配置则使用默认值 192.168.3.1 -LAN_IP=192.168.3.1 -# 默认代理客户端, 可选值: openclash, passwall -PROXY_CLIENT=openclash -# 当 PROXY_CLIENT=openclash 时,需要设置 -CLASH_CONFIG_URL= -# 添加额外软件包 -EXTRA_PKGS=natmap python3-light -# 设置 ROOT 密码 -ROOT_PASSWORD=123456 -# 禁用推荐的 IPv6 配置 https://t.me/ctcgfw_openwrt_discuss/1025497 -DISABLE_PREFFER_IPV6=1 -``` - -### 版本支持情况 -支持 [OpenWrt](https://openwrt.org/) 和 [ImmortalWrt](https://github.com/immortalwrt/immortalwrt) 所有版本 - -测试过的版本 - -- immortalwrt/imagebuilder:x86-64-openwrt-23.05.0-rc2 -- openwrtorg/imagebuilder:x86-64-22.03.3 -- openwrtorg/imagebuilder:rockchip-armv8-22.03.3 (R2S) -- immortalwrtorg/imagebuilder:rockchip-armv8-openwrt-21.02.4 (R2S) -- immortalwrtorg/imagebuilder:x86-64-openwrt-21.02.5 - -Nanopi 系列推荐使用 ImmortalWrt,因为其对 R2S 的优化更好,比如内存,ImmortalWrt 打了 [DMC patch](https://github.com/immortalwrt/immortalwrt/blob/master/target/linux/rockchip/patches-5.15/806-arm64-dts-rockchip-enable-dmc-for-rk3328-boards.patch),OpenWrt 没有 - -### 内置软件列表 - -- -- -- - - -## 自定义 - -OpenWrt 在首次启动时,会执行 `/etc/uci-defaults/` 目录下的所有脚本,因此您可以通过在该目录下添加脚本,来实现自定义功能。 - -自定义功能举例: - -- 设置默认密码 -- 添加信任 SSH 公钥 -- 添加 uci 脚本,实现自定义功能 - -示例:https://github.com/EkkoG/OpenWrt/wiki/%E8%87%AA%E5%AE%9A%E4%B9%89%E5%8A%9F%E8%83%BD%E4%B8%BE%E4%BE%8B - ## 致谢 感谢以下项目,使得我的上网体验又有所提升