Skip to content

Installation

The install script downloads the binary, creates a systemd service, generates a secret, and prints the connection link:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | sh

Customize with environment variables:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | PORT=8443 EE_DOMAIN=www.google.com sh

Multiple Secrets

Auto-generate several secrets at once:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | SECRET_COUNT=3 sh

Or pass your own as a comma-separated list:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | \
  SECRET=aabbccdd11223344aabbccdd11223344,eeff00112233445566778899aabbccdd sh

Numbered secrets with labels and per-secret connection limits:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | \
  SECRET_1=aabbccdd11223344aabbccdd11223344 SECRET_LABEL_1=family \
  SECRET_2=eeff00112233445566778899aabbccdd SECRET_LABEL_2=work SECRET_LIMIT_2=500 \
  sh

Each secret gets its own QR code and connection link at the end of installation. You can also add or remove secrets later by editing the config and reloading:

nano /etc/teleproxy/config.toml
systemctl reload teleproxy

After installation, manage with:

systemctl status teleproxy       # check status
systemctl reload teleproxy       # reload config after editing
nano /etc/teleproxy/config.toml  # edit config (secrets, ports, etc.)

To uninstall:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | sh -s -- --uninstall

Updating

Re-run the install script to upgrade to the latest version:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | sh

The script replaces the binary and restarts the service. Your existing config (/etc/teleproxy/config.toml) — including secrets, ports, and domain settings — is preserved.

To pin a specific version:

curl -sSL https://raw.githubusercontent.com/teleproxy/teleproxy/main/install.sh | TELEPROXY_VERSION=1.2.3 sh

Static Binary (Any Linux)

Pre-built static binaries are published with every release — statically linked against musl libc, zero runtime dependencies. Download and run.

curl -Lo teleproxy https://github.com/teleproxy/teleproxy/releases/latest/download/teleproxy-linux-amd64
chmod +x teleproxy

curl -Lo teleproxy https://github.com/teleproxy/teleproxy/releases/latest/download/teleproxy-linux-arm64
chmod +x teleproxy

SHA256 checksums are published alongside each release for verification.

Docker

See Docker Quick Start for the simplest way to run Teleproxy — a single docker run command with auto-generated secrets.

Building from Source

Install build dependencies:

apt install git curl build-essential libssl-dev zlib1g-dev

yum groupinstall "Development Tools"
yum install openssl-devel zlib-devel

brew install epoll-shim openssl

macOS builds use epoll-shim to wrap kqueue behind the Linux epoll API, and Homebrew OpenSSL (keg-only). This is intended for local development — production deployments should use Linux.

Clone and build:

git clone https://github.com/teleproxy/teleproxy
cd teleproxy
make

The compiled binary will be at objs/bin/teleproxy.

Note

If the build fails, run make clean before retrying.