Skip to main content

Husarnet Documentation

With Husarnet you can connect any device (laptops, servers, VMs, containers, IoT devices etc.) with any interface (Wi-Fi, LTE/5G, Ethernet) into a Virtual Private Network that works over the Internet with no configuration.

Read how Husarnet works and find all relevant documentation and tutorials here.

IT'S OPEN!

Husarnet Client is open source and available here: https://github.com/husarnet/husarnet

If you want to start right away, find an instruction for your target platform in the section below.

Using Husarnet#

Before you go to the Installation procedure, get your Husarnet Join Code first. Join Code allows you to connect your devices to the same Husarnet network.

info

To get your Join Code:

  1. Setup a free account at Husarnet Dashboard: https://app.husarnet.com/accounts/register/
  2. Create a new network, click [ Add element ] button and go to Join Code tab
  3. Join Code looks like that: fc94:b01d:1803:8dd8:b293:5c7d:7639:932a/XXXXXXXXXXXXXXXXXXXXXX
note

Husarnet Client for Linux

Supported architectures: i386, x64 (amd64), armhf, arm64

Choose your Linux distribution:

For APT and Yum based Linux the simplest way to install Husarnet is to paste the following line into your terminal:

curl https://install.husarnet.com/install.sh | sudo bash

After installation process is finished, execute the following command:

sudo systemctl restart husarnet

Now export your Join Code as environment variable:

export JOINCODE=fc94:b01d:1803:8dd8:b293:5c7d:7639:932a/XXXXXXXXXXXXXXXXXXXXXX

To join your device to Husarnet network, execute:

sudo husarnet join $JOINCODE some-hostname

Tutorials & examples#

We provide example applications for Husarnet on our blog, like:

There is also a Husarnet Hackster profile where you can find sample applications for ESP32 powered IoT.

Troubleshooting#

Common issues and ways to solve or report them are covered in this guide.