Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

volto

This manual covers volto, a MASQUE proxy server written in Rust. One QUIC connection from the client carries TCP through classic CONNECT (RFC 9114 §4.4) and UDP through CONNECT-UDP (RFC 9298, HTTP Datagrams per RFC 9297), both dispatched by the :protocol pseudo-header. It terminates TLS itself, runs unattended on a small Linux host, reloads certificates and credentials on SIGHUP, and ships as a static binary. It is built to interoperate with Surge’s masque policy.

Surge opens one QUIC connection carrying CONNECT and CONNECT-UDP tunnels to volto, optionally through an L4 UDP relay; volto reaches TCP targets over plain TCP and UDP targets over plain UDP

Install

One line on a fresh Ubuntu host downloads the newest release for the architecture, verifies it against SHA256SUMS, creates the system user, generates a self-signed certificate and a password, writes /etc/volto/config.toml, installs the systemd unit and starts it:

curl -fsSL https://raw.githubusercontent.com/vcarus/volto/main/script/deploy.sh |
  sudo bash -s -- --enable-timer --username yourname

It finishes by printing a ready-to-paste client policy line. Every flag, the certificate options and the tarball route are in the deployment chapter.

This manual

  • Configuration — every key, its default, and what it costs to change.
  • Deployment — building, certificates (ACME DNS-01 or self-signed plus pinning), releases and rollback, systemd, firewall, fd budget, reloads, relays, fail2ban.
  • Architecture — how a request becomes a tunnel, the in-tree HTTP/3 layer, why quinn-proto is patched, and what the tests assert.

Reference

  • API documentation — the crate’s rustdoc, rebuilt from main on every push.
  • Source repository — the code, the issue tracker, and the tracked copy of these pages.
  • Releases — static musl binaries for x86_64 and aarch64, with SHA256SUMS.
  • Security policy — how to report a vulnerability privately.