Console client · Flutter-based app · App store · Play store

---

Table of Contents

• Introduction
• Server Features
• Client Features
• Quick start
  • Endpoint setup
    • Install the endpoint
    • Updating the endpoint
    • TrustTunnel Flutter Client 1.0 Warning
    • Endpoint configuration wizard
    • Let's Encrypt certificate lifecycle
    • Running endpoint
    • Export client configuration
  • Client setup
    • Install the client
    • Updating the client
    • Client configuration wizard
    • Running client
• See also
• Roadmap
• License

---

Introduction

TrustTunnel is a modern, open-source VPN protocol originally developed by AdGuard VPN and now available for anyone to use and audit.

It delivers fast, secure, and reliable VPN connections without the usual trade-offs. By design, TrustTunnel traffic is indistinguishable from regular HTTPS traffic, allowing it to bypass throttling and deep-packet inspection while maintaining strong privacy protections.

The TrustTunnel project includes the VPN endpoint (this repository), the library and CLI for the client, and the GUI application.

Server Features

• VPN Protocol: The library implements the VPN protocol compatible with HTTP/1.1, HTTP/2, and QUIC. By mimicking regular network traffic, it becomes impossible to detect and block.

• Flexible Traffic Tunneling: TrustTunnel can tunnel TCP, UDP, and ICMP traffic to and from the client.

• Platform Compatibility: The server is compatible with Linux and macOS. The client is available for Android, Apple, Windows, and Linux.

---

Client Features

• Traffic Tunneling: The library is capable of tunneling TCP, UDP, and ICMP traffic from the client to the endpoint and back.

• Cross-Platform Support: It supports Linux, macOS, and Windows platforms, providing a consistent experience across different operating systems.

• System-Wide Tunnel and SOCKS5 Proxy: It can be set up as a system-wide tunnel, utilizing a virtual network interface, as well as a SOCKS5 proxy.

• Split Tunneling: The library supports split tunneling, allowing users to exclude connections to certain domains or hosts from routing through the VPN endpoint, or vice versa, only routing connections to specific domains or hosts through the endpoint based on an exclusion list.

• Custom DNS Upstream: Users can specify a custom DNS upstream, which is used for DNS queries routed through the VPN endpoint.

---

Quick start

Endpoint setup

Install the endpoint

An installation script is available that can be run with the following command:

curl -fsSL https://raw.githubusercontent.com/TrustTunnel/TrustTunnel/refs/heads/master/scripts/install.sh | sh -s -

The installation script will download the prebuilt package from the latest GitHub release for the appropriate system architecture and unpack it to /opt/trusttunnel. The output directory could be overridden by specifying -o DIR flag at the end of the command above.

If you want to install a specific version (instead of the latest), use -V <version>:

curl -fsSL https://raw.githubusercontent.com/TrustTunnel/TrustTunnel/refs/heads/master/scripts/install.sh | sh -s - -V <version>

Note

Currently only linux-x86_64 and linux-aarch64 architectures are provided for the prebuilt packages.

Updating the endpoint

The installation script always installs the latest available version. So, to update your installation, run the install command again:

curl -fsSL https://raw.githubusercontent.com/TrustTunnel/TrustTunnel/refs/heads/master/scripts/install.sh | sh -s -

This re-runs the installer and replaces the binaries in the installation directory (/opt/trusttunnel by default, or the directory you specified with -o DIR).

Note

Don't forget to stop the endpoint before updating:

sudo systemctl stop trusttunnel

To start the endpoint again after updating:

sudo systemctl start trusttunnel

TrustTunnel Flutter Client 1.0 Warning

Warning

TrustTunnel Flutter Client doesn't support self-signed certificates yet. If you want to use the TrustTunnel Flutter Client, you should have a valid certificate issued by a publicly trusted Certificate Authority (CA) associated with a registered domain for the IP address of the endpoint. Otherwise, the TrustTunnel Flutter Client will be unable to connect to the endpoint.

Endpoint configuration wizard

Please refer to the CONFIGURATION.md for the more detailed documentation on how to configure the endpoint.

The installation directory contains setup_wizard binary that helps generate the config files required for the endpoint to run:

cd /opt/trusttunnel/
./setup_wizard -h

The setup wizard supports interactive mode, so you could run it and it will ask for data required for endpoint configuration.

cd /opt/trusttunnel/
sudo ./setup_wizard

Note

sudo is required to manage TLS certificates properly.

The wizard will ask for the following fields, some of them have the default values you could safely use:

• The address to listen on - specify the address for the endpoint to listen on. Use 0.0.0.0:443 for native deployments (HTTPS on all interfaces). If you run with Docker port mapping 443:8443, set it to 0.0.0.0:8443.

• Path to credentials file - path where the user credentials for authorization will be stored.

• Username - the username the user will use for authorization.

• Password - the user's password.

• Add one more user? - select yes if you want to add more users, or no to continue the configuration process.

• Path to the rules file - path to store the filtering rules.

• Connection filtering rules - you can add rules that the endpoint will use to allow or disallow user's connections based on:

  • Client IP address
  • TLS random prefix
  • TLS random with mask

  Press n to allow all connections.

• Path to a file to store the library settings - path to store the main endpoint configuration file.

• Certificate selection - choose how to obtain a TLS certificate:

  • Issue a Let's Encrypt certificate (requires a public domain) - the setup wizard has built-in ACME support and can automatically obtain a free, publicly trusted certificate from Let's Encrypt. You'll need:
    • A registered domain pointing to your server's IP address
    • Port 80 accessible from the internet (for HTTP-01 challenge), or
    • Ability to add DNS TXT records (for DNS-01 challenge)
  • Generate a self-signed certificate - suitable for testing or when using the CLI client only. Note: The Flutter client does not support self-signed certificates yet.
  • Provide path to existing certificate - use your own certificate files obtained from another CA or tool like certbot.

• Path to a file to store the TLS hosts settings - path to store the TLS host settings file.

At this point all required configuration files are created and saved on disk.

Let's Encrypt certificate lifecycle

The setup wizard can obtain a Let's Encrypt certificate during initial setup, but you are responsible for ensuring it stays valid over time (renewal and service reload/restart).

If you're using Certbot to manage certificates and renew them automatically, follow the guide in CERT_RENEWAL.md.

Running endpoint

The installed package contains the systemd service template, named trusttunnel.service.template.

This template can be used to set up the endpoint as a systemd service:

Note

The template file assumes that the TrustTunnel Endpoint binary and all its configuration files are located in /opt/trusttunnel and have the default file names. Modify the template if you have used the different paths.

cd /opt/trusttunnel/
cp trusttunnel.service.template /etc/systemd/system/trusttunnel.service
sudo systemctl daemon-reload
sudo systemctl enable --now trusttunnel

Export client configuration

The endpoint binary can generate client configurations in two formats:

Deep-Link Format (Default)

Generate a compact tt://? URI suitable for QR codes and mobile apps:

# <client_name> - name of the client those credentials will be included in the configuration
# <address> - `ip`, `ip:port`, `domain`, or `domain:port` that the client will use to connect
#           If only `ip` or `domain` is specified, the port from the `listen_address` field will be used
cd /opt/trusttunnel/
./trusttunnel_endpoint vpn.toml hosts.toml -c <client_name> -a <address>

# Or explicitly specify the format:
./trusttunnel_endpoint vpn.toml hosts.toml -c <client_name> -a <address> --format deeplink

This outputs a tt://? deep-link URI that can be:

• Shared directly with mobile clients
• Used with the CLI client or TrustTunnel Flutter Client

When --generate-client-random-prefix is used, the endpoint also appends an allow rule for the generated value to the rules.toml file referenced from vpn.toml.

Note: If your certificate is signed by a trusted CA (e.g., Let's Encrypt), it will be automatically omitted from the deep-link to keep it compact. Self-signed certificates are included automatically.

TOML Format (For CLI Client)

Generate a traditional TOML configuration file:

cd /opt/trusttunnel/
./trusttunnel_endpoint vpn.toml hosts.toml -c <client_name> -a <public_ip> --format toml

This outputs a TOML configuration file suitable for the CLI client.

Both formats contain all necessary information to connect to the endpoint. See the TrustTunnel Flutter Client documentation for setup instructions.

Congratulations! You've done setting up the endpoint!

Client setup

You have a choice to use a CLI client or a GUI client (available on App Store and Play Store).

Install the client

Linux / macOS

An installation script is available:

curl -fsSL https://raw.githubusercontent.com/TrustTunnel/TrustTunnelClient/refs/heads/master/scripts/install.sh | sh -s -

The installation script will download the prebuilt package from the latest GitHub release for the appropriate system architecture and unpack it to /opt/trusttunnel_client. The output directory could be overridden by specifying -o DIR flag at the end of the command above.

Note

Install script supports x86_64, aarch64, armv7, mips and mipsel architectures for linux and arm64 and x86_64 for macos.

Windows

Download the latest release archive from the TrustTunnel Client releases page.

Extract the archive to a directory of your choice, for example C:\TrustTunnel\.

Router setup

For router deployments, please refer to router-specific client installation guides.

• Keenetic routers: TrustTunnel-Keenetic (guide in Russian)

Updating the client

Linux / macOS

The installation script always installs the latest available version. So, to update your installation, run the install command again:

curl -fsSL https://raw.githubusercontent.com/TrustTunnel/TrustTunnelClient/refs/heads/master/scripts/install.sh | sh -s -

This re-runs the installer and replaces the binaries in the installation directory (/opt/trusttunnel_client by default, or the directory you specified with -o DIR).

Note

Don't forget to stop the client before updating (for example, by stopping the running process).

Windows

Download the latest release from the releases page and replace the files in your installation directory.

Client configuration wizard

The installation directory contains setup_wizard binary that helps generate the config files required for the client to run.

Linux / macOS

cd /opt/trusttunnel_client/
./setup_wizard -h

To configure the client to use the config that was generated by endpoint, run the following command:

./setup_wizard --mode non-interactive \
     --endpoint_config <endpoint_config> \
     --settings trusttunnel_client.toml

Windows

setup_wizard.exe --mode non-interactive ^
    --endpoint_config <endpoint_config> ^
    --settings trusttunnel_client.toml

In both cases, <endpoint_config> is the path to the configuration file generated by the endpoint.

trusttunnel_client.toml will contain all required configuration for the client.

Tip

The generated configuration contains basic settings to connect to the endpoint. For advanced features, edit trusttunnel_client.toml directly. You can configure:

• VPN mode: Route all traffic (general) or only specific destinations (selective)
• Kill switch: Block traffic when VPN disconnects
• DNS upstreams: Custom DNS resolvers (DoH, DoT, DoQ supported)
• Exclusions: Domains/IPs to bypass or route through VPN
• Listener type: TUN device or SOCKS5 proxy

See the TrustTunnel CLI Client README for all available options.

Note

After editing the config, restart the client for the changes to take effect.

Running client

Linux / macOS

cd /opt/trusttunnel_client/
sudo ./trusttunnel_client -c trusttunnel_client.toml

sudo is required to set up the routes and tun interface.

Windows

Open a terminal as Administrator and run:

trusttunnel_client.exe -c trusttunnel_client.toml

Administrator privileges are required to set up routes and the TUN interface.

See Also

• CONFIGURATION.md - Configuration documentation
• DEVELOPMENT.md - Development documentation
• PROTOCOL.md - Protocol specification
• CHANGELOG.md - Changelog
• VERIFY_RELEASES.md - How to verify releases

Roadmap

While our VPN currently supports tunneling TCP/UDP/ICMP traffic, we plan to add support for peer-to-peer communication between clients.

Stay tuned for this feature in upcoming releases.

License

This project is licensed under the Apache 2.0 License. See LICENSE for details.