sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-04-20 17:36:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Getting started fix (#218)

Browse Source
This commit is contained in:
Misha Bragin
2024-08-16 21:12:22 +02:00
committed by GitHub
parent 12be204fa7
commit 9681d622f4
1 changed files with 21 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
src/pages/how-to/getting-started.mdx
View File

@@ -4,8 +4,6 @@ export const title = 'Getting Started'
## Quickstart Guide
Step-by-step video guide on YouTube:
<div className="videowrapper">
<iframe src="https://www.youtube.com/embed/JRCZy4rLi-c" allow="fullscreen;"></iframe>
</div>
@@ -15,15 +13,17 @@ This guide describes how to quickly get started with NetBird and create a secure
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, MacOS nad popular mobile platforms like Android and iOS.
1. Sign-up at [https://app.netbird.io/](https://app.netbird.io/)
## Create a NetBird Account
Sign-up at [app.netbird.io](https://app.netbird.io/)
You can use your Google, GitHub or Microsoft account.
<p>
<img src="/docs-static/img/getting-started/auth.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>
2. After a successful login you will be redirected to the ```Peers``` screen which is empty because you don't have any peers yet.
## Install NetBird
After a successful login you will be redirected to the ```Peers``` screen which is empty because you don't have any peers yet.
The `Add peer` window should automatically pop up, but if it doesn't, click ```Add new peer``` to add a new machine.
@@ -31,43 +31,51 @@ The `Add peer` window should automatically pop up, but if it doesn't, click ```A
<img src="/docs-static/img/getting-started/empty-peers.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>
3. Choose your machine operating system (in our case it is ```Linux```) and proceed with the installation steps.
Choose your machine operating system (in our case it is ```Linux```) and proceed with the installation steps.
<p>
<img src="/docs-static/img/getting-started/add-peer.png" alt="login-to-netbird" className="imagewrapper"/>
</p>
4. If you installed NetBird Desktop UI you can use it to connect to the network instead of running `netbird up` command.
## Connect your Laptop
If you installed NetBird Desktop UI you can use it to connect to the network instead of running `netbird up` command.
Look for `NetBird` in your application list, run it, and click `Connect`.
>
<p>
<img src="/docs-static/img/getting-started/systray.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>
5. At this point a browser window pops up starting a device registration process. Click confirm and follow the steps if required.
At this point a browser window pops up starting a device registration process. Click confirm and follow the steps if required.
<p>
<img src="/docs-static/img/getting-started/device-confirmation.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>
6. On the EC2 node repeat the installation steps and run `netbird up` command.
## Connect Your EC2 Node
On the EC2 node repeat the installation steps and run `netbird up` command.
```bash
sudo netbird up
```
7. Copy the verification URL from the terminal output and paste it in your browser. Repeat step #5
Copy the verification URL from the terminal output and paste it in your browser. Repeat step #5
<p>
<img src="/docs-static/img/getting-started/netbird-up.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>
8. Return to ```Peers``` and you should notice 2 new machines with status ```online```
## Validate Connection
Return to ```Peers``` and you should notice 2 new machines with status ```online```
<p>
<img src="/docs-static/img/getting-started/peers.png" alt="login-to-netbird" className="imagewrapper-big"/>
</p>
9. To test the connection you could try pinging devices:
To test the connection you could try pinging devices:
On your laptop:
```bash
@@ -78,7 +86,7 @@ On the EC2 node:
```bash
ping my-linux-laptop.netbird.cloud
```
10. Done! You now have a secure peer-to-peer private network configured.
Done! You now have a secure peer-to-peer private network configured.
<br/>