# Install wstunnel with Homebrew, MacPorts, Nix, scoop

Tunnel all your traffic over Websocket or HTTP2. Version 10.6.1 via Homebrew; verified 2026-06-29.

## Install

```sh
sudo av install brew:wstunnel
```

Additional install commands:

### macOS

- Homebrew (100%):

```sh
brew install wstunnel
```

  Evidence: local Homebrew formula metadata

- MacPorts (94%):

```sh
sudo port install wstunnel
```

  Evidence: MacPorts ports tree: net/wstunnel/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1

### Linux

- Nix (92%):

```sh
nix profile install nixpkgs#wstunnel
```

  Evidence: nixpkgs package indexes: pkgs/by-name/ws/wstunnel/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1

### Windows

- Scoop (92%):

```sh
scoop install main/wstunnel
```

  Evidence: Scoop official bucket manifest trees: bucket/wstunnel.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1

## Package facts

- **Package key:** brew:wstunnel
- **Package manager:** Homebrew
- **Package manager page:** <https://formulae.brew.sh/formula/wstunnel>
- **Version:** 10.6.1
- **Source summary:** Tunnel all your traffic over Websocket or HTTP2
- **Homepage:** <https://github.com/erebe/wstunnel>
- **Repository:** <https://github.com/erebe/wstunnel>
- **Upstream docs:** <https://github.com/erebe/wstunnel#readme>
- **License:** BSD-3-Clause
- **Source archive:** <https://github.com/erebe/wstunnel/archive/refs/tags/v10.6.1.tar.gz>
- **Last updated:** 2026-06-29T11:32:54Z
- **Generated:** 2026-07-08T18:08:21+00:00

## Executables

- wstunnel (cli)
- wstunnel (alias)

## Build dependencies

- rust

## Install behavior

- Post-install hook: not defined
- Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## Freshness

- Page generated: 2026-07-08
- Package-manager version: 10.6.1
- Package-manager updated: 2026-06-29
- Local data: ok
- Upstream repository: https://github.com/erebe/wstunnel
- Upstream latest detected: v10.6.1 (current)
## Project history and usage

wstunnel is a tunneling tool that carries arbitrary traffic over WebSocket or HTTP/2, aiming to look like ordinary HTTP-family traffic on networks where direct protocols are blocked by firewalls, proxies, or DPI systems. It supports static and reverse tunnels, TCP, UDP, Unix sockets, stdio, SOCKS5, HTTP proxy mode, TLS, mTLS, IPv6, and standalone binaries.

### Project history

The upstream README says wstunnel was inspired by an older npm package named `wstunnel`, but was remade so users would not need npm and Node.js. The project was originally written in Haskell and later moved to Rust; the README calls v7.0.0 a complete Rust rewrite that is not compatible with earlier versions and keeps the previous Haskell implementation on a separate branch.

The Rust rewrite was motivated by maintenance and performance concerns. The maintainer cites lower jitter from avoiding Haskell garbage collection, a more homogeneous command-line interface, reverse tunneling support, traffic that better resembles normal traffic, and easier long-term maintenance because the Haskell ecosystem had become harder for the maintainer to keep up with.

### Adoption history

wstunnel's adoption is concentrated among users who need a single-file tunnel that can survive HTTP-only or proxy-constrained networks. The README's examples cover ordinary port forwarding, UDP DNS forwarding, SOCKS5 and HTTP proxy modes, transparent proxying, Unix sockets, and using stdio as an SSH ProxyCommand transport.

The GitHub releases page shows an active v10 series, and the project publishes container images through GitHub Packages in addition to binary releases. That packaging footprint reflects its operational audience: people copying a tunnel binary or container to constrained client and server environments.

### How it is used

A common pattern is to run a public wstunnel server and then start a local client with one or more `-L` local-to-remote forwards or `-R` remote-to-local forwards. For SSH, the README documents a stdio tunnel suitable for `ssh -o ProxyCommand=...`; for browser or whole-session use, it can expose SOCKS5 or HTTP proxy listeners.

The tool is often used where WebSocket over TLS is more likely to pass through middleboxes than raw SSH, WireGuard, or application-specific TCP/UDP traffic. The README cautions that HTTP/2 tunneling is harder behind reverse proxies and CDNs because buffering and protocol conversion can break streaming.

### Why package nerds care

wstunnel is notable because it sits in the pragmatic tunneling family with tools such as chisel, gost, boringproxy, and SSH ProxyCommand setups, but keeps a very explicit WebSocket/HTTP transport identity. The Haskell-to-Rust rewrite also makes it a useful example of a network utility migrating runtimes to improve distribution and maintenance.

### Timeline

- Original era: wstunnel was implemented in Haskell, inspired by an npm WebSocket tunnel package.
- v7.0.0: The project was rewritten in Rust with an incompatible command-line and protocol transition from the Haskell version.
- 2020s: The README documents WebSocket and HTTP/2 transports, reverse tunneling, SOCKS5/HTTP proxy modes, mTLS, IPv6, and standalone binaries.
- 2026: The GitHub releases page lists active v10.x releases.

### Related projects

- The README links the older npm `wstunnel` package as the inspiration for this implementation.
- The README points to the Haskell branch for users interested in the pre-v7 implementation.

### Sources

- <https://github.com/erebe/wstunnel#readme>
- <https://github.com/erebe/wstunnel/pkgs/container/wstunnel>
- <https://github.com/erebe/wstunnel/releases>
- <https://github.com/erebe/wstunnel/tree/haskell>


## Security Notes

broad file, network, media, or database tool signal.

- **Geiger risk:** blue / medium
- broad file, network, media, or database tool signal

## Source Database Details

- **Source Database:** Homebrew formula API
- **Tap:** homebrew/core
- **Full Name:** wstunnel
- **Version Scheme:** 0
- **Revision:** 0
- **Head Version:** HEAD
- **Bottle Stable Root URL:** <https://ghcr.io/v2/homebrew/core>
- **Deprecated:** no
- **Disabled:** no
- **Keg Only:** no
- **URL Keys:** head, stable

## Other Package-Manager Records

- Nix - wstunnel: normalized package name match | nixpkgs package indexes: pkgs/by-name/ws/wstunnel/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1
- MacPorts - wstunnel: normalized package name match | MacPorts ports tree: net/wstunnel/Portfile from https://api.github.com/repos/macports/macports-ports/git/trees/master?recursive=1
- Scoop - main/wstunnel: normalized package name match | Scoop official bucket manifest trees: bucket/wstunnel.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1


## Related links

- [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family.
- [Secret-risk packages](https://www.automicvault.com/pkg/secret-risk-packages/) - Has protected-tool coverage, approval-gate, or non-low Geiger security signals.
- [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Networking and protocol packages](https://www.automicvault.com/pkg/networking-protocol-tools/) - Matched network, protocol, or remote-service metadata.
- [rust](https://www.automicvault.com/pkg/brew/rust/) - Build dependency declared by Homebrew.
- [ptunnel](https://www.automicvault.com/pkg/brew/ptunnel/) - Shares av.db curated category or tags: cli, networking, proxy, tunneling.
- [cloudflared](https://www.automicvault.com/pkg/brew/cloudflared/) - Shares av.db curated category or tags: cli, networking, proxy, tunneling.
- [jprq](https://www.automicvault.com/pkg/brew/jprq/) - Shares av.db curated category or tags: cli, networking, tunneling.
- [localtunnel](https://www.automicvault.com/pkg/brew/localtunnel/) - Shares av.db curated category or tags: cli, networking, tunneling.
- [openiothub-server](https://www.automicvault.com/pkg/brew/openiothub-server/) - Shares av.db curated category or tags: cli, networking, tunneling.
- [pgrok](https://www.automicvault.com/pkg/brew/pgrok/) - Shares av.db curated category or tags: cli, networking, tunneling.
- [proxytunnel](https://www.automicvault.com/pkg/brew/proxytunnel/) - Shares av.db curated category or tags: cli, networking, proxy, tunneling.
- [rospo](https://www.automicvault.com/pkg/brew/rospo/) - Shares av.db curated category or tags: cli, networking, proxy, tunneling.
- [sixtunnel](https://www.automicvault.com/pkg/brew/sixtunnel/) - Local package facts share a topical domain. Shared terms: cli, networking, proxy, tunnel, tunneling.
- [gotun](https://www.automicvault.com/pkg/brew/gotun/) - Local package facts share a topical domain. Shared terms: cli, networking, over, proxy, tunneling.

## Combined YAML source

View the package source record on GitHub. [combined/wstunnel.yml](https://github.com/automic-vault/db/blob/main/combined/wstunnel.yml)


## Sources

- Nucleus package database
- Geiger risk classifier
- package-page enrichment
- curated package history
- package version freshness
- av.db category and tag curation
- package relationship graph
- external package-manager database matches
- cross-ecosystem install command graph
