install

Additional install commands

macOS

Homebrewverified · 100%

brew install overtls

local Homebrew formula metadata

overview

Package summary

Simple proxy tunnel for bypassing the GFW

Project links

Commands and aliases

overtls-bin

history

Project history and usage

overtls is a Rust client-and-server SOCKS5 proxy tunnel that transports TCP and UDP traffic over TLS. It is explicitly intended for circumventing network filtering by making the tunnel resemble ordinary TLS traffic.

Project history

The ShadowsocksR-Live project developed overtls as a Rust implementation of the OverTLS portion of SSRoT, omitting the broader Shadowsocks and ShadowsocksR protocol layers. Its stated goal is a concise SOCKS5 proxy tunnel carrying TCP and UDP traffic through TLS.

Adoption history

The project provides Cargo installation, release binaries, source builds, Docker material, and Linux installation scripts. The supplied metadata confirms Homebrew packaging, while the repository's platform code and scripts cover additional client and server environments.

How it is used

Both roles use `overtls-bin` with `-r server` or `-r client` and a configuration selected with `-c config.json`. The shared JSON configuration defines a unique tunnel path plus server certificate, forwarding, listening, and client endpoint settings.

Why package nerds care

overtls is of interest as a compact Rust networking package that combines client and server roles in one executable and represents a specialized censorship-circumvention approach built directly around TLS traffic.

Timeline

2020: The public overtls repository began its release and development history.
2026: The repository remained active with Rust, Docker, Apple, Android, and installation components.

Related projects

SSRoT: The related design from which overtls retains the OverTLS component.
nginx and Caddy: Reverse proxies documented for fronting or disguising an overtls server.
Let's Encrypt: The certificate authority recommended by the installation documentation.

Sources

https://github.com/ShadowsocksR-Live/overtls#readme
https://github.com/ShadowsocksR-Live/overtls/blob/master/config.json
source_facts.package-manager

security posture

Risk level: green

narrow executable package without higher-risk signals.

Risk classifier

green risk · low confidence · appliance

Why

narrow executable package without higher-risk signals

Signals

metadata:no-higher-risk-signals

Install behavior

No Homebrew post-install hook is recorded in formula metadata.
Homebrew bottle metadata is available for 6 platform targets.
Build metadata lists 1 build dependencies.

Recommended review

Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.

local files

Configuration and credential file locations

These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval.

Configuration files

Config paths the tool may read or write during local use.

Unix: config.json

Credential files

Credential-bearing paths to review before unattended agent runs.

Unix: config.json

executables

Installed executables

Command	Kind	Exposure	Note
`overtls-bin`	cli	global executable

freshness

Version and freshness

These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.

page generated2026-09-19

manager version0.3.13

manager updated2026-09-11

local dataok

upstreamcurrent

latest detectedv0.3.13

https://github.com/ShadowsocksR-Live/overtls

okNo freshness warnings were generated.

install metadata

Package metadata

Package key	brew:overtls
Version	0.3.13
Package manager	Homebrew
Package manager page	https://formulae.brew.sh/formula/overtls
Homepage	https://github.com/ShadowsocksR-Live/overtls
Repository	https://github.com/ShadowsocksR-Live/overtls
License	MIT
Source archive	https://github.com/ShadowsocksR-Live/overtls/archive/refs/tags/v0.3.13.tar.gz
Last updated	2026-09-11T17:45:56Z
Pulse	updated
Build dependencies	rust
Bottle	available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-install	not defined
Service	none declared

registry facts

Source database details

Source Database	Homebrew formula API
Tap	homebrew/core
Full Name	overtls
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

package graph

Links come from deterministic package relationships, av.db category and tag curation, ecosystem matches, and package hub membership.

source trail

Generated from repository data

This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/overtls.yml

Used sources

Geiger risk classifier
cross-ecosystem install command graph
curated configuration and credential file locations
curated package history
package relationship graph
package version freshness
package-page enrichment
pkg.so package database
pkgdb category and tag curation

Install overtls with Homebrew