Netbird/readme.md

58 lines
1.6 KiB
Markdown
Raw Normal View History

2025-09-07 13:52:28 +00:00
# 🚀 Deploy Netbird & Zitadel with Traefik
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
This script helps you deploy **Netbird** behind a **Traefik** reverse proxy. It's designed for users who already have a working Traefik stack. The integration relies solely on Traefik labels—no need to modify your existing setup.
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
---
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
## 📦 Installation
2025-09-06 15:50:50 +00:00
```bash
git clone https://github.com/yblis/netbird-traefik.git
cd netbird-traefik
```
2025-09-06 15:54:59 +00:00
---
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
## ⚙️ Configuration
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
Before running the script, edit the following variables inside `install-netbird-traefik.sh`:
2025-09-06 15:50:50 +00:00
```bash
2025-09-06 15:54:59 +00:00
NETBIRD_DOMAIN="netbird.domain.com" # Your Netbird domain
TRAEFIK_NETWORK="traefik_traefik" # Docker network used by Traefik
TRAEFIK_CERTRESOLVER="webssl" # Traefik certificate resolver (e.g., Let's Encrypt)
2025-09-06 15:50:50 +00:00
```
2025-09-06 15:54:59 +00:00
---
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
## ▶️ Deployment
2025-09-06 15:50:50 +00:00
```bash
2025-09-06 15:54:59 +00:00
chmod +x install-netbird-traefik.sh
./install-netbird-traefik.sh
2025-09-06 15:50:50 +00:00
```
2025-09-06 15:54:59 +00:00
---
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
## 🔓 Required Ports
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
Make sure the following ports are open on your firewall/router:
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
| Protocol | Port(s) | Description |
|----------|----------------|------------------------------|
| TCP | 80, 443 | Traefik (HTTP/HTTPS) |
| TCP | 10000 | Signal gRPC API |
| TCP | 33073 | Management gRPC API |
| TCP | 33080 | Relay service |
| UDP | 3478 | STUN/TURN (Coturn) |
| UDP | 4915265535 | STUN/TURN (Coturn - RTP) |
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
---
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
## 🧠 Requirements
2025-09-06 15:50:50 +00:00
2025-09-06 15:54:59 +00:00
- Existing Traefik stack (Docker + configured network)
- Valid domain pointing to your server
- Traefik certificate resolver (e.g., Let's Encrypt)
2025-09-06 15:50:50 +00:00