Client

Download ZTRelay

One Python client, with ready-made commands for SSH, port forwarding and Postgres. Point it at a route config from your dashboard and you're tunneling.

Loading the latest release…

Install

Unzip the release, then run the installer. It sets up its own Python environment, the routes/ folder, and the ztr_ssh, ztr_forward and ztr_pg commands, and asks before adding any background service, the Ferry file manager or the ZTR Proxy browser proxy. It works out whether you're on macOS or Linux by itself. Prefer a window? Run ./installer.sh --gui — it also creates your key and checks your route.

unzip ztrclient-*.zip
cd ztrclient
./installer.sh
Prefer to clone the repository?
# the repo nests the package one level deep — pull just that folder up
git clone https://github.com/igenius21fm/ztrclient.git ztrclient-src
mv ztrclient-src/ztrclient ztrclient && rm -rf ztrclient-src
cd ztrclient

Then, three steps

1

Register a key

Add an RSA key from the dashboard's Keys panel. It's required before you can create a route.

2

Create a route

Pick an exit country and hop count, then download the route's .ztr config into routes/.

3

Connect

Run ztr_ssh --rh "example._ztr" --rp 22, or any of the other commands below.

What's in the package

Commands

ztr_ssh, ztr_forward, ztr_pg

Open a tunnel and run a real SSH session, forward a local port, or connect psql. The tunnel closes when you exit.

Background service

Tunnel service

Keeps one route ready in the background, with its own local address, so every command starts a session instantly.

Dashboard

Local tunnel dashboard

A read-only web page on your machine: active tunnels, hop errors, and a live traffic view.

Request composer

ZTR Requests

A local Postman-style web UI for sending one-off requests through an authorized tunnel.

Optional

Example apps

View on GitHub

Reference target and client apps built on ztrclient — an HTTP proxy, a video streamer, an async drop-box, and a worker pool — live in their own repo. They import ztrclient as a sibling directory, so clone both:

mkdir ztrelay && cd ztrelay
git clone https://github.com/igenius21fm/ztrapps.git apps
git clone https://github.com/igenius21fm/ztrclient.git ztrclient-src && mv ztrclient-src/ztrclient ztrclient && rm -rf ztrclient-src
cd ztrclient && ./installer.sh
Full apps setup & docs →