Skip to content

Commit 9856198

Browse files
authored
Patch for operators to open wg metadata port (#6106)
1 parent 5c33846 commit 9856198

File tree

4 files changed

+45
-5
lines changed

4 files changed

+45
-5
lines changed

documentation/docs/components/operators/snippets/quic-bridge-deployment-script-setup.mdx

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import { AccordionTemplate } from 'components/accordion-template.tsx';
66
**QUIC bridge is a requirement for all nodes which enable Wireguard functionality. Note that it this feature is compatible with nodes from `v1.18.0` (platform release [`v2025.17-isabirra`](https://github.com/nymtech/nym/releases/tag/nym-binaries-v2025.17-isabirra)) and newer!**
77
</ Callout>
88

9-
Nym Network uses various [transport bridges](https://github.com/nymtech/nym-bridges/blob/main/README.md) for routing the packets. Right now operators need to configure [our implementation](https://github.com/nymtech/nym-bridges/tree/main/nym-bridge) of general-purpose transport layer network protocol called [QUIC](https://en.wikipedia.org/wiki/QUIC).
9+
Nym Network uses various [transport bridges](https://github.com/nymtech/nym-bridges/blob/main/README.md) for routing the packets. Right now operators need to configure [our implementation](https://github.com/nymtech/nym-bridges/tree/main/nym-bridge) of general-purpose transport layer network protocol called [QUIC](https://en.wikipedia.org/wiki/QUIC).
1010

1111
Operators can use [Nym Bridge Configuration Tool](https://github.com/nymtech/nym-bridges/tree/main/bridge-cfg) and compile the [Bridge Runner binary](https://github.com/nymtech/nym-bridges/tree/main/nym-bridge) themselves.
1212

@@ -15,7 +15,7 @@ Operators can use [Nym Bridge Configuration Tool](https://github.com/nymtech/nym
1515
<Steps>
1616
###### 1. Download [`quic_bridge_deployment.sh`](https://github.com/nymtech/nym/blob/develop/scripts/nym-node-setup/quic_bridge_deployment.sh) script
1717
- SSH to your server
18-
- Download the script and make executable
18+
- Download the script and make executable
1919
```sh
2020
wget https://raw.githubusercontent.com/nymtech/nym/refs/heads/develop/scripts/nym-node-setup/quic_bridge_deployment.sh && \
2121
chmod +x quic_bridge_deployment.sh
@@ -35,7 +35,7 @@ chmod +x quic_bridge_deployment.sh
3535
- To find out your IP address you can always run:
3636
- IPv4: `curl -4 https://ifconfig.co/ip`
3737
- IPv6: `curl -6 https://ifconfig.co/ip`
38-
- **For all prompts with default options, we highly recommend to stick to default (press enter)**
38+
- **For all prompts with default options, we highly recommend to stick to default (press enter)**
3939

4040
###### 4. Restart the node service
4141
- When done with the deployment, please restart your node systemd service
@@ -99,3 +99,43 @@ Quick Start:
9999
3. Run 'test_bridge_connectivity' to test connectivity
100100
```
101101
</AccordionTemplate>
102+
103+
### Fixing Metadata Port Showing Not Open in Probe Results
104+
If you have followed the steps outlined above, but the metadata port is not shown as open in either the Node Status API's probe results or an explorer that gets its data from the API, see below:
105+
106+
<Steps>
107+
###### 1.
108+
Ensure that in your `config.toml` file, this value is set to the default one - any other value here will cause the metadata endpoint to fail:
109+
110+
```
111+
# Private IP address of the wireguard gateway.
112+
# default: '10.1.0.1'
113+
private_ipv4 = '10.1.0.1'
114+
```
115+
116+
Then restart your node.
117+
118+
###### 2.
119+
Run this command if not already done:
120+
```
121+
ufw allow in on nymwg to any port 51830 proto tcp
122+
```
123+
124+
Check if the port is open with:
125+
```
126+
iptables -S | grep 51830
127+
```
128+
129+
Then ensure the metadata endpoint is listening from the correct address with:
130+
```
131+
netstat -an | egrep LISTEN | egrep "51830"
132+
```
133+
134+
###### 3.
135+
Once the Node Status API has run a probe on your node, the probe results will reflect this - `can_query_metadata_v4` will have `true` as a value.
136+
137+
The quickest way to check this is by using the [NymVPN API](https://nymvpn.com/api/public/v1/directory/gateways?show_vpn_only=true) and checking the same field:
138+
139+
![](/images/operators/wg-metadata-port-api.png)
140+
141+
</Steps>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Friday, October 10th 2025, 12:39:08 UTC
1+
Monday, October 13th 2025, 13:24:56 UTC

documentation/docs/components/outputs/command-outputs/node-api-check-query-help.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ options:
1111
--no_routing_history Display node stats without routing history
1212
--no_verloc_metrics Display node stats without verloc metrics
1313
-m, --markdown Display results in markdown format
14-
-o [OUTPUT], --output [OUTPUT]
14+
-o, --output [OUTPUT]
1515
Save results to file (in current dir or supply with
1616
path without filename)
1717
```
69.5 KB
Loading

0 commit comments

Comments
 (0)