Skip to content

Commit 54c4f82

Browse files
committed
docs: clarify OpenWrt install notes (git-http, ca-bundle, wget compatibility)
1 parent c8393f9 commit 54c4f82

1 file changed

Lines changed: 23 additions & 1 deletion

File tree

README.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ sh install.sh # auto-detects arch, downloads latest binary
154154
sh install.sh --port 11112 --interval 1s
155155
```
156156

157-
> [!NOTE]
157+
> [!TIP]
158158
> *The installer automatically enables and starts the init.d service.*
159159
> The OpenWrt init script is installed with `START=99` so it comes up late in boot, registers with procd immediately, and waits through a brief overlay-mount race before `exec`-ing `/usr/bin/cake-stats`. A matching `iface` hotplug fallback also starts it later if netifd finishes after the rc.d boot window. The installer fails immediately if `enable` or `start` does not succeed. If you install by hand make sure to run:
160160
> ```sh
@@ -167,6 +167,28 @@ sh install.sh --port 11112 --interval 1s
167167
> ```
168168
> Services that are not enabled will not start after a reboot.
169169
170+
> [!NOTE]
171+
> **OpenWrt notes from community feedback:**
172+
>
173+
> - If you plan to install on-router using `git clone`, many OpenWrt builds ship a minimal `git` without HTTPS support. Replace it with `git-http` and install the CA bundle to enable HTTPS access to GitHub:
174+
>
175+
> ```sh
176+
> opkg update
177+
> opkg remove git
178+
> opkg install git-http ca-bundle
179+
> ```
180+
>
181+
> `git-http` provides HTTPS-capable `git` and `ca-bundle` supplies root certificates required to verify GitHub (or other HTTPS) hosts.
182+
>
183+
> - Some OpenWrt images include a trimmed `wget` that does not support the `--show-progress` option. If `sh install.sh` fails with `wget: unrecognized option: show-progress`, either edit `install.sh` to remove the `--show-progress` flag, or install a full `wget`/`curl` package on the router before running the installer:
184+
>
185+
> ```sh
186+
> opkg install wget curl
187+
> # or edit install.sh and remove the --show-progress argument
188+
> ```
189+
>
190+
> Alternatively, download a prebuilt binary from the Releases page and copy it to `/usr/bin` on the router.
191+
170192
### Install on systemd Linux
171193
```bash
172194
sudo sh install.sh

0 commit comments

Comments
 (0)