Skip to content

Download and connect

Setup guide

You'll need an active package, the WireGuard app, and your device configuration from the KatLink dashboard.
Before you start: log in to your dashboard, make sure your package is active, and open the configuration for the device you're setting up. Keep the configuration private; it contains your device's key.

Android

  1. Install WireGuard from Google Play (published by WireGuard Development Team).
  2. In your KatLink dashboard, open your device configuration and choose to show the QR code.
  3. In WireGuard, tap +, then Scan from QR code, and scan it. If you downloaded the file instead, choose Import from file or archive.
  4. Give the tunnel a name such as KatLink.
  5. Tap the switch next to the tunnel. Accept Android's request to set up a VPN connection.

iPhone and iPad

  1. Install WireGuard from the App Store.
  2. Tap +, then Create from QR code, and scan the QR code from your dashboard. You can also open a downloaded configuration file and share it to WireGuard.
  3. Name the tunnel, then allow WireGuard to add a VPN configuration when iOS asks.
  4. Switch the tunnel on.

Windows

  1. Download and install WireGuard for Windows from wireguard.com/install.
  2. Download your configuration file (it ends in .conf) from your KatLink dashboard.
  3. Open WireGuard and click Import tunnel(s) from file, then select the file.
  4. Click Activate.

macOS

  1. Install WireGuard from the Mac App Store.
  2. Download your configuration file from your KatLink dashboard.
  3. Open WireGuard, click Import tunnel(s) from file and select the file. Allow the VPN configuration when macOS asks.
  4. Click Activate.

Linux

  1. Install the WireGuard tools. On Debian or Ubuntu:
sudo apt install wireguard

On Fedora:

sudo dnf install wireguard-tools
  1. Save your configuration where only root can read it:
sudo install -m 600 katlink.conf /etc/wireguard/katlink.conf
  1. Connect and disconnect with:
sudo wg-quick up katlink
sudo wg-quick down katlink

If wg-quick reports a resolvconf error, install your distribution's resolvconf package. On desktops with NetworkManager you can import the file instead:

nmcli connection import type wireguard file katlink.conf

Check it's working

  • In the WireGuard app, the tunnel should show a recent latest handshake time. That means your device has reached the gateway.
  • While connected, a "what is my IP address" website should show the KatLink gateway's address instead of your usual one.
  • Your dashboard shows connection status as reported by the gateway. It can take a minute or two to update.

Troubleshooting

The tunnel is on, but there's no latest handshake

  • Check that your package is active and has time or data left.
  • Some workplace, school or hotel networks block VPN traffic. Try a different network, such as mobile data.
  • Make sure the configuration wasn't edited. If in doubt, download it again from your dashboard and re-import it.

Connected, but websites don't load

  • Switch the tunnel off and on again.
  • Check your dashboard: if your data allowance is used up, the gateway stops passing traffic.
  • Make sure only one VPN app is active on the device.

It's slow

  • Compare with the VPN switched off. A VPN can't be faster than the connection underneath it.
  • Speed also depends on distance to the gateway and how busy the network is.

Lost phone or new device

  • Remove the old device in your dashboard and set up the new one. If you think someone copied your configuration, contact support.