Getting startedPreview

Quickstart

Create a network, connect two devices and reach one from the other by name.

This guide takes you from a new account to two connected devices that reach each other by name.

Create an account
Sign up at app.nardeboon.io with an email and password, or with Google, GitHub or Microsoft. If you use email, verify your address from the message you receive.
Your organisation comes with a network, ready for your first device.
Install Nardeboon
On your first Linux device, run the install script:
```
curl -fsSL https://nardeboon.io/install.sh | sh
```
To install from the Debian/Ubuntu or Fedora/RHEL package repository instead, see Install on Linux.
Connect the device
```
sudo nardeboon up
```
The command prints a login URL. Open it in a browser and sign in with your new account. The device joins your network and gets an address and a name, such as mypc.
Add a second device
Repeat the last two steps on another device, such as your laptop. On a server, you can join with an auth key created in the dashboard instead of a browser login:
```
sudo nardeboon up --auth-key "$NB_AUTH_KEY"
```
Networks and devices explains the kinds of auth key.
Check the connection
On either device, run:
```
nardeboon status
```
It shows this device, its network and its peers:
```
Connected to network home as laptop (100.101.40.7)

PEER    ADDRESS         STATUS
mypc    100.101.12.4    online
```
Add --json to any command for machine-readable output.
Reach the other device by name
From laptop, ping mypc by its short name:
```
ping -c 3 mypc
```
To test reachability through Nardeboon itself, use nardeboon ping:
```
$ nardeboon ping mypc
pong from mypc (100.101.12.4): direct, nb-udp, 3 ms
```

If something doesn't work

Every nardeboon command exits with a fixed code that tells you what went wrong:

Exit code	Meaning	What to do
3 `daemon`	`nardeboond` isn't running or can't be reached	Check `systemctl status nardeboond`
4 `auth`	Not logged in, or the device key has expired	Run `sudo nardeboon login`
5 `offline`	Not connected	Run `sudo nardeboon up`
6 `not-found`	No peer with that name	Check the name in `nardeboon status`
7 `permission`	Needs root or the `nardeboon` group	Use `sudo`, or join the group
10 `unreachable`	The peer is known, but no path works right now	Run `nardeboon netcheck` and `nardeboon path explain mypc`

Next steps

Learn how networks, devices and auth keys fit together.
Reach networks behind a device with subnet routes, or send all your traffic through an exit node.
Decide who can reach what with access control.

Create an account

Install Nardeboon

Connect the device

Add a second device

Check the connection

Reach the other device by name

If something doesn't work

Next steps