diff --git a/next.config.mjs b/next.config.mjs index e42c6147..fdda6366 100644 --- a/next.config.mjs +++ b/next.config.mjs @@ -140,6 +140,62 @@ const nextConfig = { destination: '/manage/access-control/endpoint-detection-and-response/intune-mdm', permanent: true, }, + // documentation redirects for get-started + { + source: '/how-to/getting-started', + destination: '/get-started', + permanent: true, + }, + { + source: '/how-to/installation', + destination: '/get-started/install', + permanent: true, + }, + { + source: '/how-to/installation/linux', + destination: '/get-started/install/linux', + permanent: true, + }, + { + source: '/how-to/installation/windows', + destination: '/get-started/install/windows', + permanent: true, + }, + { + source: '/how-to/installation/macos', + destination: '/get-started/install/macos', + permanent: true, + }, + { + source: '/how-to/installation/docker', + destination: '/get-started/install/docker', + permanent: true, + }, + { + source: '/how-to/installation/synology', + destination: '/get-started/install/synology', + permanent: true, + }, + { + source: '/how-to/installation/mobile', + destination: '/get-started/install/mobile', + permanent: true, + }, + { + source: '/how-to/installation/pfsense', + destination: '/get-started/install/pfsense', + permanent: true, + }, + { + source: '/how-to/installation/opnsense', + destination: '/get-started/install/opnsense', + permanent: true, + }, + { + source: '/how-to/cli', + destination: '/get-started/cli', + permanent: true, + }, ] }, rewrites: async () => { diff --git a/public/docs-static/img/getting-started/add-linux-peer.png b/public/docs-static/img/get-started/add-linux-peer.png similarity index 100% rename from public/docs-static/img/getting-started/add-linux-peer.png rename to public/docs-static/img/get-started/add-linux-peer.png diff --git a/public/docs-static/img/getting-started/add-peer.png b/public/docs-static/img/get-started/add-peer.png similarity index 100% rename from public/docs-static/img/getting-started/add-peer.png rename to public/docs-static/img/get-started/add-peer.png diff --git a/public/docs-static/img/getting-started/auth.png b/public/docs-static/img/get-started/auth.png similarity index 100% rename from public/docs-static/img/getting-started/auth.png rename to public/docs-static/img/get-started/auth.png diff --git a/public/docs-static/img/getting-started/dashboard.png b/public/docs-static/img/get-started/dashboard.png similarity index 100% rename from public/docs-static/img/getting-started/dashboard.png rename to public/docs-static/img/get-started/dashboard.png diff --git a/public/docs-static/img/getting-started/device-confirmation.png b/public/docs-static/img/get-started/device-confirmation.png similarity index 100% rename from public/docs-static/img/getting-started/device-confirmation.png rename to public/docs-static/img/get-started/device-confirmation.png diff --git a/public/docs-static/img/getting-started/empty-peers.png b/public/docs-static/img/get-started/empty-peers.png similarity index 100% rename from public/docs-static/img/getting-started/empty-peers.png rename to public/docs-static/img/get-started/empty-peers.png diff --git a/public/docs-static/img/getting-started/high-level-dia.png b/public/docs-static/img/get-started/high-level-dia.png similarity index 100% rename from public/docs-static/img/getting-started/high-level-dia.png rename to public/docs-static/img/get-started/high-level-dia.png diff --git a/public/docs-static/img/getting-started/img.png b/public/docs-static/img/get-started/img.png similarity index 100% rename from public/docs-static/img/getting-started/img.png rename to public/docs-static/img/get-started/img.png diff --git a/public/docs-static/img/getting-started/logo-full.png b/public/docs-static/img/get-started/logo-full.png similarity index 100% rename from public/docs-static/img/getting-started/logo-full.png rename to public/docs-static/img/get-started/logo-full.png diff --git a/public/docs-static/img/getting-started/logo.png b/public/docs-static/img/get-started/logo.png similarity index 100% rename from public/docs-static/img/getting-started/logo.png rename to public/docs-static/img/get-started/logo.png diff --git a/public/docs-static/img/getting-started/mac-installation.png b/public/docs-static/img/get-started/mac-installation.png similarity index 100% rename from public/docs-static/img/getting-started/mac-installation.png rename to public/docs-static/img/get-started/mac-installation.png diff --git a/public/docs-static/img/get-started/mobile/app-store-badge.svg b/public/docs-static/img/get-started/mobile/app-store-badge.svg new file mode 100644 index 00000000..072b425a --- /dev/null +++ b/public/docs-static/img/get-started/mobile/app-store-badge.svg @@ -0,0 +1,46 @@ + + Download_on_the_App_Store_Badge_US-UK_RGB_blk_4SVG_092917 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/public/docs-static/img/get-started/mobile/google-play-badge.png b/public/docs-static/img/get-started/mobile/google-play-badge.png new file mode 100644 index 00000000..131f3aca Binary files /dev/null and b/public/docs-static/img/get-started/mobile/google-play-badge.png differ diff --git a/public/docs-static/img/getting-started/netbird-sso-login-cmd.gif b/public/docs-static/img/get-started/netbird-sso-login-cmd.gif similarity index 100% rename from public/docs-static/img/getting-started/netbird-sso-login-cmd.gif rename to public/docs-static/img/get-started/netbird-sso-login-cmd.gif diff --git a/public/docs-static/img/getting-started/netbird-sso-login-ui.gif b/public/docs-static/img/get-started/netbird-sso-login-ui.gif similarity index 100% rename from public/docs-static/img/getting-started/netbird-sso-login-ui.gif rename to public/docs-static/img/get-started/netbird-sso-login-ui.gif diff --git a/public/docs-static/img/getting-started/netbird-up.png b/public/docs-static/img/get-started/netbird-up.png similarity index 100% rename from public/docs-static/img/getting-started/netbird-up.png rename to public/docs-static/img/get-started/netbird-up.png diff --git a/public/docs-static/img/getting-started/01_netbird-sso.jpeg b/public/docs-static/img/get-started/onboarding/01_netbird-sso.jpeg similarity index 100% rename from public/docs-static/img/getting-started/01_netbird-sso.jpeg rename to public/docs-static/img/get-started/onboarding/01_netbird-sso.jpeg diff --git a/public/docs-static/img/getting-started/02_p2p-network.jpeg b/public/docs-static/img/get-started/onboarding/02_p2p-network.jpeg similarity index 100% rename from public/docs-static/img/getting-started/02_p2p-network.jpeg rename to public/docs-static/img/get-started/onboarding/02_p2p-network.jpeg diff --git a/public/docs-static/img/getting-started/03_download-netbird.jpeg b/public/docs-static/img/get-started/onboarding/03_download-netbird.jpeg similarity index 100% rename from public/docs-static/img/getting-started/03_download-netbird.jpeg rename to public/docs-static/img/get-started/onboarding/03_download-netbird.jpeg diff --git a/public/docs-static/img/getting-started/04_connect-client.jpeg b/public/docs-static/img/get-started/onboarding/04_connect-client.jpeg similarity index 100% rename from public/docs-static/img/getting-started/04_connect-client.jpeg rename to public/docs-static/img/get-started/onboarding/04_connect-client.jpeg diff --git a/public/docs-static/img/getting-started/05_headless-installed.jpeg b/public/docs-static/img/get-started/onboarding/05_headless-installed.jpeg similarity index 100% rename from public/docs-static/img/getting-started/05_headless-installed.jpeg rename to public/docs-static/img/get-started/onboarding/05_headless-installed.jpeg diff --git a/public/docs-static/img/getting-started/06_headless-install-connected.jpeg b/public/docs-static/img/get-started/onboarding/06_headless-install-connected.jpeg similarity index 100% rename from public/docs-static/img/getting-started/06_headless-install-connected.jpeg rename to public/docs-static/img/get-started/onboarding/06_headless-install-connected.jpeg diff --git a/public/docs-static/img/getting-started/07_ping-test.jpeg b/public/docs-static/img/get-started/onboarding/07_ping-test.jpeg similarity index 100% rename from public/docs-static/img/getting-started/07_ping-test.jpeg rename to public/docs-static/img/get-started/onboarding/07_ping-test.jpeg diff --git a/public/docs-static/img/getting-started/08_policy-disabled-example.jpeg b/public/docs-static/img/get-started/onboarding/08_policy-disabled-example.jpeg similarity index 100% rename from public/docs-static/img/getting-started/08_policy-disabled-example.jpeg rename to public/docs-static/img/get-started/onboarding/08_policy-disabled-example.jpeg diff --git a/public/docs-static/img/getting-started/09_policy-example.jpeg b/public/docs-static/img/get-started/onboarding/09_policy-example.jpeg similarity index 100% rename from public/docs-static/img/getting-started/09_policy-example.jpeg rename to public/docs-static/img/get-started/onboarding/09_policy-example.jpeg diff --git a/public/docs-static/img/getting-started/10_remote-access-onboarding.jpeg b/public/docs-static/img/get-started/onboarding/10_remote-access-onboarding.jpeg similarity index 100% rename from public/docs-static/img/getting-started/10_remote-access-onboarding.jpeg rename to public/docs-static/img/get-started/onboarding/10_remote-access-onboarding.jpeg diff --git a/public/docs-static/img/getting-started/11_entire-subnet.jpeg b/public/docs-static/img/get-started/onboarding/11_entire-subnet.jpeg similarity index 100% rename from public/docs-static/img/getting-started/11_entire-subnet.jpeg rename to public/docs-static/img/get-started/onboarding/11_entire-subnet.jpeg diff --git a/public/docs-static/img/getting-started/12_add-routing-peer.jpeg b/public/docs-static/img/get-started/onboarding/12_add-routing-peer.jpeg similarity index 100% rename from public/docs-static/img/getting-started/12_add-routing-peer.jpeg rename to public/docs-static/img/get-started/onboarding/12_add-routing-peer.jpeg diff --git a/public/docs-static/img/getting-started/12_routing-peer-added.jpeg b/public/docs-static/img/get-started/onboarding/12_routing-peer-added.jpeg similarity index 100% rename from public/docs-static/img/getting-started/12_routing-peer-added.jpeg rename to public/docs-static/img/get-started/onboarding/12_routing-peer-added.jpeg diff --git a/public/docs-static/img/getting-started/13_switching-network.jpeg b/public/docs-static/img/get-started/onboarding/13_switching-network.jpeg similarity index 100% rename from public/docs-static/img/getting-started/13_switching-network.jpeg rename to public/docs-static/img/get-started/onboarding/13_switching-network.jpeg diff --git a/public/docs-static/img/getting-started/14_it-worked.jpeg b/public/docs-static/img/get-started/onboarding/14_it-worked.jpeg similarity index 100% rename from public/docs-static/img/getting-started/14_it-worked.jpeg rename to public/docs-static/img/get-started/onboarding/14_it-worked.jpeg diff --git a/public/docs-static/img/getting-started/16_onboarding-policies.jpeg b/public/docs-static/img/get-started/onboarding/16_onboarding-policies.jpeg similarity index 100% rename from public/docs-static/img/getting-started/16_onboarding-policies.jpeg rename to public/docs-static/img/get-started/onboarding/16_onboarding-policies.jpeg diff --git a/public/docs-static/img/how-to-guides/opnsense/authentication.png b/public/docs-static/img/get-started/opnsense/authentication.png similarity index 100% rename from public/docs-static/img/how-to-guides/opnsense/authentication.png rename to public/docs-static/img/get-started/opnsense/authentication.png diff --git a/public/docs-static/img/how-to-guides/opnsense/enable_interface.png b/public/docs-static/img/get-started/opnsense/enable_interface.png similarity index 100% rename from public/docs-static/img/how-to-guides/opnsense/enable_interface.png rename to public/docs-static/img/get-started/opnsense/enable_interface.png diff --git a/public/docs-static/img/how-to-guides/opnsense/firewall_rules.png b/public/docs-static/img/get-started/opnsense/firewall_rules.png similarity index 100% rename from public/docs-static/img/how-to-guides/opnsense/firewall_rules.png rename to public/docs-static/img/get-started/opnsense/firewall_rules.png diff --git a/public/docs-static/img/how-to-guides/opnsense/interface_assignment.png b/public/docs-static/img/get-started/opnsense/interface_assignment.png similarity index 100% rename from public/docs-static/img/how-to-guides/opnsense/interface_assignment.png rename to public/docs-static/img/get-started/opnsense/interface_assignment.png diff --git a/public/docs-static/img/how-to-guides/opnsense/new_interface.png b/public/docs-static/img/get-started/opnsense/new_interface.png similarity index 100% rename from public/docs-static/img/how-to-guides/opnsense/new_interface.png rename to public/docs-static/img/get-started/opnsense/new_interface.png diff --git a/public/docs-static/img/how-to-guides/opnsense/status.png b/public/docs-static/img/get-started/opnsense/status.png similarity index 100% rename from public/docs-static/img/how-to-guides/opnsense/status.png rename to public/docs-static/img/get-started/opnsense/status.png diff --git a/public/docs-static/img/getting-started/peerA.gif b/public/docs-static/img/get-started/peerA.gif similarity index 100% rename from public/docs-static/img/getting-started/peerA.gif rename to public/docs-static/img/get-started/peerA.gif diff --git a/public/docs-static/img/getting-started/peerB.gif b/public/docs-static/img/get-started/peerB.gif similarity index 100% rename from public/docs-static/img/getting-started/peerB.gif rename to public/docs-static/img/get-started/peerB.gif diff --git a/public/docs-static/img/getting-started/peers.gif b/public/docs-static/img/get-started/peers.gif similarity index 100% rename from public/docs-static/img/getting-started/peers.gif rename to public/docs-static/img/get-started/peers.gif diff --git a/public/docs-static/img/getting-started/peers.png b/public/docs-static/img/get-started/peers.png similarity index 100% rename from public/docs-static/img/getting-started/peers.png rename to public/docs-static/img/get-started/peers.png diff --git a/public/docs-static/img/how-to-guides/pfSense/authentication.png b/public/docs-static/img/get-started/pfSense/authentication.png similarity index 100% rename from public/docs-static/img/how-to-guides/pfSense/authentication.png rename to public/docs-static/img/get-started/pfSense/authentication.png diff --git a/public/docs-static/img/how-to-guides/pfSense/enable_interface.png b/public/docs-static/img/get-started/pfSense/enable_interface.png similarity index 100% rename from public/docs-static/img/how-to-guides/pfSense/enable_interface.png rename to public/docs-static/img/get-started/pfSense/enable_interface.png diff --git a/public/docs-static/img/how-to-guides/pfSense/firewall_rules.png b/public/docs-static/img/get-started/pfSense/firewall_rules.png similarity index 100% rename from public/docs-static/img/how-to-guides/pfSense/firewall_rules.png rename to public/docs-static/img/get-started/pfSense/firewall_rules.png diff --git a/public/docs-static/img/how-to-guides/pfSense/new_interface.png b/public/docs-static/img/get-started/pfSense/new_interface.png similarity index 100% rename from public/docs-static/img/how-to-guides/pfSense/new_interface.png rename to public/docs-static/img/get-started/pfSense/new_interface.png diff --git a/public/docs-static/img/how-to-guides/pfSense/status.png b/public/docs-static/img/get-started/pfSense/status.png similarity index 100% rename from public/docs-static/img/how-to-guides/pfSense/status.png rename to public/docs-static/img/get-started/pfSense/status.png diff --git a/public/docs-static/img/getting-started/setup-key-created.png b/public/docs-static/img/get-started/setup-key-created.png similarity index 100% rename from public/docs-static/img/getting-started/setup-key-created.png rename to public/docs-static/img/get-started/setup-key-created.png diff --git a/public/docs-static/img/getting-started/setup-key.png b/public/docs-static/img/get-started/setup-key.png similarity index 100% rename from public/docs-static/img/getting-started/setup-key.png rename to public/docs-static/img/get-started/setup-key.png diff --git a/public/docs-static/img/getting-started/systray-connected.png b/public/docs-static/img/get-started/systray-connected.png similarity index 100% rename from public/docs-static/img/getting-started/systray-connected.png rename to public/docs-static/img/get-started/systray-connected.png diff --git a/public/docs-static/img/getting-started/systray.png b/public/docs-static/img/get-started/systray.png similarity index 100% rename from public/docs-static/img/getting-started/systray.png rename to public/docs-static/img/get-started/systray.png diff --git a/src/components/NavigationDocs.jsx b/src/components/NavigationDocs.jsx index f2715ca4..42338ae6 100644 --- a/src/components/NavigationDocs.jsx +++ b/src/components/NavigationDocs.jsx @@ -30,21 +30,21 @@ export const docsNavigation = [ { title: 'GET STARTED', links: [ - { title: 'Quickstart Guide', href: '/how-to/getting-started' }, + { title: 'Quickstart Guide', href: '/get-started' }, { - title: 'Install NetBird', isOpen: true, href: '/how-to/installation', + title: 'Install NetBird', isOpen: true, href: '/get-started/install', links: [ - { title: 'Linux', href: '/how-to/installation/linux' }, - { title: 'Windows', href: '/how-to/installation/windows' }, - { title: 'MacOS', href: '/how-to/installation/macos' }, - { title: 'Docker', href: '/how-to/installation/docker' }, - { title: 'Synology', href: '/how-to/installation/synology' }, - { title: 'Android/iOS', href: '/how-to/installation/mobile' }, - { title: 'pfSense', href: '/how-to/installation/pfsense' }, - { title: 'OPNsense', href: '/how-to/installation/opnsense' }, + { title: 'Linux', href: '/get-started/install/linux' }, + { title: 'Windows', href: '/get-started/install/windows' }, + { title: 'MacOS', href: '/get-started/install/macos' }, + { title: 'Docker', href: '/get-started/install/docker' }, + { title: 'Synology', href: '/get-started/install/synology' }, + { title: 'Android/iOS', href: '/get-started/install/mobile' }, + { title: 'pfSense', href: '/get-started/install/pfsense' }, + { title: 'OPNsense', href: '/get-started/install/opnsense' }, ], }, - { title: 'CLI', href: '/how-to/cli' }, + { title: 'CLI', href: '/get-started/cli' }, ], }, { diff --git a/src/pages/how-to/cli.mdx b/src/pages/get-started/cli.mdx similarity index 100% rename from src/pages/how-to/cli.mdx rename to src/pages/get-started/cli.mdx diff --git a/src/pages/how-to/getting-started.mdx b/src/pages/get-started/index.mdx similarity index 88% rename from src/pages/how-to/getting-started.mdx rename to src/pages/get-started/index.mdx index 77708d01..17a219e9 100644 --- a/src/pages/how-to/getting-started.mdx +++ b/src/pages/get-started/index.mdx @@ -15,7 +15,7 @@ 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/getting-started/01_netbird-sso.jpeg) +![NetBird IdP SSO and MFA](/docs-static/img/get-started/onboarding/01_netbird-sso.jpeg) 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. @@ -27,14 +27,14 @@ 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/getting-started/02_p2p-network.jpeg) +![Onboarding Method Selection](/docs-static/img/get-started/onboarding/02_p2p-network.jpeg) 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/getting-started/03_download-netbird.jpeg) +![Download NetBird](/docs-static/img/get-started/onboarding/03_download-netbird.jpeg) 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. @@ -43,7 +43,7 @@ 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/getting-started/04_connect-client.jpeg) +![Connect NetBird Client](/docs-static/img/get-started/onboarding/04_connect-client.jpeg) 1. After installation, find the NetBird icon in your system tray or menu bar. 2. Click the icon and select **Connect**. @@ -53,14 +53,14 @@ 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/how-to/register-machines-using-setup-keys). -![Install NetBird Headless](/docs-static/img/getting-started/05_headless-installed.jpeg) +![Install NetBird Headless](/docs-static/img/get-started/onboarding/05_headless-installed.jpeg) 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.. 3. The onboarding UI will now provide two commands to run on your Linux server: * **Install NetBird**: A curl command to download and run the installation script. -* **Run NetBird**: A [netbird up command](https://docs.netbird.io/how-to/cli) that includes your unique setup key. +* **Run NetBird**: A [netbird up command](https://docs.netbird.io/get-started/cli) that includes your unique setup key. 4. SSH into your Linux server and run the commands: @@ -78,12 +78,12 @@ netbird up --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/getting-started/06_headless-install-connected.jpeg) +![Headless install connected](/docs-static/img/get-started/onboarding/06_headless-install-connected.jpeg) ### 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/getting-started/07_ping-test.jpeg) +![Testing ping on NetBird](/docs-static/img/get-started/onboarding/07_ping-test.jpeg) 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. @@ -97,13 +97,13 @@ 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/getting-started/08_policy-disabled-example.jpeg) +![NetBird policy disabled](/docs-static/img/get-started/onboarding/08_policy-disabled-example.jpeg) 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/getting-started/09_policy-example.jpeg) +![Policy Example](/docs-static/img/get-started/onboarding/09_policy-example.jpeg) 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). @@ -117,7 +117,7 @@ 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/getting-started/10_remote-access-onboarding.jpeg) +![NetBird Onboarding](/docs-static/img/get-started/onboarding/10_remote-access-onboarding.jpeg) ### Define Your Network Resource Next, you'll define the private network you want your users to be able to access. @@ -125,12 +125,12 @@ Next, you'll define the private network you want your users to be able to access 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/getting-started/11_entire-subnet.jpeg) +![NetBird Subnet Setup](/docs-static/img/get-started/onboarding/11_entire-subnet.jpeg) ### Add and Configure a Routing Peer A [routing peer](https://docs.netbird.io/how-to/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/getting-started/12_add-routing-peer.jpeg) +![Adding a routing peer](/docs-static/img/get-started/onboarding/12_add-routing-peer.jpeg) 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). @@ -160,7 +160,7 @@ 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/getting-started/13_switching-network.jpeg) +![Switching Network](/docs-static/img/get-started/onboarding/13_switching-network.jpeg) 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. @@ -169,14 +169,14 @@ 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/getting-started/14_it-worked.jpeg) +![Testing Worked](/docs-static/img/get-started/onboarding/14_it-worked.jpeg) 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/getting-started/16_onboarding-policies.jpeg) +![Understanding Your Access Policy](/docs-static/img/get-started/onboarding/16_onboarding-policies.jpeg) Click Go to Dashboard to access the main NetBird admin panel. From here, you can: diff --git a/src/pages/how-to/installation/docker.mdx b/src/pages/get-started/install/docker.mdx similarity index 97% rename from src/pages/how-to/installation/docker.mdx rename to src/pages/get-started/install/docker.mdx index ed3da985..d42c23b0 100644 --- a/src/pages/how-to/installation/docker.mdx +++ b/src/pages/get-started/install/docker.mdx @@ -9,7 +9,7 @@ The NetBird client (agent) allows a peer to join a pre-existing NetBird deployme Set the ```NB_SETUP_KEY``` environment variable and run the command. - You can pass other settings as environment variables. See [Environment variables](/how-to/cli#environment-variables) for details. + You can pass other settings as environment variables. See [Environment variables](/get-started/cli#environment-variables) for details. NetBird makes use of eBPF and raw sockets, therefore to guarantee the client software functionality, we recommend adding the flags `--cap-add=SYS_ADMIN` and `--cap-add=SYS_RESOURCE` for docker clients. diff --git a/src/pages/how-to/installation/index.mdx b/src/pages/get-started/install/index.mdx similarity index 71% rename from src/pages/how-to/installation/index.mdx rename to src/pages/get-started/install/index.mdx index 448e162b..b2928755 100644 --- a/src/pages/how-to/installation/index.mdx +++ b/src/pages/get-started/install/index.mdx @@ -2,7 +2,7 @@ import {Note} from "@/components/mdx"; # Install NetBird -If you're a new user you should visit the [Quickstart Guide](https://docs.netbird.io/how-to/getting-started). This will help you setup your management dashboard and connect your first client. For quick install instructions, including desktop applications, visit the [install prompt](https://app.netbird.io/install) through the management dashboard. To view all the client installation methods we've set up a variety of platform specific pages. +If you're a new user you should visit the [Quickstart Guide](https://docs.netbird.io/get-started). This will help you setup your management dashboard and connect your first client. For quick install instructions, including desktop applications, visit the [install prompt](https://app.netbird.io/install) through the management dashboard. To view all the client installation methods we've set up a variety of platform specific pages.