Getting started
Installation
Download and install Tunnel Agent on Windows, macOS or Linux.
Every release is published on GitHub Releases with builds for x64 and ARM64. The app is primarily tested on Windows.
Windows#
Installer (recommended). Download TunnelAgent-win-x64-Setup.exe (or win-arm64) and run it. Installer builds update themselves in the background.
Portable. Download TunnelAgent-win-x64-Portable.zip, extract it anywhere and run TunnelAgent.exe. Nothing is installed.
Scoop.
scoop bucket add villoh https://github.com/Villoh/scoop-bucket
scoop install tunnel-agentScoop installs a build with the built-in updater disabled, so Scoop owns updates.
macOS#
Download the .pkg for your Mac (osx-arm64 for Apple Silicon, osx-x64 for Intel) and open it. A .zip with the app bundle is also available.
Linux#
Pick the format that suits your distribution:
| Format | Use it on |
|---|---|
.AppImage | Any distribution. Mark it executable and run it. |
.deb | Debian, Ubuntu and derivatives. |
.rpm | Fedora, openSUSE and derivatives. |
chmod +x TunnelAgent-*-linux-x64.AppImage
./TunnelAgent-*-linux-x64.AppImageRequirements#
- Windows 10 or later, a recent macOS, or a 64-bit Linux desktop.
- 9Router only: Node.js 18+ on
PATH. CLIProxyAPI and Perplexity WebUI Scraper are self-contained binaries.
First launch#
On first launch Tunnel Agent downloads the engine binaries from their GitHub releases and verifies them with SHA256 before installing. You can pick another engine version, or turn off automatic updates, in Configuration.
Next: Quick start.