sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-09-19 13:29:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Restyle blockquotes and convert callouts to Note (#985)

Browse Source 
* Restyle blockquotes and convert callouts to Note

* Fixed SSO prompt grammar
This commit is contained in:
Brandon Hopkins
2026-09-17 11:03:22 -07:00
committed by GitHub
parent a2719629fc
commit 94cc8baa36
12 changed files with 75 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/get-started/install/docker.mdx
+1
View File
@@ -85,6 +85,7 @@ volumes:
## 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.
For unattended deployments across many containers, pre-populate the client config and inject the setup key at runtime. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file).
src/pages/get-started/install/index.mdx
+12 -3
View File
@@ -34,7 +34,10 @@ 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.
<Note>
It will open your browser and prompt you for your email and password. Follow the instructions.
</Note>
<p>
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
@@ -47,6 +50,7 @@ Check connection 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)).
@@ -60,14 +64,19 @@ 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
<Note>
Replace `<TAG>` with a version newer than 0.6.0.
</Note>
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.
<Note>
You could also omit the `--setup-key` property. In this case, the tool will prompt for the key.
</Note>
2. Check connection status:
```bash
src/pages/get-started/install/linux.mdx
+8 -2
View File
@@ -464,7 +464,10 @@ 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.
<Note>
It will open your browser and prompt you for your email and password. Follow the instructions.
</Note>
<p>
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
@@ -477,6 +480,7 @@ Check connection 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.
For unattended deployments across many machines, pre-populate the client config so each peer registers on first start. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file).
@@ -492,7 +496,9 @@ Alternatively, if you are hosting your own Management Service provide `--managem
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.
<Note>
You could also omit the `--setup-key` property. In this case, the tool will prompt for the key.
</Note>
2. Check connection status:
```bash
src/pages/get-started/install/macos.mdx
+16 -4
View File
@@ -21,7 +21,10 @@ _If you require an older version checkout NetBird [releases](https://github.com/
2. Proceed with the installation steps
3. This will install the NetBird app into /Applications and add the daemon service
4. After installing, you can follow the steps from [Running NetBird with SSO Login](#Running-NetBird-with-SSO-Login) steps.
> To uninstall the client remove the app from /Applications
<Note>
To uninstall the client remove the app from /Applications
</Note>
### Homebrew install
@@ -34,7 +37,10 @@ sudo netbird service uninstall
# unlink the app
brew unlink netbird
```
> netbird will copy any existing configuration from the netbird's default configuration paths to the new NetBird's default location
<Note>
netbird will copy any existing configuration from the netbird's default configuration paths to the new NetBird's default location
</Note>
3. Install the client
```bash
@@ -118,7 +124,10 @@ 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.
<Note>
It will open your browser and prompt you for your email and password. Follow the instructions.
</Note>
<p>
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
@@ -131,6 +140,7 @@ Check connection 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.
For unattended deployments across many machines, pre-populate the client config so each peer registers on first start. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file).
@@ -146,7 +156,9 @@ Alternatively, if you are hosting your own Management Service provide `--managem
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.
<Note>
You could also omit the `--setup-key` property. In this case, the tool will prompt for the key.
</Note>
2. Check connection status:
```bash
src/pages/get-started/install/synology.mdx
+4 -1
View File
@@ -60,6 +60,7 @@ fi
## Running 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)).
@@ -73,7 +74,9 @@ Alternatively, if you are hosting your own Management Service provide `--managem
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.
<Note>
You could also omit the `--setup-key` property. In this case, the tool will prompt for the key.
</Note>
2. Check connection status:
```bash
src/pages/get-started/install/windows.mdx
+8 -2
View File
@@ -109,7 +109,10 @@ 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.
<Note>
It will open your browser and prompt you for your email and password. Follow the instructions.
</Note>
<p>
<img src="/docs-static/img/get-started/netbird-sso-login-cmd.gif" alt="high-level-dia" className="imagewrapper-big"/>
@@ -122,6 +125,7 @@ Check connection 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.
For unattended deployments across many machines, pre-populate the client config so each peer registers on first start. See [Bootstrap peers via config file](/manage/peers/bootstrap-via-config-file).
@@ -138,7 +142,9 @@ Alternatively, if you are hosting your own Management Service provide `--managem
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.
<Note>
You could also omit the `--setup-key` property. In this case, the tool will prompt for the key.
</Note>
2. Check connection status:
```bash
src/pages/manage/for-partners/acronis-integration.mdx
+6 -2
View File
@@ -48,7 +48,9 @@ This access policy will automatically apply to all devices managed by Acronis Cy
Moreover, users will only gain this network access when their devices are actively monitored and maintained through Acronis Cyber Protect Cloud, creating a comprehensive security approach where device health monitoring and network access controls work together. This combination ensures that only properly managed and compliant devices can establish secure network connections to protected resources.
> **Note**: For maximum security, create separate policies rather than overly broad policies for each distinct access requirement. This approach minimizes your attack surface by ensuring precise access controls aligned with job responsibilities and reducing complexity in multi-client MSP environments.
<Note>
For maximum security, create separate policies rather than overly broad policies for each distinct access requirement. This approach minimizes your attack surface by ensuring precise access controls aligned with job responsibilities and reducing complexity in multi-client MSP environments.
</Note>
With these access policies configured, you can now proceed to use Acronis' software deployment capabilities to install NetBird across your managed Windows machines, ensuring that all team members have the required secure connectivity client automatically deployed and configured.
@@ -81,7 +83,9 @@ In the `Install / Uninstall commands` tab, configure the silent installation par
The `/S` parameter ensures silent installation without user prompts for NetBird's EXE installer, while `{{full_path}}` and `{{uninstall_cmd}}` are Acronis variables that automatically resolve to the correct paths during deployment. Click `Next` when ready.
> **Note**: If you're using NetBird's MSI installer instead of the EXE installer, use `/qn` in the **Installation options** field instead of `"{{full_path}}" /S`. The **Uninstallation options** field remains the same (`{{uninstall_cmd}} /S`) for both installer types. Starting with v0.75.0, neither installer creates a machine-wide UI autostart entry and the MSI has no `AUTOSTART` property. The desktop app manages **Launch NetBird UI at Login** per user. Use the [`disableAutostart` MDM setting](/client/mdm-integration#disableAutostart) to suppress it on managed endpoints.
<Note>
If you're using NetBird's MSI installer instead of the EXE installer, use `/qn` in the **Installation options** field instead of `"{{full_path}}" /S`. The **Uninstallation options** field remains the same (`{{uninstall_cmd}} /S`) for both installer types. Starting with v0.75.0, neither installer creates a machine-wide UI autostart entry and the MSI has no `AUTOSTART` property. The desktop app manages **Launch NetBird UI at Login** per user. Use the [`disableAutostart` MDM setting](/client/mdm-integration#disableAutostart) to suppress it on managed endpoints.
</Note>
![Install / Uninstall commands](/docs-static/img/manage/for-partners/acronis-windows-netbird-integration/acronis-windows-08.png)
src/pages/manage/peers/mdm-deployment/intune-netbird-integration.mdx
+6 -2
View File
@@ -47,7 +47,9 @@ This access policy will automatically apply to all devices enrolled in Intune th
Moreover, users will only gain this network access when using compliant devices that meet your organization's security standards, creating a true zero trust environment where user identity and device security status are verified before granting resource access.
> **Note**: For maximum security, create separate policies rather than overly broad policies for each distinct access requirement. This approach minimizes your attack surface by ensuring precise access controls aligned with job responsibilities.
<Note>
For maximum security, create separate policies rather than overly broad policies for each distinct access requirement. This approach minimizes your attack surface by ensuring precise access controls aligned with job responsibilities.
</Note>
With these access policies in place, we can now proceed to configure the automated deployment of NetBird through Intune, ensuring that all team members have the required secure connectivity client installed on their devices.
@@ -104,7 +106,9 @@ You can leave the rest of the fields empty.
- **Install command:** `netbird_installer_0.43.0_windows_amd64.exe /S`
- **Uninstall command:** `"%ProgramFiles%\Netbird\netbird_uninstall.exe" /S`
>**Note:** The commands above assume a standard installation using the `/S` flag to specify silent mode. Change them accordingly if you require NetBird installed on a different path. Starting with v0.75.0, the installer does not create a machine-wide UI autostart entry. The desktop app manages **Launch NetBird UI at Login** per user; use the [`disableAutostart` MDM setting](/client/mdm-integration#disableAutostart) when administrators need to suppress it.
<Note>
The commands above assume a standard installation using the `/S` flag to specify silent mode. Change them accordingly if you require NetBird installed on a different path. Starting with v0.75.0, the installer does not create a machine-wide UI autostart entry. The desktop app manages **Launch NetBird UI at Login** per user; use the [`disableAutostart` MDM setting](/client/mdm-integration#disableAutostart) when administrators need to suppress it.
</Note>
For this example, leave the rest of the configuration unchanged. Note that you can change the install behavior and users' ability to uninstall NetBird if required.
src/pages/manage/team/idp-sync/embedded/google-workspace-sync.mdx
+3 -1
View File
@@ -75,7 +75,9 @@ To [check your organization-level permissions](https://cloud.google.com/resource
* Once you've selected the organization, go to `IAM & Admin` > `IAM` in the left sidebar. This will show you a list of all users (principals) and service accounts with roles at the organization level.
* Look for users with roles like `Organization Administrator`, `Organization Policy Administrator`, or other high-level roles.
> NOTE: Verifying your GCP permissions is mandatory before proceeding with the integration since you might need to disable the `iam.disableServiceAccountKeyCreation` constraint temporarily during the process.
<Note>
Verifying your GCP permissions is mandatory before proceeding with the integration since you might need to disable the `iam.disableServiceAccountKeyCreation` constraint temporarily during the process.
</Note>
![Google Workspace IAM & Admin](/docs-static/img/manage/team/idp-sync/google-workspace-sync/9ECRJqC.png)
src/pages/manage/team/idp-sync/google-workspace-sync.mdx
+3 -1
View File
@@ -66,7 +66,9 @@ To [check your organization-level permissions](https://cloud.google.com/resource
* Once you've selected the organization, go to `IAM & Admin` > `IAM` in the left sidebar. This will show you a list of all users (principals) and service accounts with roles at the organization level.
* Look for users with roles like `Organization Administrator`, `Organization Policy Administrator`, or other high-level roles.
> NOTE: Verifying your GCP permissions is mandatory before proceeding with the integration since you might need to disable the `iam.disableServiceAccountKeyCreation` constraint temporarily during the process.
<Note>
Verifying your GCP permissions is mandatory before proceeding with the integration since you might need to disable the `iam.disableServiceAccountKeyCreation` constraint temporarily during the process.
</Note>
![Google Workspace IAM & Admin](/docs-static/img/manage/team/idp-sync/google-workspace-sync/9ECRJqC.png)
src/pages/use-cases/cloud/aws-ecs-terraform.mdx
+4 -1
View File
@@ -40,7 +40,10 @@ This allows you to:
* An [AWS account](https://aws.amazon.com/free/).
* Your AWS credentials. You can [create a new Access Key on this page](https://console.aws.amazon.com/iam/home?#/security_credentials).
### Notice
> Before getting started with this example, be aware that creating the resources from it may incur charges from AWS.
<Note>
Before getting started with this example, be aware that creating the resources from it may incur charges from AWS.
</Note>
### Getting started