Install the app

Install the app

Install TxHub on Windows, macOS and Linux, connect from the tray or the txhub command, and add servers that run without anyone signed in.

TxHub runs on Windows, macOS and Linux. On a desktop you get a small app in the system tray or menu bar. On a server you use the txhub command. Both talk to the same background service, which does the actual networking, so a device works the same way whichever you use.

Download the installer for your platform from txhub.is/download. The page always links to the latest release.

PlatformDownloadWhat you get
Windows 10 and 11 (64-bit).msiTray app, background service and the txhub command
Windows Server.zipBackground service and the txhub command, no tray app
macOS 13 or later (Apple Silicon and Intel).dmgMenu-bar app with the background service built in
Linux (64-bit x86 and ARM).deb, .rpm, .tar.gzBackground service and the txhub command

Windows

  1. Download and run the .msi installer.
  2. If Windows shows Windows protected your PC, click More info → Run anyway. The Windows installer is not code-signed yet, so SmartScreen does not recognise it.
  3. Follow the installer. It installs the TxHub background service (which starts automatically with Windows), the txhub command, and the tray app, which starts when you sign in to Windows.
  4. Click the TxHub icon in the system tray (you may need to click the ^ arrow to see it), then click Log in….
  5. Your browser opens. Sign in with your work account or your TxHub password. When you are done, the tray shows that you are connected.

Windows Server without the tray app

For a server where nobody signs in, use the Windows Server .zip. Unzip it and run the included script in a PowerShell window opened with Run as administrator. Set TXHUB_AUTHKEY to an enrollment key to join without a browser:

PowerShell (as administrator)
$env:TXHUB_AUTHKEY = "<your enrollment key>"
.\install-txhub-windows.ps1

Without TXHUB_AUTHKEY, the script prints a link. Open it in a browser and sign in to add the server.

macOS

  1. Open the .dmg and drag TXHub onto the Applications folder.
  2. Open TxHub from Applications. The app is signed and notarized by Apple, so it opens without a security warning.
  3. TxHub lives in the menu bar at the top of the screen. It has no Dock icon. Click the TxHub icon to open it. On a Mac with a notch and a full menu bar, the icon can be hidden; close a few menu-bar apps to make room.
  4. The first time, the app says TXHub isn’t running. Click Start TXHub… and enter your Mac password. This installs the background service once; you are not asked again on every start.
  5. Click Log In…. Your browser opens. Sign in, and the menu shows that you are connected.

Linux

Install the package for your distribution. The package sets up the txhubd service and starts it straight away.

# Debian, Ubuntu
sudo apt install ./txhub-linux-amd64.deb
# Fedora, RHEL, Rocky, Alma
sudo dnf install ./txhub-linux-x86_64.rpm

On ARM machines, use the arm64 .deb or the aarch64 .rpm. Then connect the machine to your TxNet:

sudo txhub up

The command prints a link. Open it in a browser on any device, sign in, and the machine joins your TxNet. On a server, use an enrollment key so that nobody has to open a browser:

sudo txhub up --auth-key=<your enrollment key>

Supported distributions

DistributionPackageStatus
Debian 11 or later, Ubuntu 20.04 or later.debTested
RHEL, Rocky Linux, AlmaLinux 8 or later.rpmTested
Fedora, openSUSE, Amazon Linux 2023.rpmExpected to work
Arch and other systemd distributions.tar.gzExpected to work
NixOSFlakeLinked from the download page

The service needs systemd and a kernel with TUN support (/dev/net/tun). The .tar.gz contains bin/txhubd, bin/txhub and the systemd unit. Copy them to /usr/sbin, /usr/bin and /etc/systemd/system, then run sudo systemctl enable --now txhubd.

Use the txhub command

The txhub command is installed on every platform, and on Windows and macOS it is on your PATH, so you can run it from any terminal. These are the commands you need most often (on Linux, use sudo for the ones that change settings):

CommandWhat it does
txhub upConnect this device. The first time, it prints a sign-in link.
txhub up --auth-key=<key>Connect with an enrollment key instead of a browser sign-in.
txhub statusShow this device and the other devices it can see, with their addresses.
txhub ipShow this device’s TxNet IP addresses.
txhub downDisconnect, but stay signed in. Run txhub up to reconnect.
txhub logoutDisconnect and sign this device out.
txhub versionShow the installed version.

The tray and menu-bar app

Click the TxHub icon to open the app. The switch at the top connects and disconnects this device. Below it you find:

WindowsmacOSWhat it is for
Account (click your name)Account (click your name)Switch between accounts, add an account, log out
This DeviceThis DeviceThis device’s name and TxNet address
My DevicesMy DevicesYour other devices. Click one to copy its IP address. A search field appears when you have 8 or more
Network → Exit NodeNetwork → Exit NodeSend your internet traffic through another device. See Exit nodes
Network → Run as exit nodeNetwork → Run as Exit NodeOffer this device as an exit node. An admin approves it
Network → Use subnet routesNetwork → Use Subnet RoutesReach networks that other devices share. See Subnet routes
Advanced → Application gatewayAdvanced → Application GatewayLet admins route applications through this device. See Applications
Advanced → View logsAdvanced → View Daemon Logs…Open the logs, useful when asking for help
Open TXHub DashboardOpen TXHub DashboardOpen the dashboard in your browser
Quit TXHubQuit TXHubClose the app

Advanced also shows the app version. On macOS it also has Launch at Login and Restart Daemon…. These labels are from version 0.2.9; older versions show some of them in a different place.

Note
Quitting the app closes the tray or menu-bar icon. The background service keeps running, so to disconnect the device, use the switch at the top first.

Update

  • Windows and macOS: when a new version is out, the app shows Update available with the version number. Click it to download the new installer, then run it.
  • macOS: after you replace the app, it may show Daemon update available. Click Update… and enter your password to update the background service too.
  • Linux: download the new package and install it over the old one, as below. The service restarts on its own and the device stays signed in.

Update on Linux

These commands download the latest package for your machine’s architecture and install it.

Debian, Ubuntu
arch=$(dpkg --print-architecture)
curl -fsSLo /tmp/txhub.deb "https://github.com/txhub-labs/txhub-releases/releases/latest/download/txhub-linux-$arch.deb"
sudo apt install /tmp/txhub.deb
Fedora, RHEL, Rocky, Alma
arch=$(uname -m)
curl -fsSLo /tmp/txhub.rpm "https://github.com/txhub-labs/txhub-releases/releases/latest/download/txhub-linux-$arch.rpm"
sudo dnf install /tmp/txhub.rpm

Check the new version with txhub version, and that the device is connected with txhub status.

Uninstall

Windows

Open Settings → Apps, find TXHub and choose Uninstall. This removes the service, the tray app and the shortcuts.

macOS

Quit TxHub from the menu, then remove the background service and the app in Terminal:

sudo /Library/PrivilegedHelperTools/is.txhub/uninstall-daemon.sh
rm -rf /Applications/TXHub.app

Linux

sudo apt remove txhub
# or
sudo dnf remove txhub
Tip
Uninstalling does not remove the device from your TxNet. To remove it there too, delete it in the dashboard under Machines. See Remove a device.

Troubleshooting

  • The app says the daemon or TxHub isn’t running. On Windows, click Start the daemon. On macOS, click Start TXHub…. On Linux, run sudo systemctl restart txhubd.
  • I can’t find the icon. On Windows, check the hidden icons behind the ^ arrow in the taskbar. On macOS, make room in a crowded menu bar.
  • Sign-in fails in the browser. Check that your account belongs to a TxNet; ask your admin if not. See Sign-in and SSO.

More help is on the Troubleshooting page.