sendnrw/netbird-docs
2
0
Fork 0
mirror of https://github.com/netbirdio/docs.git synced 2026-08-25 01:01:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Fix broken anchor links

Browse Source
This commit is contained in:
Brandon Hopkins
2026-08-19 11:38:49 -07:00
parent 767f10d0eb
commit c1c684b59b
2 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/pages/manage/activity/event-streaming/generic-http.mdx
View File

@@ -21,8 +21,8 @@ For every event, NetBird sends a POST request to the endpoint you configure. You
## Create an Integration in NetBird
1. Open the **Integrations** page in the NetBird dashboard and select the **Event Streaming** tab.
2. Find the **Generic HTTP** card and click **Connect Generic HTTP**.
3. The setup modal opens on the **General** tab. A new integration walks through **General**, **Headers**, and **Body Template**, with a **Continue** button between each step. The **Danger Zone** tab only appears once the integration exists.
2. Find the **Generic HTTP** card and click `Connect Generic HTTP`.
3. The setup modal opens on the `General` tab. A new integration walks through `General`, `Headers`, and `Body Template`, with a `Continue` button between each step. The `Danger Zone` tab only appears once the integration exists.
### General Configuration
@@ -40,12 +40,12 @@ This tab holds the endpoint address and the authentication method.
- `Custom Authentication`: under `HTTP Header Name & Value`, provide a header name (for example `X-API-Key`) and its value. NetBird sends that header verbatim.
<Note>
Authentication is stored as an HTTP header, and how it reappears when you reopen the integration depends on the method. `Basic Auth` and `Bearer Token` are restored into the **Authentication** selector, and Basic Auth shows `****` in both fields. Leave those masked fields untouched to keep the stored credentials, or retype both to change them. `Custom Authentication` has no dedicated storage, so it comes back as an ordinary row on the **Headers** tab and the selector resets to `No Authentication`. That is expected, and the header is still being sent.
Authentication is stored as an HTTP header, and how it reappears when you reopen the integration depends on the method. `Basic Auth` and `Bearer Token` are restored into the `Authentication` selector, and Basic Auth shows `****` in both fields. Leave those masked fields untouched to keep the stored credentials, or retype both to change them. `Custom Authentication` has no dedicated storage, so it comes back as an ordinary row on the `Headers` tab and the selector resets to `No Authentication`. That is expected, and the header is still being sent.
</Note>
### HTTP Headers (Optional)
The **Headers** tab adds custom headers to every outgoing request. Click **Add Header**, then fill in the `Name` and `Value` fields. Each row needs both: filling in only one blocks you from continuing.
The `Headers` tab adds custom headers to every outgoing request. Click `Add Header`, then fill in the `Name` and `Value` fields. Each row needs both: filling in only one blocks you from continuing.
<p>
<img src="/docs-static/img/manage/activity/event-streaming/generic-http/headers-config.png" alt="Generic HTTP Headers Configuration" className="imagewrapper-big"/>
@@ -54,18 +54,18 @@ The **Headers** tab adds custom headers to every outgoing request. Click **Add H
The default request body is JSON. If your endpoint expects something else, for example because you built a plain-text body template, set `Content-Type` here.
<Warning>
Do not add an `Authorization` header here while `Basic Auth` or `Bearer Token` is selected on the **General** tab. The dashboard shows a warning that the header will override the authentication from the previous step and blocks saving until you remove it. Use one or the other, not both.
Do not add an `Authorization` header here while `Basic Auth` or `Bearer Token` is selected on the `General` tab. The dashboard shows a warning that the header will override the authentication from the previous step and blocks saving until you remove it. Use one or the other, not both.
</Warning>
### Custom Body Template (Optional)
The **Body Template** tab controls the structure of the payload NetBird posts.
The `Body Template` tab controls the structure of the payload NetBird posts.
<p>
<img src="/docs-static/img/manage/activity/event-streaming/generic-http/body-template-config.png" alt="Generic HTTP Body Template Configuration" className="imagewrapper-big"/>
</p>
Leave `Custom Body Template (optional)` off and NetBird sends its default JSON object for each event, described in [What NetBird sends](#what-netbird-sends). Turn it on and a text area appears, prefilled with this starting point:
Leave `Custom Body Template (optional)` off and NetBird sends its default JSON object for each event, described in [What NetBird sends](#what-net-bird-sends). Turn it on and a text area appears, prefilled with this starting point:
```json
{
@@ -159,7 +159,7 @@ A few things to plan for:
## Save and Verify
On a new integration, click **Connect** on the **Body Template** step. When you reopen an existing integration the footer shows **Cancel** and **Save Changes** on every tab instead.
On a new integration, click `Connect` on the `Body Template` step. When you reopen an existing integration the footer shows `Cancel` and `Save Changes` on every tab instead.
When you save, NetBird POSTs a test event to your endpoint. If the endpoint does not answer with a `2xx` status, the save is rejected and the integration is not created, so a failing save usually means a wrong URL, a firewall in the way, or bad credentials.
@@ -167,11 +167,11 @@ Check the logs of your receiving service for the incoming POST. A successful sav
## Manage the Integration
Once the integration exists, the Generic HTTP card changes: the **Connect Generic HTTP** button is replaced by a **Configuration** button, and the toggle on the card becomes active.
Once the integration exists, the Generic HTTP card changes: the `Connect Generic HTTP` button is replaced by a `Configuration` button, and the toggle on the card becomes active.
- **Enable or disable**: flip the toggle on the card. Disabling stops the stream but keeps the configuration, so you can turn it back on without re-entering anything.
- **Edit**: click **Configuration** to reopen the modal, change any tab, and click **Save Changes**.
- **Delete**: open **Configuration**, go to the **Danger Zone** tab, and click **Delete Integration**. A confirmation dialog appears, and the deletion is irreversible. You will have to set the integration up again from scratch.
- **Edit**: click `Configuration` to reopen the modal, change any tab, and click `Save Changes`.
- **Delete**: open `Configuration`, go to the `Danger Zone` tab, and click `Delete Integration`. A confirmation dialog appears, and the deletion is irreversible. You will have to set the integration up again from scratch.
<p>
<img src="/docs-static/img/manage/activity/event-streaming/generic-http/danger-zone.png" alt="Generic HTTP Danger Zone" className="imagewrapper-big"/>

2
src/pages/manage/activity/event-streaming/wazuh.mdx
View File

@@ -75,7 +75,7 @@ In the starter ruleset referenced in the prerequisites, `TYPE_DROP` events (rule
## Payload reference
NetBird posts two distinct event shapes through the same integration, audit events and traffic events. The canonical description of both, including the mixed key casing and the per-event-type `meta` keys, lives on the [Generic HTTP](/manage/activity/event-streaming/generic-http#what-netbird-sends) page. This section covers only what changes on the way into Wazuh.
NetBird posts two distinct event shapes through the same integration, audit events and traffic events. The canonical description of both, including the mixed key casing and the per-event-type `meta` keys, lives on the [Generic HTTP](/manage/activity/event-streaming/generic-http#what-net-bird-sends) page. This section covers only what changes on the way into Wazuh.
The receiver used for the examples on this page wraps each NetBird payload before writing it out, so it does not collide with Wazuh's index template: