Skip to content

Commit bc0a8ca

Browse files
authored
update broker docs to remove publicKey, allowedIps, heartbeat (#1936)
1 parent 5b35e7f commit bc0a8ca

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

docs/semgrep-ci/network-broker.md

+36-1
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,38 @@ Ensure that you are logged in to the server where you want to run Semgrep Networ
3636

3737
### Create the config file
3838

39+
<Tabs
40+
defaultValue="current"
41+
values={[
42+
{label: 'v0.25.0 and later', value: 'current'},
43+
{label: 'v0.24.0 and earlier', value: 'legacy'}
44+
]}
45+
>
46+
47+
<TabItem value='current'>
48+
49+
Create a `config.yaml` file similar to the following snippet, or copy a starting config from the Semgrep AppSec Platform at **Settings > Broker**. The steps required to generate values for the placeholders `SEMGREP_LOCAL_ADDRESS`, `YOUR_PRIVATE_KEY`, and `YOUR_BASE_URL` are provided in subsequent steps of this guide.
50+
51+
```yaml
52+
inbound:
53+
wireguard:
54+
localAddress: SEMGREP_LOCAL_ADDRESS
55+
privateKey: YOUR_PRIVATE_KEY
56+
peers:
57+
- endpoint: wireguard.semgrep.dev:51820
58+
allowlist: []
59+
gitlab:
60+
baseUrl: YOUR_BASE_URL
61+
token: GITLAB_PAT
62+
```
63+
64+
</TabItem>
65+
<TabItem value='legacy'>
66+
67+
:::note
68+
Semgrep recommends that users running Network Broker v0.24.0 or earlier to upgrade to v0.25.0 or later. This enables the use of a simplified config file.
69+
:::
70+
3971
Create a `config.yaml` file similar to the following snippet, or copy a starting config from the Semgrep AppSec Platform at **Settings > Broker**. The steps required to generate values for the placeholders `SEMGREP_LOCAL_ADDRESS`, `YOUR_PRIVATE_KEY`, and `YOUR_BASE_URL` are provided in subsequent steps of this guide.
4072

4173
```yaml
@@ -61,6 +93,9 @@ The `publicKey` value should be entered precisely as shown in the example:
6193
4EqJwDZ8X/qXB5u3Wpo2cxnKlysec93uhRvGWPix0lg=
6294
```
6395

96+
</TabItem>
97+
</Tabs>
98+
6499
#### Multiple configuration files
65100
You can overlay multiple configuration files on top of each other by passing multiple `-c` arguments:
66101

@@ -96,7 +131,7 @@ The broker requires a WireGuard keypair to establish a secure connection. To gen
96131

97132
### Update the config with your SCM information
98133

99-
Update the `config.yaml` by replacing the SCM information containing `YOUR_BASE_URL` with your SCM and its base URL, for GitHub, GitLab, or Bitbucket Data Center.
134+
Update the `config.yaml` by replacing the SCM information containing `YOUR_BASE_URL` with your SCM and its base URL for Azure DevOps, GitHub, GitLab, or Bitbucket Data Center.
100135

101136
<Tabs
102137
defaultValue="gh"

0 commit comments

Comments
 (0)