Files
netbird-docs/docs/examples/netbird-docker.md
mlsmaycon 98751bc1f4 Move the documentation repository to a public repo
Added a LICENSE and documentation on how to contribute

Updated CI/CD to use the root level code
2022-06-20 19:05:25 +02:00

1.1 KiB

sidebar_position
sidebar_position
2

NetBird Client in Docker

One of the simplest ways of running NetBird client application is to use a pre-built Docker image.

Prerequisites:

  • Docker installed. If you don't have docker installed, please refer to the installation guide on the official Docker website.
  • NetBird account. Register one at app.netbird.io.

You would need to obtain a setup key to associate NetBird client with your account.

The setup key could be found in the NetBird Management dashboard under the Setup Keys tab - https://app.netbird.io/setup-keys.

Set the WT_SETUP_KEY environment variable and run the command.

docker run --rm --privileged -d -e WT_SETUP_KEY=<SETUP KEY> -v netbird-client:/etc/netbird netbirdio/netbird:latest

That is it! Enjoy using NetBird.

If you would like to learn how to run NetBird Client as an ECS agent on AWS, please refer to this guide.