From 2866a42651ee8fc05acb7b87687ffb7c0c43124a Mon Sep 17 00:00:00 2001 From: braginini Date: Tue, 10 Feb 2026 22:27:11 +0100 Subject: [PATCH] Add signal extraction --- .../scaling-your-self-hosted-deployment.mdx | 126 ++++++++++++++++++ 1 file changed, 126 insertions(+) diff --git a/src/pages/selfhosted/scaling-your-self-hosted-deployment.mdx b/src/pages/selfhosted/scaling-your-self-hosted-deployment.mdx index 90199051..66d1a2c4 100644 --- a/src/pages/selfhosted/scaling-your-self-hosted-deployment.mdx +++ b/src/pages/selfhosted/scaling-your-self-hosted-deployment.mdx @@ -352,6 +352,132 @@ Once confirmed, switch back to normal mode. The client will attempt peer-to-peer sudo netbird service reconfigure --service-env NB_FORCE_RELAY=false ``` +## Step 4: Extract the Signal Server (Optional) + +In most deployments, the embedded Signal server works well and does not need to be extracted. Consider running an external Signal server if you want to separate it from the Management server for organizational or infrastructure reasons. + + +Changing the Signal server URL requires all clients to restart. After updating the configuration, each client must run `netbird down` followed by `netbird up` to reconnect to the new Signal server. This limitation will be addressed in a future client release. + + +### 4.1 Server Requirements + +- A Linux VM with at least **1 CPU** and **1GB RAM** +- Public IP address +- A domain name pointing to the server (e.g., `signal.example.com`) +- Docker installed +- Firewall ports open: **80/tcp** (Let's Encrypt HTTP challenge) and **443/tcp** (gRPC/WebSocket client communication) + +### 4.2 Create Signal Configuration + +On your signal server, create a directory and configuration: + +```bash +mkdir -p ~/netbird-signal +cd ~/netbird-signal +``` + +Like the relay, the signal server can automatically obtain TLS certificates via Let's Encrypt. Unlike the relay, the signal server requires CLI flags for configuration. + + +Replace `signal.example.com` with your signal server's domain. + + +Create `docker-compose.yml`: + +```yaml +services: + signal: + image: netbirdio/signal:latest + container_name: netbird-signal + restart: unless-stopped + ports: + - '443:443' + - '80:80' + command: ["--port", "443", "--letsencrypt-domain", "signal.example.com"] + volumes: + - signal_data:/var/lib/netbird + logging: + driver: "json-file" + options: + max-size: "500m" + max-file: "2" + +volumes: + signal_data: +``` + +### 4.3 Alternative: TLS with Existing Certificates + +If you have existing TLS certificates, replace the `--letsencrypt-domain` flag with certificate paths: + +```yaml + command: ["--port", "443", "--cert-file", "/certs/fullchain.pem", "--cert-key", "/certs/privkey.pem"] + volumes: + - /path/to/certs:/certs:ro + - signal_data:/var/lib/netbird +``` + +### 4.4 Start the Signal Server + +```bash +docker compose up -d +``` + +Verify it's running: + +```bash +docker compose logs -f +``` + +If you configured Let's Encrypt, trigger certificate provisioning with an HTTPS request: + +```bash +curl -v https://signal.example.com/ +``` + +Confirm the certificate was issued: + +``` +* Server certificate: +* subject: CN=signal.example.com +* issuer: C=US; O=Let's Encrypt; CN=E8 +* SSL certificate verify ok. +``` + +### 4.5 Update Main Server Configuration + +On your main server, add `signalUri` to `config.yaml`. This disables the embedded Signal server: + +```yaml +server: + # ... existing settings ... + + # External signal server + signalUri: "https://signal.example.com:443" +``` + +Restart the main server: + +```bash +docker compose down +docker compose up -d +``` + +### 4.6 Verify Signal Extraction + +Check the main server logs to confirm the embedded Signal is disabled: + +```bash +docker compose logs netbird-server +``` + +``` +INFO combined/cmd/root.go: Management: true (log level: info) +INFO combined/cmd/root.go: Signal: false (log level: ) +INFO combined/cmd/root.go: Relay: false (log level: ) +``` + ## Configuration Reference ### Relay Server Environment Variables