Skip to content

replace markdown images with img tags for zoom styling #578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MiiC27 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

replace markdown images with img tags for zoom styling #578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 60 additions & 15 deletions src/pages/get-started/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,10 @@ and build a secure peer-to-peer overlay network in less than ten minutes.

First, let's create your NetBird account.

![NetBird IdP SSO and MFA](/docs-static/img/get-started/onboarding/01_netbird-sso.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/01_netbird-sso.jpeg"
alt="NetBird IdP SSO and MFA" className="imagewrapper-big"/>
</p>

1. Navigate to [netbird.io](https://netbird.io/) and click Get Started in the top-right corner. Or simply click [here](https://app.netbird.io/).
2. You’ll be redirected to the sign-in page, where NetBird uses your identity provider (IdP) for secure authentication.
Expand All @@ -25,14 +28,20 @@ Upon your first login, you'll be greeted by a short onboarding survey. This help

## Peer-to-Peer Network
One way of using NetBird is to create a peer-to-peer network, where you run the NetBird client on your devices to connect them directly.
![Onboarding Method Selection](/docs-static/img/get-started/onboarding/02_p2p-network.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/02_p2p-network.jpeg"
alt="Onboarding Method Selection" className="imagewrapper-big"/>
</p>

The onboarding process will now guide you to connect your first device, also known as a peer.
For this guide, we'll select Peer-to-Peer Network. If you’re selecting the Remote Network Access option, you can see that process [here](#remote-network-access).

### Install Your First Peer

![Download NetBird](/docs-static/img/get-started/onboarding/03_download-netbird.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/03_download-netbird.jpeg"
alt="Download NetBird" className="imagewrapper-big"/>
</p>

1. On the "Let's get your first device online" screen, click the Install NetBird button.
2. An [installation modal](https://app.netbird.io/install) will appear. Select your operating system (e.g., macOS, Windows, Linux). For this example, we're installing it on a macOS machine.
Expand All @@ -41,7 +50,10 @@ For this guide, we'll select Peer-to-Peer Network. If you’re selecting the Rem
### Connect Your First Peer
With the client installed, you now need to connect it to your network.

![Connect NetBird Client](/docs-static/img/get-started/onboarding/04_connect-client.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/04_connect-client.jpeg"
alt="Connect NetBird Client" className="imagewrapper-big"/>
</p>

1. After installation, find the NetBird icon in your system tray or menu bar.
2. Click the icon and select **Connect**.
Expand All @@ -51,7 +63,10 @@ With the client installed, you now need to connect it to your network.
### Add a Second Peer (Headless Linux Server)
Next, let's add a second, headless peer, like a Linux server or a Raspberry Pi. For devices without a graphical interface, we use a [Setup Key](https://docs.netbird.io/manage/peers/register-machines-using-setup-keys).

![Install NetBird Headless](/docs-static/img/get-started/onboarding/05_headless-installed.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/05_headless-installed.jpeg"
alt="Install NetBird Headless" className="imagewrapper-big"/>
</p>

1. In the web UI, the onboarding flow will now prompt you to "bring in your second device." Click the link that says Install with a setup key.
2. A pop-up will explain that a one-off setup key will be created, which you can also learn more about here. Click Continue..
Expand All @@ -76,12 +91,18 @@ netbird up --setup-key <YOUR_SETUP_KEY>

After running the second command, the terminal will confirm Connected. Your headless device is now part of your NetBird network.

![Headless install connected](/docs-static/img/get-started/onboarding/06_headless-install-connected.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/06_headless-install-connected.jpeg"
alt="Headless install connected" className="imagewrapper-big"/>
</p>

### Verify the Connection
The onboarding UI will now display both of your connected peers. The onboarding wizard provides a simple way to test that they can communicate directly.

![Testing ping on NetBird](/docs-static/img/get-started/onboarding/07_ping-test.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/07_ping-test.jpeg"
alt="Testing ping on NetBird" className="imagewrapper-big"/>
</p>

1. Copy the provided ping command from the onboarding UI. This command uses the NetBird IP address of your second peer (the Ubuntu server).
2. Open a terminal on your first peer and paste the command. Replace the example below with the NetBird IP for your machine.
Expand All @@ -95,13 +116,19 @@ ping 100.74.76.17
### Understanding Access Control
The final onboarding step introduces NetBird's powerful Access Control policies.

![NetBird policy disabled](/docs-static/img/get-started/onboarding/08_policy-disabled-example.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/08_policy-disabled-example.jpeg"
alt="NetBird policy disabled" className="imagewrapper-big"/>
</p>
1. By default, a policy is active that allows connections between all your devices. This is why the ping command in the previous step worked.
2. The wizard demonstrates this by allowing you to toggle the policy. If you disable the "Default Policy," the ping between your devices will immediately fail with a "Request timeout" error.
3. Re-enabling the policy instantly restores the connection. This gives you a basic understanding of how you can control traffic within your network. You can learn much more about policies [here](/manage/access-control/manage-network-access).
4. Click Continue to finish.

![Policy Example](/docs-static/img/get-started/onboarding/09_policy-example.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/09_policy-example.jpeg"
alt="Policy Example" className="imagewrapper-big"/>
</p>
In the policy example above, we allowed _IT Admins_ port specific access to peers under the _AWS Servers_ group. Policies are a key building block to access in NetBird. You can learn more about the power of policies [here](https://docs.netbird.io/manage/access-control/manage-network-access).

<Note>
Expand All @@ -115,20 +142,29 @@ This machine acts as a routing peer, routing traffic to internal resources that
The onboarding process will now guide you to build our first network resource.
For this guide, we'll select Remote Network Access.

![NetBird Onboarding](/docs-static/img/get-started/onboarding/10_remote-access-onboarding.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/10_remote-access-onboarding.jpeg"
alt="NetBird Onboarding" className="imagewrapper-big"/>
</p>

### Define Your Network Resource
Next, you'll define the private network you want your users to be able to access.
1. The onboarding UI will prompt you to "Add your first resource." There are a few options here, but the easiest way to get started is with full access to an entire Network. Select the Entire Subnet option.
2. Enter the CIDR range of your private network. For example, `10.0.0.0/32`.
3. Click Create Resource. A "Network" will be created in your dashboard to contain this resource and its access rules.

![NetBird Subnet Setup](/docs-static/img/get-started/onboarding/11_entire-subnet.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/11_entire-subnet.jpeg"
alt="NetBird Subnet Setup" className="imagewrapper-big"/>
</p>

### Add and Configure a Routing Peer
A [routing peer](https://docs.netbird.io/manage/network-routes/routing-traffic-to-private-networks) is a NetBird peer that lives inside your private network and acts as a gateway, forwarding traffic between your remote users and the internal resources.

![Adding a routing peer](/docs-static/img/get-started/onboarding/12_add-routing-peer.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/12_add-routing-peer.jpeg"
alt="Adding a routing peer" className="imagewrapper-big"/>
</p>

1. The dashboard will now prompt you to "Add a routing peer." First, click Generate Setup Key. This creates a one-time key used to enroll the gateway machine into your NetBird account.
2. Next, click Install Routing Peer. Select the operating system of your gateway machine (the video uses Linux).
Expand Down Expand Up @@ -158,7 +194,10 @@ Now, set up the device you will use to connect to your private network.
### Test the Connection
With both the routing peer and your client device online, you can now test your connection to the private network. To properly test connectivity you should move the client device to a different network, for example, connecting the device using your phone's hotspot.

![Switching Network](/docs-static/img/get-started/onboarding/13_switching-network.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/13_switching-network.jpeg"
alt="Switching Network" className="imagewrapper-big"/>
</p>

1. Open a terminal on your client device and run the test command (e.g., `ping 10.0.0.100`). Due note, the IP you ping needs to be a device on the same network that the routing peer is installed on.
2. You should see successful replies, confirming that your client device can reach internal resources through the routing peer.
Expand All @@ -167,14 +206,20 @@ With both the routing peer and your client device online, you can now test your
### Understanding Your Access Policy
The final step of the onboarding wizard explains the access rule that was automatically created for you.

![Testing Worked](/docs-static/img/get-started/onboarding/14_it-worked.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/14_it-worked.jpeg"
alt="Testing Worked" className="imagewrapper-big"/>
</p>

1. A policy, named "Users to My Subnet," is enabled by default. This policy allows all authenticated users to access the resources within the subnet you define.
2. To demonstrate this, you can toggle this policy off. When disabled, the ping from your client device will begin to fail with a "Request timeout" error, showing that the connection is now blocked.
3. Re-enabling the policy will immediately restore access.
4. Click Continue to complete the setup.

![Understanding Your Access Policy](/docs-static/img/get-started/onboarding/16_onboarding-policies.jpeg)
<p>
<img src="/docs-static/img/get-started/onboarding/16_onboarding-policies.jpeg"
alt="Understanding Your Access Policy" className="imagewrapper-big"/>
</p>

Click Go to Dashboard to access the main NetBird admin panel. From here, you can:

Expand Down
5 changes: 4 additions & 1 deletion src/pages/manage/access-control/endpoint-detection-and-response/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Integrate NetBird with MDM & EDR Platforms

![Endpoint Detection and Response](/docs-static/img/manage/access-control/endpoint-detection-and-response/edr-integrations.png)
<p>
<img src="/docs-static/img/manage/access-control/endpoint-detection-and-response/edr-integrations.png"
alt="Endpoint Detection and Response" className="imagewrapper-big"/>
</p>

## What is EDR and MDM?
Endpoint Detection and Response (EDR) is a cybersecurity technology designed to help organizations detect, investigate,
Expand Down
Loading