From 92f5c579e61af798ae00b8e7ada3c7521224394f Mon Sep 17 00:00:00 2001 From: Steven Polley Date: Thu, 25 Apr 2024 21:21:27 -0600 Subject: [PATCH] add README.md --- hypd/examples/openwrt-wireguard/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 hypd/examples/openwrt-wireguard/README.md diff --git a/hypd/examples/openwrt-wireguard/README.md b/hypd/examples/openwrt-wireguard/README.md new file mode 100644 index 0000000..19ec877 --- /dev/null +++ b/hypd/examples/openwrt-wireguard/README.md @@ -0,0 +1,12 @@ +# Using hyp with OpenWrt Wireguard + +This example case is to deploy hypd on OpenWrt to open up access to the WireGuard VPN service. + +hyp utilizes eBPF technology to ensure runtime overhead is extremely small (in a way, but in a way not). Most Linux distributions have support for this out of the box, however OpenWrt does not. OpenWrt has a very stripped down, purpose-configured kernel and does not have the requirements built in to run hyp. + +The good news is, you can build OpenWrt yourself and configure it with the requirements. Follow the directions at this page: https://openwrt.org/docs/guide-developer/toolchain/use-buildsystem + +When you run *make menuconfig*, make sure you check off *Enable additional BTF type information* which is also known as CONFIG_KERNEL_DEBUG_INFO_BTF. This is required to support eBPF CO:RE. + +![Kernel Config](https://deadbeef.codes/steven/hyp/raw/branch/main/hypd/examples/openwrt-wireguard/kernel_config.png) +