Skip to content

v0.1.0

Choose a tag to compare

@0ArchLinux0 0ArchLinux0 released this 30 Aug 06:24
· 29 commits to main since this release

tunnelcat v0.1.0

First public release of tunnelcat — a self-hosted, control-plane-free
mesh VPN built on Tailscale's data plane.

What works in v0.1.0

  • tunnelcat up starts a server, prints a connection token
  • tunnelcat dial <token> --port 12345 connects through a real
    WireGuard tunnel with NAT traversal and an echo round-trip
  • Real public DERP relay (derp-1, San Francisco), real WireGuard
    handshake, real UDP hole-punching
  • 12 unit tests + 1 end-to-end test, all passing
  • End-to-end test runs in 1.5s

What's NOT in v0.1.0

This is M0 in the roadmap.
It works for the 1:1 case. M1 (one friend can use it), M2 (Rust
novelty), M3 (coord server) come next.

Install

# macOS / Linux one-liner:
curl -fsSL https://github.com/0ArchLinux0/tunnelcat/releases/latest/download/install.sh | sh

# Or pick a specific version:
curl -fsSL https://github.com/0ArchLinux0/tunnelcat/releases/download/v0.1.0/install.sh | sh

The installer detects your OS/arch, downloads the right tarball,
verifies the SHA, and installs to /usr/local/bin/tunnelcat.

Manual install

Download the tarball for your platform, extract, and put tunnelcat
on your $PATH:

# Example for macOS arm64:
curl -fsSL https://github.com/0ArchLinux0/tunnelcat/releases/download/v0.1.0/darwin-arm64.tar.gz | tar -xz
sudo mv darwin-arm64/tunnelcat /usr/local/bin/

Available tarballs: darwin-arm64, darwin-amd64, linux-amd64,
linux-arm64, windows-amd64.

Try it (5 minutes)

# Terminal 1 (server):
tunnelcat up
# → 🐈 Server listening with new address: tcomABC...

# Terminal 2 (client), with the token from above:
tunnelcat dial tcomABC... --port 12345
# type stuff, see it echoed

The whole tunnel comes up in about 1 second. No Tailscale account
required. No registration. Just a token.

Known limitations

  • Only 1:1 connections (no mesh, no coord server, no services).
    This is M0; the mesh lands in M1–M3 per the roadmap.
  • macOS arm64 and amd64 binaries include the Rust bridge (FFI to
    the type-state protocol crate). Linux and Windows binaries
    don't (cross-compiling cgo requires a cross C toolchain we
    don't have set up yet — the bridge is a stub returning an
    error; the rest of tunnelcat works fine.
  • The default port for is 12345 (placeholder). Stage 6
    will add named services.

License

BSD 3-Clause, same as upstream tailcat.
NOTES_EOF
)