mirror of
https://github.com/netbirdio/docs.git
synced 2026-08-30 19:51:26 +02:00
8824f4af97
* docs: consolidate scenario guides under /use-cases with redirects Move 11 pages: feature-nested use cases from manage/networks, manage/network-routes, manage/reverse-proxy, and the Kubernetes integration into /use-cases/remote-access, /use-cases/cloud, and /use-cases/security; the site-to-site decision page becomes /use-cases/remote-access; the MikroTik guide becomes an install guide at /get-started/install/mikrotik. Add one redirect per moved page and flatten existing redirect chains so every legacy URL resolves in a single hop. The deprecated Routes site-to-site recipe stays put. * docs: rebuild sidebar navigation for use-cases reorg Remove the four nested Use Cases sublists from Manage NetBird; keep the deprecated Routes recipe as a direct 'Site-to-Site (legacy)' link. Rebuild USE CASES with Remote Access, Cloud & Kubernetes, Security groups and a flat Homelab link. Add MikroTik to Get Started > Platforms. * docs: rebuild use-case index pages and refresh feature landing links Turn /use-cases into an "I want to..." scenario finder. Retitle the site-to-site decision page to Remote Access and point its links at the new sibling URLs. Add the Kubernetes service and private-proxy guides to the cloud and security indexes, refresh the homelab landing links, and update the Networks, Routes, Reverse Proxy, and Kubernetes landing pages to the new use-case URLs. * docs: update internal links to new use-case URLs Point cross-links across the docs at the consolidated /use-cases URLs. Links to the deprecated Routes site-to-site recipe and all image paths under public/docs-static are left unchanged. * docs: shorten sidebar label to Site-to-Site * docs: move Kubernetes into its own Use Cases section Pull the entire Kubernetes integration out of Manage > Integrations into a dedicated Kubernetes group under Use Cases at /use-cases/ kubernetes, and move the two Kubernetes cloud guides there too. Rename the Cloud group (was 'Cloud & Kubernetes'); Integrations keeps the MDM deployment pages. Add redirects for every moved page and flatten existing chains. * docs: drop 'NetBird on' prefix from cloud sidebar labels * docs: alphabetize Remote Access use cases in sidebar * ❯ add mikrotik to install index * docs: fix duplicated word in remote-access link label on TV install pages --------- Co-authored-by: Brandon Hopkins <brandon@techhut.tv>
96 lines
3.6 KiB
Plaintext
96 lines
3.6 KiB
Plaintext
import {Note} from "@/components/mdx";
|
|
|
|
# Install NetBird
|
|
|
|
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.
|
|
|
|
<Button href="https://app.netbird.io/install" arrow="right" children="Download NetBird" />
|
|
|
|
The NetBird client (agent) allows a peer to join a pre-existing NetBird deployment. If a NetBird deployment is not yet available, there are both managed and [self-hosted](https://docs.netbird.io/selfhosted/selfhosted-quickstart) options available.
|
|
|
|
## Install and Update Instructions
|
|
* [Install on Linux](/get-started/install/linux)
|
|
* [Install on macOS](/get-started/install/macos)
|
|
* [Install on Windows](/get-started/install/windows)
|
|
* [Install on Android](/get-started/install/android)
|
|
* [Install on iOS](/get-started/install/ios)
|
|
|
|
## Additional Platforms
|
|
* [Install on Synology](/get-started/install/synology)
|
|
* [Install on TrueNAS](/get-started/install/truenas)
|
|
* [Install on pfSense](/get-started/install/pfsense)
|
|
* [Install on OPNSense](/get-started/install/opnsense)
|
|
* [Install on OpenWrt](/get-started/install/openwrt)
|
|
* [Install on MikroTik](/get-started/install/mikrotik)
|
|
* [Install on Raspberry Pi](/get-started/install/raspberrypi)
|
|
* [Install on Proxmox VE](/get-started/install/proxmox-ve)
|
|
|
|
## Running NetBird with SSO Login
|
|
### Desktop UI Application
|
|
If you installed the Desktop UI client, you can launch it and click on Connect.
|
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
|
|
|
<p>
|
|
<img src="/docs-static/img/get-started/netbird-sso-login-ui.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
|
</p>
|
|
|
|
### CLI
|
|
Alternatively, you could use command line. Simply run
|
|
```bash
|
|
netbird up
|
|
```
|
|
> It will open your browser, and you will be prompt for email and password. Follow the instructions.
|
|
|
|
<p>
|
|
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
|
|
</p>
|
|
|
|
Check connection status:
|
|
```bash
|
|
netbird status
|
|
```
|
|
|
|
## Running NetBird with a Setup Key
|
|
In case you are activating a server peer, you can use a [setup key](/manage/peers/register-machines-using-setup-keys) as described in the steps below.
|
|
> This is especially helpful when you are running multiple server instances with infrastructure-as-code tools like ansible and terraform.
|
|
|
|
1. Login to the Management Service. You need to have a `setup key` in hand (see [setup keys](/manage/peers/register-machines-using-setup-keys)).
|
|
|
|
For all systems:
|
|
```bash
|
|
netbird up --setup-key <SETUP KEY>
|
|
```
|
|
|
|
For **Docker**, you can run with the following command:
|
|
```bash
|
|
docker run --network host --privileged --rm -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/var/lib/netbird netbirdio/netbird:<TAG>
|
|
```
|
|
> TAG > 0.6.0 version
|
|
|
|
Alternatively, if you are hosting your own Management Service provide `--management-url` property pointing to your Management Service:
|
|
```bash
|
|
netbird up --setup-key <SETUP KEY> --management-url http://localhost:33073
|
|
```
|
|
|
|
> You could also omit the `--setup-key` property. In this case, the tool will prompt for the key.
|
|
|
|
2. Check connection status:
|
|
```bash
|
|
netbird status
|
|
```
|
|
|
|
3. Check your IP:
|
|
|
|
On **macOS** :
|
|
````bash
|
|
sudo ifconfig utun100
|
|
````
|
|
On **Linux**:
|
|
```bash
|
|
ip addr show wt0
|
|
```
|
|
On **Windows**:
|
|
```bash
|
|
netsh interface ip show config name="wt0"
|
|
```
|