feat(netbird): add NetBird installation and update scripts with configuration details

This commit is contained in:
MickLesk
2026-05-19 10:55:36 +02:00
parent a26a0a4eea
commit 7db803ccab
3 changed files with 128 additions and 0 deletions

55
ct/netbird.sh Normal file
View File

@@ -0,0 +1,55 @@
#!/usr/bin/env bash
source <(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVED/main/misc/build.func)
# Copyright (c) 2021-2026 community-scripts ORG
# Author: MickLesk (CanbiZ)
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
# Source: https://netbird.io
APP="NetBird"
var_tags="${var_tags:-network;vpn;connectivity}"
var_cpu="${var_cpu:-1}"
var_ram="${var_ram:-512}"
var_disk="${var_disk:-4}"
var_os="${var_os:-debian}"
var_version="${var_version:-13}"
var_unprivileged="${var_unprivileged:-0}"
header_info "$APP"
variables
color
catch_errors
function update_script() {
header_info
check_container_storage
check_container_resources
if ! command -v netbird &>/dev/null; then
msg_error "No ${APP} Installation Found!"
exit
fi
msg_info "Stopping Service"
systemctl stop netbird
msg_ok "Stopped Service"
msg_info "Updating ${APP}"
$STD apt update
$STD apt install -y --only-upgrade netbird
msg_ok "Updated ${APP}"
msg_info "Starting Service"
systemctl start netbird
msg_ok "Started Service"
msg_ok "Updated successfully!"
exit
}
start
build_container
description
msg_ok "Completed Successfully!\n"
echo -e "${CREATING}${GN}${APP} setup has been successfully initialized!${CL}"
echo -e "${INFO}${YW} Connect this peer to your NetBird network:${CL}"
echo -e "${TAB}${GATEWAY}${BGN}netbird up --setup-key <YOUR_SETUP_KEY>${CL}"

View File

@@ -0,0 +1,29 @@
#!/usr/bin/env bash
# Copyright (c) 2021-2026 community-scripts ORG
# Author: MickLesk (CanbiZ)
# License: MIT | https://github.com/community-scripts/ProxmoxVED/raw/main/LICENSE
# Source: https://netbird.io
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"
color
verb_ip6
catch_errors
setting_up_container
network_check
update_os
msg_info "Installing NetBird Client"
curl -sSL https://pkgs.netbird.io/debian/public.key | gpg --dearmor --output /usr/share/keyrings/netbird-archive-keyring.gpg
echo 'deb [signed-by=/usr/share/keyrings/netbird-archive-keyring.gpg] https://pkgs.netbird.io/debian stable main' >/etc/apt/sources.list.d/netbird.list
$STD apt update
$STD apt install -y netbird
msg_ok "Installed NetBird Client"
msg_info "Enabling Service"
systemctl enable -q --now netbird
msg_ok "Enabled Service"
motd_ssh
customize
cleanup_lxc

44
json/netbird.json Normal file
View File

@@ -0,0 +1,44 @@
{
"name": "NetBird",
"slug": "netbird",
"categories": [
4
],
"date_created": "2026-05-19",
"type": "ct",
"updateable": true,
"privileged": true,
"interface_port": null,
"documentation": "https://docs.netbird.io/",
"website": "https://netbird.io/",
"logo": "https://cdn.jsdelivr.net/gh/selfhst/icons@main/webp/netbird.webp",
"description": "NetBird is an open-source, WireGuard-based overlay network that creates secure peer-to-peer connections between devices. The NetBird client (agent) allows this container to join a NetBird network as a routing peer, enabling secure remote access to your Proxmox network from anywhere.",
"install_methods": [
{
"type": "default",
"script": "ct/netbird.sh",
"config_path": "",
"resources": {
"cpu": 1,
"ram": 512,
"hdd": 4,
"os": "Debian",
"version": "13"
}
}
],
"default_credentials": {
"username": null,
"password": null
},
"notes": [
{
"text": "This installs the NetBird client (agent). After setup, connect the peer to your network by running: netbird up --setup-key <YOUR_SETUP_KEY>",
"type": "info"
},
{
"text": "This container runs as privileged to allow access to the TUN device required by NetBird.",
"type": "warning"
}
]
}