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

Extend docker capabilities with eBPF support (#72)

Browse Source 
* Extend docker capabilities with eBPF support

* Add description for new docker arguments

---------

Co-authored-by: Zoltan Papp <zoltan.papp@webkeyapp.com>
This commit is contained in:
Zoltan Papp
2023-07-10 21:05:52 +02:00
committed by GitHub
co-authored by Zoltan Papp
parent 92665d5656
commit 8626b645f8
3 changed files with 13 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/pages/how-to/examples.mdx
+1 -1
View File
@@ -107,7 +107,7 @@ The setup key could be found in the NetBird Management dashboard under the Setup
Set the ```NB_SETUP_KEY``` environment variable and run the command. Set the ```NB_SETUP_KEY``` environment variable and run the command.
```bash ```bash
docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest
``` ```
That is it! Enjoy using NetBird. That is it! Enjoy using NetBird.
src/pages/how-to/getting-started.mdx
+6 -1
View File
@@ -337,11 +337,16 @@ On **Windows**:
### Running NetBird in Docker ### Running NetBird in Docker
Set the ```NB_SETUP_KEY``` environment variable and run the command. Set the ```NB_SETUP_KEY``` environment variable and run the command.
<Note> <Note>
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](/how-to/cli#environment-variables) for details.
</Note> </Note>
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.
The experience may vary depending on the docker daemon, operating system, or kernel version.
```bash ```bash
docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest
``` ```
See [Docker example](/how-to/examples#net-bird-client-in-docker) for details. See [Docker example](/how-to/examples#net-bird-client-in-docker) for details.
src/pages/how-to/installation.mdx
+6 -1
View File
@@ -273,11 +273,16 @@ On **Windows**:
### Running NetBird in Docker ### Running NetBird in Docker
Set the ```NB_SETUP_KEY``` environment variable and run the command. Set the ```NB_SETUP_KEY``` environment variable and run the command.
<Note> <Note>
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](/how-to/cli#environment-variables) for details.
</Note> </Note>
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.
The experience may vary depending on the docker daemon, operating system, or kernel version.
```bash ```bash
docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest docker run --rm --name PEER_NAME --hostname PEER_NAME --cap-add=NET_ADMIN --cap-add=SYS_ADMIN --cap-add=SYS_RESOURCE -d -e NB_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest
``` ```
See [Docker example](/how-to/examples#net-bird-client-in-docker) for details. See [Docker example](/how-to/examples#net-bird-client-in-docker) for details.