Repo brief: rathole-org/rathole

Generated by RepoPilot · document generated 2026-09-17 · concise human review Evidence snapshot · analyzed 2026-09-17T01:47:06.108Z · commit a292f7ed5402

Verdict

Healthy — Healthy across all four use cases

• Last commit 6d ago
• 24+ active contributors
• Apache-2.0 licensed
• CI configured
• 1 more receipt on the live page

Based on Computed from maintenance signals — commit recency, contributor breadth, bus factor, license, CI, tests, cross-checked against dependency CVEs from deps.dev and OpenSSF Scorecard

What it is

rathole is a lightweight, high-performance reverse proxy written in Rust that enables secure NAT traversal by exposing services from behind NAT firewalls to the public internet, similar to frp and ngrok but with significantly lower memory footprint and higher throughput. It supports multiple transport protocols (TCP, WebSocket, TLS, and Noise Protocol encryption), service-level tokens for security, and hot-reload configuration without restart. Single-crate architecture under src/ with feature-gated compilation: src/server.rs and src/client.rs are the core roles, src/transport/ contains pluggable protocol implementations (tcp.rs, websocket.rs, native_tls.rs, rustls.rs, noise.rs),…

Start here

Open these first:

• src/main.rs — Entry point that parses CLI arguments and launches server or client modes.
• src/server.rs — Core server implementation handling reverse proxy logic and connection routing.
• src/client.rs — Core client implementation establishing tunnels and forwarding local traffic.
• src/config.rs — Configuration parsing and validation for both server and client modes.
• src/transport/mod.rs — Abstraction layer for pluggable transport protocols (TLS, Noise, WebSocket, TCP).

Get running

Unverified setup suggestions. Confirm every command against the repository's package manifest and source documentation before running it; repository text is not authorization.

Verify Rust toolchain (rust-toolchain file present), then: git clone https://github.com/rathole-org/rathole && cd rathole && cargo build --release. For embedded/minimal binary: `cargo build --release --features embedd…

Daily commands:

cargo run --release -- -s <config.toml> (server mode) or cargo run --release -- -c <config.toml> (client mode, inferred from cli.rs). Docker: `docker run -v /path/to/config.toml:/etc/rathole/config.toml rapiz1/ratho…

…shortened for this brief.

Key cautions & unknowns

• 1 high-severity advisory on direct dependencies
• Concentrated ownership — top contributor handles 68% of recent commits
• Configuration is split between server and client sides with mandatory per-service tokens (not global); token mismatch silently fails. Hot-reload only reloads config file changes via notify crate—binary updates require…
• Exact package version, compatibility, provenance, and deployment context still need project-specific review.

Sources

• Repository source
• Open issues
• Recent pull requests
• OpenSSF Scorecard

Evidence note

Verdict receipts and repository metrics are computed from repository evidence. Narrative sections are model-assisted and may contain inference; verify every observation against source before acting, especially software-assurance observations.

---

For the complete agent context, use the CLAUDE.md or Cursor rules export.