packaging support for OpenWRT/ImmortalWRT ...

[evan0greenup]

Is it possible to provide some instruction or *.opkg package for OpenWRT or ImmortalWRT. Currently, they don't have tcp-brutal kernel module. As a result, the upload rate of sing-box on OpenWRT is limited.

It would be nice to provide such package for OpenWRT ecosystem.

[haruue]

Hello.

I've written a building guide for OpenWrt, but it's in Chinese.

https://github.com/haruue-net/openwrt-tcp-brutal

Here’s the English translation of its README by ChatGPT:

---

tcp-brutal for OpenWrt

This repository provides a build recipe to compile and install the tcp-brutal kernel module on OpenWrt.
You can either build it against an official SDK or integrate it into your own custom OpenWrt build.

---

Prerequisites

1. Prepare an OpenWrt build environment
   A Debian 12 Linux machine is usually sufficient.
   See the OpenWrt official guide for details on required packages.

2. Prepare the SDK that matches the version of OpenWrt you are currently running.

   • If your OpenWrt is a stable release downloaded from the official website, you can usually find the openwrt-sdk-<version>-*.tar.xz file on the download page. The version must match exactly with the one you are running.
   • If your OpenWrt is a snapshot downloaded from the official website, and you saved the SDK file at the time of download, you can use that.
     If you didn’t save it, unfortunately there is usually no prebuilt SDK available. In that case, reinstalling a stable release is recommended.
   • If your OpenWrt is a “custom build” downloaded from a third party, try to obtain the SDK from the download page, or ask the maintainer to compile this repository into their custom build. (Same applies if you built your own custom version.)

For demonstration purposes, the following instructions use the official OpenWrt 23.05.3 x86-64 SDK as an example.

---

Building with the SDK

1. Extract the SDK

   tar xf openwrt-sdk-23.05.3-x86-64_gcc-12.3.0_musl.Linux-x86_64.tar.xz
   cd openwrt-sdk-23.05.3-x86-64_gcc-12.3.0_musl.Linux-x86_64

2. Configure feeds
   Since tcp-brutal only depends on the kernel, no other feeds are required:

   echo "src-git tcp_brutal https://github.com/haruue-net/openwrt-tcp-brutal.git;master" > feeds.conf.default
   ./scripts/feeds update -a && ./scripts/feeds install -a

3. Compile

   make defconfig
   make package/feeds/tcp_brutal/tcp-brutal/compile

4. Locate the built package
   The .ipk will appear under a path like:

   <SDK root>/bin/targets/x86/64/packages/kmod-brutal_5.15.150+1.0.3-1_x86_64.ipk
   

5. Install on OpenWrt

   • Copy the .ipk to your router and run opkg install <file>.ipk, or
   • Use System → Software → Upload Package… in LuCI.

⚠️ Note: after every system upgrade, you must rebuild the module with the new SDK.

---

Integrating into a Custom OpenWrt Build

If you already know how to build OpenWrt:

1. Append the following line to your feeds.conf.default (do not replace the whole file):

   src-git tcp_brutal https://github.com/haruue-net/openwrt-tcp-brutal.git;master
   

2. Run make menuconfig, then go to:
   Kernel modules → Network Support → kmod-brutal and set it to <*>.