Skip to content

Commit 1ba700f

Browse files
committed
README.md: add info about kernel requirements
1 parent 41039dc commit 1ba700f

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,22 @@ Options:
203203
-V, --version Print version
204204
```
205205

206+
> [!WARNING]
207+
> Kernel Requirements for Stand-alone Usage
208+
>
209+
> If you plan to run **aa-proxy-rs** on your own system (outside of the provided system images), be aware that additional **custom kernel modules** are required for full functionality. These modules are not upstreamed and must be built separately.
210+
211+
You can find the necessary patches here:
212+
👉 **[https://github.com/aa-proxy/buildroot/tree/main/external/patches/linux](https://github.com/aa-proxy/buildroot/tree/main/external/patches/linux)**
213+
214+
Please keep this in mind when creating your own custom solution with `aa-proxy-rs`.
215+
216+
To achieve full functionality similar to the official Buildroot-based images, make sure the following kernel options are enabled as well:
217+
- CONFIG_USB_CONFIGFS_UEVENT
218+
- CONFIG_USB_CONFIGFS_F_ACC
219+
- CONFIG_BT_RFCOMM
220+
- CONFIG_BT_RFCOMM_TTY
221+
206222
## Manual configuration
207223
Default startup config file is `/etc/aa-proxy-rs/config.toml`.
208224

0 commit comments

Comments
 (0)