[PR #9] [MERGED] feat: Add NetBird template #8

New issue

Closed

opened 2026-03-02 03:02:32 +03:00 by kerem · 0 comments

kerem commented

2026-03-02 03:02:32 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/bunkerity/bunkerweb-templates/pull/9
Author: @TheophileDiot
Created: 2/25/2026
Status: ✅ Merged
Merged: 2/25/2026
Merged by: @TheophileDiot

Base: main ← Head: dev

📝 Commits (3)

7c594f2 feat: Add NetBird template with gRPC and websocket routing, including ModSecurity configurations
6052446 fix: Ensure target branch is set to 'dev' in dependabot configuration
1f546a8 feat: Add GitHub Actions workflow for dev template pre-release packaging and publishing

📊 Changes

7 files changed (+354 additions, -4 deletions)

View changed files

📝 .github/dependabot.yml (+1 -0)
➕ .github/workflows/dev-template-prerelease.yml (+148 -0)
📝 CHANGELOG.md (+5 -1)
📝 README.md (+4 -3)
➕ templates/netbird/README.md (+57 -0)
➕ templates/netbird/configs/modsec/netbird_false_positives.conf (+3 -0)
➕ templates/netbird/template.json (+136 -0)

📄 Description

Summary

Added a new NetBird template (templates/netbird/) for self-hosted deployments, including reverse proxy + websocket routing and gRPC method-prefix routing with long-lived timeout defaults.
Included a NetBird-specific ModSecurity CRS false-positive exclusion config for OAuth2 endpoints (configs/modsec/netbird_false_positives.conf).
Updated repo docs to surface the new template:
- CHANGELOG.md: added an Unreleased entry for the NetBird template.
- Root README.md: added NetBird to the templates list/table and directory tree.

Testing

jq . templates/netbird/template.json
Validated template or docs using the listed commands
Other (add details below)

Validation details

JSON validation:
- jq . templates/netbird/template.json
Sanity checks (from template docs):
- Import template via BunkerWeb UI (Templates → Create new template → Raw → paste template.json) or via plugin bundle (copy netbird/ under plugin templates/).
- Route checks (expect correct upstream + long-lived behavior):
  - GET /relay
  - GET /ws-proxy/ (websocket upgrade)
  - GET /api/
  - GET /oauth2/ and /oauth2/token
  - GET / (dashboard fallback)
- Confirm gRPC routing works for:
  - /signalexchange.SignalExchange/
  - /management.ManagementService/

Checklist

I installed the pre-commit hooks and ran pre-commit run --all-files.
I described the service or scenario this change targets.
template.json references only files shipped in the same template directory.
Template docs note how to import it (plugin bundle and/or web UI upload).
I updated configs, screenshots, or notes impacted by this change.
I linked related issues or discussions and added context for reviewers.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/bunkerity/bunkerweb-templates/pull/9 **Author:** [@TheophileDiot](https://github.com/TheophileDiot) **Created:** 2/25/2026 **Status:** ✅ Merged **Merged:** 2/25/2026 **Merged by:** [@TheophileDiot](https://github.com/TheophileDiot) **Base:** `main` ← **Head:** `dev` --- ### 📝 Commits (3) - [`7c594f2`](https://github.com/bunkerity/bunkerweb-templates/commit/7c594f2ba4c5b021d1e7611f2e53d20ac0dcfb8f) feat: Add NetBird template with gRPC and websocket routing, including ModSecurity configurations - [`6052446`](https://github.com/bunkerity/bunkerweb-templates/commit/60524465ba97c74f7676e2a14e42e33757005dd2) fix: Ensure target branch is set to 'dev' in dependabot configuration - [`1f546a8`](https://github.com/bunkerity/bunkerweb-templates/commit/1f546a8d86fe442ec7078c6c55d207277c525316) feat: Add GitHub Actions workflow for dev template pre-release packaging and publishing ### 📊 Changes **7 files changed** (+354 additions, -4 deletions) <details> <summary>View changed files</summary> 📝 `.github/dependabot.yml` (+1 -0) ➕ `.github/workflows/dev-template-prerelease.yml` (+148 -0) 📝 `CHANGELOG.md` (+5 -1) 📝 `README.md` (+4 -3) ➕ `templates/netbird/README.md` (+57 -0) ➕ `templates/netbird/configs/modsec/netbird_false_positives.conf` (+3 -0) ➕ `templates/netbird/template.json` (+136 -0) </details> ### 📄 Description # Summary * Added a new **NetBird** template (`templates/netbird/`) for self-hosted deployments, including **reverse proxy + websocket routing** and **gRPC method-prefix routing** with long-lived timeout defaults. * Included a NetBird-specific **ModSecurity CRS false-positive exclusion** config for OAuth2 endpoints (`configs/modsec/netbird_false_positives.conf`). * Updated repo docs to surface the new template: * `CHANGELOG.md`: added an Unreleased entry for the NetBird template. * Root `README.md`: added NetBird to the templates list/table and directory tree. # Testing * [x] `jq . templates/netbird/template.json` * [x] Validated template or docs using the listed commands * [ ] Other (add details below) <details> <summary>Validation details</summary> * JSON validation: * `jq . templates/netbird/template.json` * Sanity checks (from template docs): * Import template via **BunkerWeb UI** (Templates → Create new template → Raw → paste `template.json`) or via **plugin bundle** (copy `netbird/` under plugin `templates/`). * Route checks (expect correct upstream + long-lived behavior): * `GET /relay` * `GET /ws-proxy/` (websocket upgrade) * `GET /api/` * `GET /oauth2/` and `/oauth2/token` * `GET /` (dashboard fallback) * Confirm gRPC routing works for: * `/signalexchange.SignalExchange/` * `/management.ManagementService/` </details> # Checklist * [x] I installed the pre-commit hooks and ran `pre-commit run --all-files`. * [x] I described the service or scenario this change targets. * [x] `template.json` references only files shipped in the same template directory. * [x] Template docs note how to import it (plugin bundle and/or web UI upload). * [x] I updated configs, screenshots, or notes impacted by this change. * [x] I linked related issues or discussions and added context for reviewers. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>