Nicole Rappe
199b079d22
All checks were successful
GitOps Automatic Deployment / GitOps Automatic Deployment (push) Successful in 7s
30 lines
1.3 KiB
Markdown
30 lines
1.3 KiB
Markdown
## Purpose
|
|
Netbird is a free and open-source VPN server and client platform. The following document will illustrate how to deploy Netbird into a homelab or business environment.
|
|
|
|
!!! note "Assumptions"
|
|
It is assumed that you are running Ubuntu Server Minimized. You can technically use anything, but the command syntax will be different depending on the platform, and this document will not outline every possible operating system.
|
|
|
|
### Install Prerequisites
|
|
You need to install a few things before we can begin with the deployment of Netbird. Run the following commands set up the server environment before Netbird deployment.
|
|
|
|
!!! warning "Run as Non-Sudo"
|
|
Run all of the commands below as a normal user, do not use `sudo su` when deploying Netbird.
|
|
|
|
```sh
|
|
# Install necessary packages
|
|
sudo apt install jq docker.io docker-compose curl
|
|
|
|
# Configure normal user to have docker privileges
|
|
sudo usermod -aG docker nicole
|
|
|
|
# Logout and log back in via SSH
|
|
exit
|
|
ssh nicole@192.168.3.65
|
|
|
|
# Create Netbird project directory and pull down installation files
|
|
sudo mkdir -p /srv/containers/netbird
|
|
cd /srv/containers/netbird
|
|
curl -sSLO https://github.com/netbirdio/netbird/releases/latest/download/getting-started-with-zitadel.sh
|
|
export NETBIRD_DOMAIN=vpn.bunny-lab.io
|
|
bash getting-started-with-zitadel.sh
|
|
``` |