115 lines
No EOL
7.9 KiB
HTML
115 lines
No EOL
7.9 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8"/>
|
|
<title>NetBird Onboarding</title>
|
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/water.css@2/out/water.css"/>
|
|
</head>
|
|
<body>
|
|
<nav>
|
|
<h1>NetBird Onboarding</h1>
|
|
<ul>
|
|
<li><a href="#quickstart">Quickstart</a></li>
|
|
<li><a href="#netbird-environment">How does the NetBird environment work?</a></li>
|
|
<li><a href="#auth-provider-vs-pre-shared-keys">Choosing between an auth provider and pre-shared keys</a></li>
|
|
</ul>
|
|
</nav>
|
|
<main>
|
|
<section id="quickstart">
|
|
<h2>Quickstart</h2>
|
|
<blockquote>
|
|
<h2>Start here if you have an account</h2>
|
|
<!-- Linux -->
|
|
<h3>Linux</h3>
|
|
<p>1. Run
|
|
<code>curl -fsSL https://pkgs.netbird.io/install.sh | sh</code>
|
|
</p>
|
|
<p>2. Run
|
|
<code>netbird up -m https://netbird.hemera.network</code>
|
|
</p>
|
|
<p>3. You will be provided with a link, follow this and enter your account details</p>
|
|
<h4>Using community-provided script</h4>
|
|
<details>
|
|
<summary>Details</summary>
|
|
<p>1. Run
|
|
<code>curl -OLs https://raw.githubusercontent.com/physk/netbird-installer/main/install.sh && sudo bash install.sh --quiet -m https://netbird.hemera.network</code>
|
|
</p>
|
|
</details>
|
|
<h4>Using Netbird gui</h4>
|
|
<details>
|
|
<summary>Details</summary>
|
|
<p>1. Visit
|
|
<a href="https://app.netbird.io/install">https://app.netbird.io/install</a>
|
|
</p>
|
|
<p>2. Select your OS and follow the instructions</p>
|
|
<p>3. If started running automatically then find it in your taskbar, right click, select "settings". Change Management URL and Admin URL to <code>https://netbird.hemera.network:443</code></p>
|
|
<p>4. If it didn't start automatically then run netbird-ui (just netbird on windows) from your operating system's launcher and follow step 3</p>
|
|
</details>
|
|
<!-- Windows -->
|
|
<h2>Windows</h2>
|
|
<p>1. Visit
|
|
<a href="https://app.netbird.io/install">https://app.netbird.io/install</a>
|
|
</p>
|
|
<p>2. Select Windows and follow the download instructions</p>
|
|
<p>3. If started running automatically then find it in your taskbar, right click, select "settings". Change Management URL and Admin URL to <code>https://netbird.hemera.network:443</code></p>
|
|
<p>4. If it didn't start automatically then run netbird from your the search menu and follow step 3</p>
|
|
</blockquote>
|
|
<blockquote>
|
|
<h2>Start here if you have a pre-shared key</h2>
|
|
<!-- Linux -->
|
|
<h3>Linux</h3>
|
|
<p>1. Run
|
|
<code>curl -fsSL https://pkgs.netbird.io/install.sh | sh</code>
|
|
</p>
|
|
<p>2. Run
|
|
<code>netbird up -m https://netbird.hemera.network -k YOUR PRE-SHARED KEY</code>
|
|
</p>
|
|
<h4>Using community-provided script</h4>
|
|
<details>
|
|
<summary>Details</summary>
|
|
<p>1. Run
|
|
<code>curl -OLs https://raw.githubusercontent.com/physk/netbird-installer/main/install.sh && sudo bash install.sh --quiet -m https://netbird.hemera.network -k YOUR PRE-SHARED KEY</code>
|
|
</p>
|
|
</details>
|
|
<h4>Using Netbird gui</h4>
|
|
<details>
|
|
<summary>Details</summary>
|
|
<p>1. Visit
|
|
<a href="https://app.netbird.io/install">https://app.netbird.io/install</a>
|
|
</p>
|
|
<p>2. Select your OS and follow the instructions</p>
|
|
<p>3. If started running automatically then find it in your taskbar, right click, select "settings". Change Management URL and Admin URL to <code>https://netbird.hemera.network:443</code></p>
|
|
<p>4. If it didn't start automatically then run netbird-ui from your operating system's launcher and follow step 3</p>
|
|
<p>5. Get your Pre-share key and fill out that line on the netbird settings, click save. If you get any kind of error report directly back to the user that provided the key.</p>
|
|
</details>
|
|
<!-- Windows -->
|
|
<h2>Windows</h2>
|
|
<p>1. Visit
|
|
<a href="https://app.netbird.io/install">https://app.netbird.io/install</a>
|
|
</p>
|
|
<p>2. Select Windows and follow the download instructions</p>
|
|
<p>3. If started running automatically then find it in your taskbar, right click, select "settings". Change Management URL and Admin URL to <code>https://netbird.hemera.network:443</code></p>
|
|
<p>4. If it didn't start automatically then run netbird from your the search menu and follow step 3</p>
|
|
<p>5. Get your Pre-share key and fill out that line on the netbird settings, click save. If you get any kind of error report directly back to the user that provided the key.</p>
|
|
</section>
|
|
</main>
|
|
<section id="netbird-environment">
|
|
<h2>How does the NetBird environment work?</h2>
|
|
<p>Devices are paired up into groups, you will be on a dev group that can interact with a server group. Devices in the server group can interact with each other, devices in the dev group cannot access one another.</p>
|
|
<img src="https://example.com/netbird-network-layout.png" alt="NetBird network layout example"/>
|
|
</section>
|
|
<section id="auth-provider-vs-pre-shared-keys">
|
|
<h2>Choosing between an auth provider and pre-shared keys</h2>
|
|
<p>NetBird supports both authentication providers and pre-shared keys. The choice depends on your use case:</p>
|
|
<ul>
|
|
<li>
|
|
<strong>Authorization Provider:</strong>
|
|
Auth is provided to NetBird through a service called Zitadel. This approach is ideal for organizations with complex authentication requirements, such as multi-factor authentication or single sign-on (SSO). Authorization providers also enable NetBird to easily manage and revoke user access. However, authorization providers require periodic renewal of access tokens, typically every 60 days. This can be a challenge for automation and deployment/re-deployment of hundreds of nodes.</li>
|
|
<li>
|
|
<strong>Pre-Shared Keys:</strong>
|
|
Pre-shared keys are a simple and effective way to authenticate with NetBird without the need for an authorization provider. Pre-shared keys consist of a public key that is shared by the server with the client, and a private key that is kept secret by the client. This approach is ideal for automation and deployment/re-deployment of hundreds of nodes. With pre-shared keys, NetBird can be easily configured to connect to a server without requiring any user intervention. However, pre-shared keys do not provide the same level of security as an authorization provider, as they are vulnerable to key theft.</li>
|
|
</ul>
|
|
</section>
|
|
</body>
|
|
</body>
|
|
</html> |