Added a LICENSE and documentation on how to contribute Updated CI/CD to use the root level code
2.4 KiB
sidebar_position, title
| sidebar_position | title |
|---|---|
| 1 | Quickstart Guide |
Step-by-step video guide on YouTube:
This guide describes how to quickly get started with NetBird and create a secure private network with 2 connected machines.
One machine is a Linux laptop, and the other one a EC2 node running on AWS. Both machines are running Linux but NetBird also works on Windows and MacOS.
-
Sign-up at https://app.netbird.io/
You can use your Google, GitHub or Microsoft account.
-
After a successful login you will be redirected to the
Peersscreen which is empty because you don't have any peers yet.Click
Add peerto add a new machine. -
Choose your machine operating system (in our case it is
Linux) and proceed with the installation steps. -
If you installed NetBird Desktop UI you can use it to connect to the network instead of running
netbird upcommand. Look forNetBirdin your application list, run it, and clickConnect. -
At this point a browser window pops up starting a device registration process. Click confirm and follow the steps if required.
-
On the EC2 node repeat the installation steps and run
netbird upcommand.sudo netbird up -
Copy the verification URL from the terminal output and paste it in your browser. Repeat step #5
-
Return to
Peersand you should notice 2 new machines with statusonline -
To test the connection you could try pinging devices:
On your laptop:
ping 100.64.0.2On the EC2 node:
ping 100.64.0.1 -
Done! You now have a secure peer-to-peer private network configured.
- Make sure to star us on GitHub
- Follow us on Twitter
- Join our Slack Channel
- NetBird release page on GitHub: releases






