mirror of
https://github.com/netbirdio/docs.git
synced 2026-09-19 13:29:04 +02:00
Restyle blockquotes and convert callouts to Note (#985)
* Restyle blockquotes and convert callouts to Note * Fixed SSO prompt grammar
This commit is contained in:
Brandon Hopkins
@@ -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).
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user