Update readme.md
This commit is contained in:
yblis
GitHub
parent
c081fba510
commit
7b59487f2a
121
readme.md
121
readme.md
|
|
@ -1,112 +1,57 @@
|
|||
# NetBird avec Traefik
|
||||
# 🚀 Deploy Netbird with Traefik
|
||||
|
||||
Déploiement simplifié de NetBird avec des labels Traefik pour une intégration facile dans votre stack existante.
|
||||
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.
|
||||
|
||||
## 🎯 Prérequis
|
||||
---
|
||||
|
||||
- Docker et Docker Compose installés
|
||||
- Stack Traefik déjà configurée et fonctionnelle
|
||||
- Nom de domaine pointant vers votre serveur
|
||||
- Ports nécessaires disponibles (voir section [Ports](#ports))
|
||||
## 📦 Installation
|
||||
|
||||
## 🚀 Installation rapide
|
||||
|
||||
### 1. Cloner le repository
|
||||
```bash
|
||||
git clone https://github.com/yblis/netbird-traefik.git
|
||||
cd netbird-traefik
|
||||
```
|
||||
|
||||
### 2. Configuration
|
||||
Éditez le script `install-netbird-traefik.sh` et modifiez les variables suivantes :
|
||||
---
|
||||
|
||||
## ⚙️ Configuration
|
||||
|
||||
Before running the script, edit the following variables inside `install-netbird-traefik.sh`:
|
||||
|
||||
```bash
|
||||
NETBIRD_DOMAIN="netbird.votre-domaine.fr" # your NetBird domain
|
||||
TRAEFIK_NETWORK="traefik_traefik" # your Traefik network
|
||||
TRAEFIK_CERTRESOLVER="webssl" # your Traefik's certresolver
|
||||
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)
|
||||
```
|
||||
|
||||
### 3. Exécution
|
||||
---
|
||||
|
||||
## ▶️ Deployment
|
||||
|
||||
```bash
|
||||
chmod +x install-netbird-traefik.sh
|
||||
./install-netbird-traefik.sh
|
||||
```
|
||||
|
||||
## 🔧 Configuration des ports
|
||||
---
|
||||
|
||||
Assurez-vous que les ports suivants sont ouverts sur votre serveur :
|
||||
## 🔓 Required Ports
|
||||
|
||||
### TCP
|
||||
| Port | Service | Description |
|
||||
|------|---------|-------------|
|
||||
| 80 | Traefik | HTTP (redirect to HTTPS) |
|
||||
| 443 | Traefik | HTTPS |
|
||||
| 10000 | NetBird | Signal gRPC API |
|
||||
| 33073 | NetBird | Management gRPC API |
|
||||
| 33080 | NetBird | Relay service |
|
||||
Make sure the following ports are open on your firewall/router:
|
||||
|
||||
### UDP
|
||||
| Port | Service | Description |
|
||||
|------|---------|-------------|
|
||||
| 3478 | Coturn | STUN/TURN |
|
||||
| 49152-65535 | Coturn | Dynamic STUN/TURN range |
|
||||
|
||||
### Example iptables configuration
|
||||
```bash
|
||||
# TCP
|
||||
iptables -A INPUT -p tcp --dport 80 -j ACCEPT
|
||||
iptables -A INPUT -p tcp --dport 443 -j ACCEPT
|
||||
iptables -A INPUT -p tcp --dport 10000 -j ACCEPT
|
||||
iptables -A INPUT -p tcp --dport 33073 -j ACCEPT
|
||||
iptables -A INPUT -p tcp --dport 33080 -j ACCEPT
|
||||
|
||||
# UDP
|
||||
iptables -A INPUT -p udp --dport 3478 -j ACCEPT
|
||||
iptables -A INPUT -p udp --dport 49152:65535 -j ACCEPT
|
||||
```
|
||||
|
||||
## 📁 Project Structure
|
||||
|
||||
```
|
||||
netbird-traefik/
|
||||
├── install-netbird-traefik.sh # Installation script
|
||||
├── docker-compose.yml # Docker Compose config with Traefik labels
|
||||
├── README.md # This documentation
|
||||
└── configs/ # Configuration files
|
||||
```
|
||||
|
||||
## ⚙️ Features
|
||||
|
||||
- ✅ Automatic Traefik integration
|
||||
- ✅ Automatic SSL certificates (Let's Encrypt)
|
||||
- ✅ Optimized network configuration
|
||||
- ✅ Pre-configured Traefik labels
|
||||
- ✅ Automatic NetBird services management
|
||||
|
||||
## 🔍 Installation Verification
|
||||
|
||||
After installation, verify that services are running:
|
||||
|
||||
```bash
|
||||
docker-compose ps
|
||||
```
|
||||
|
||||
Access your NetBird interface at: `https://netbird.your-domain.com`
|
||||
|
||||
## 🆘 Support
|
||||
|
||||
If you encounter issues:
|
||||
|
||||
1. Check logs: `docker-compose logs -f`
|
||||
2. Ensure your Traefik network exists: `docker network ls`
|
||||
3. Verify DNS resolution for your domain
|
||||
|
||||
## 📝 Important Notes
|
||||
|
||||
- This script is designed for installations with Traefik already configured
|
||||
- SSL certificates are automatically managed by Traefik
|
||||
- Make sure your domain points to your server before installation
|
||||
| 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 | 49152–65535 | STUN/TURN (Coturn - RTP) |
|
||||
|
||||
---
|
||||
|
||||
**Contributing:** Contributions are welcome! Feel free to open an issue or pull request.
|
||||
## 🧠 Requirements
|
||||
|
||||
- Existing Traefik stack (Docker + configured network)
|
||||
- Valid domain pointing to your server
|
||||
- Traefik certificate resolver (e.g., Let's Encrypt)
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue