Skip to content

Commit 0e0abc3

Browse files
committed
Add TIP on increasing UDP buffer size for better performance in README
Updated README to include a TIP on improving transfer speeds by increasing UDP socket buffer size. Added instructions for granting `CAP_NET_ADMIN` to `wush` for enhanced performance.
1 parent b6f07ad commit 0e0abc3

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,15 @@ curl -fsSL https://wush.dev/install.sh | sh
2525

2626
For a manual installation, see the [latest release](https://github.com/coder/wush/releases/latest).
2727

28+
> [!TIP]
29+
> To increase transfer speeds, `wush` attempts to increase the buffer size of
30+
> its UDP sockets. For best performance, ensure `wush` has `CAP_NET_ADMIN`. When
31+
> using the installer script, this is done automatically for you.
32+
>
33+
> ```bash
34+
> sudo setcap cap_net_admin=eip $(which wush)
35+
> ```
36+
2837
## Basic Usage
2938
3039
[![asciicast](https://asciinema.org/a/ZrCNiRRkeHUi5Lj3fqC3ovLqi.svg)](https://asciinema.org/a/ZrCNiRRkeHUi5Lj3fqC3ovLqi)

0 commit comments

Comments
 (0)