laantungir/fips
1
0
Fork 0
mirror of https://github.com/jmcorgan/fips.git synced 2026-08-09 08:14:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(sidecar): make UDP MTU env-overridable end-to-end

Browse Source 
The sidecar entrypoint hardcoded `udp.mtu: 1472`, the Docker-bridge
IPv4 maximum (1500 MTU - 8 UDP - 20 IPv4 header). Promote it to
`FIPS_UDP_MTU` (defaulting to 1472, preserving behavior) so non-Docker
reuses of the example can override without editing the script. Plumb
the env var through `docker-compose.yml` so a host-level setting
reaches the container, and add a row to the README's env-var table.

Also annotate the static-CI node template with a comment explaining
the same 1472 rationale and the daemon's 1280 default. The template
keeps 1472 as the literal value since the CI suite runs on a Docker
bridge where that's correct.

No behavior change unless the host explicitly sets FIPS_UDP_MTU.
This commit is contained in:
Johnathan Corgan
2026-05-13 21:13:03 +00:00
parent 9bf9701d92
commit 32a3b58d1f
4 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
examples/sidecar-nostr-relay/README.md
+1
View File
@@ -187,6 +187,7 @@ docker exec sidecar-nostr-relay-app-1 ping -c1 127.0.0.1
| `FIPS_TCP_BIND` | `0.0.0.0:8443` | TCP transport bind address | | `FIPS_TCP_BIND` | `0.0.0.0:8443` | TCP transport bind address |
| `FIPS_PEER_TRANSPORT` | `udp` | Peer transport type (`udp` or `tcp`) | | `FIPS_PEER_TRANSPORT` | `udp` | Peer transport type (`udp` or `tcp`) |
| `FIPS_TUN_MTU` | `1280` | TUN interface MTU | | `FIPS_TUN_MTU` | `1280` | TUN interface MTU |
| `FIPS_UDP_MTU` | `1472` | UDP transport MTU (default is Docker bridge IPv4 max; set to `1280` for IPv6-min-safe deploys) |
| `FIPS_NETWORK` | `fips-sidecar-net` | Docker network name (set to join external network) | | `FIPS_NETWORK` | `fips-sidecar-net` | Docker network name (set to join external network) |
| `FIPS_SUBNET` | `172.20.1.0/24` | Docker network subnet | | `FIPS_SUBNET` | `172.20.1.0/24` | Docker network subnet |
| `FIPS_IPV4` | `172.20.1.20` | Sidecar's IPv4 address on the Docker network | | `FIPS_IPV4` | `172.20.1.20` | Sidecar's IPv4 address on the Docker network |
examples/sidecar-nostr-relay/docker-compose.yml
+1
View File
@@ -31,6 +31,7 @@ services:
- FIPS_PEER_ALIAS=${FIPS_PEER_ALIAS:-peer} - FIPS_PEER_ALIAS=${FIPS_PEER_ALIAS:-peer}
- FIPS_UDP_BIND=${FIPS_UDP_BIND:-0.0.0.0:2121} - FIPS_UDP_BIND=${FIPS_UDP_BIND:-0.0.0.0:2121}
- FIPS_TUN_MTU=${FIPS_TUN_MTU:-1280} - FIPS_TUN_MTU=${FIPS_TUN_MTU:-1280}
- FIPS_UDP_MTU=${FIPS_UDP_MTU:-1472}
- FIPS_PEER_TRANSPORT=${FIPS_PEER_TRANSPORT:-udp} - FIPS_PEER_TRANSPORT=${FIPS_PEER_TRANSPORT:-udp}
volumes: volumes:
- ./resolv.conf:/etc/resolv.conf:ro - ./resolv.conf:/etc/resolv.conf:ro
examples/sidecar-nostr-relay/entrypoint.sh
+4 -1
View File
@@ -8,6 +8,7 @@ FIPS_NSEC="${FIPS_NSEC:?FIPS_NSEC is required}"
FIPS_UDP_BIND="${FIPS_UDP_BIND:-0.0.0.0:2121}" FIPS_UDP_BIND="${FIPS_UDP_BIND:-0.0.0.0:2121}"
FIPS_TCP_BIND="${FIPS_TCP_BIND:-0.0.0.0:8443}" FIPS_TCP_BIND="${FIPS_TCP_BIND:-0.0.0.0:8443}"
FIPS_TUN_MTU="${FIPS_TUN_MTU:-1280}" FIPS_TUN_MTU="${FIPS_TUN_MTU:-1280}"
FIPS_UDP_MTU="${FIPS_UDP_MTU:-1472}"
FIPS_PEER_TRANSPORT="${FIPS_PEER_TRANSPORT:-udp}" FIPS_PEER_TRANSPORT="${FIPS_PEER_TRANSPORT:-udp}"
mkdir -p /etc/fips mkdir -p /etc/fips
@@ -41,7 +42,9 @@ dns:
transports: transports:
udp: udp:
bind_addr: "${FIPS_UDP_BIND}" bind_addr: "${FIPS_UDP_BIND}"
mtu: 1472 # 1472 = Docker bridge IPv4 max (1500 MTU - 8 UDP - 20 IPv4 header).
# Override with FIPS_UDP_MTU=1280 for IPv6-min-safe deploys.
mtu: ${FIPS_UDP_MTU}
tcp: tcp:
bind_addr: "${FIPS_TCP_BIND}" bind_addr: "${FIPS_TCP_BIND}"
testing/static/configs/node.template.yaml
+2
View File
@@ -17,6 +17,8 @@ dns:
transports: transports:
udp: udp:
bind_addr: "0.0.0.0:2121" bind_addr: "0.0.0.0:2121"
# Docker bridge supports 1500-MTU IPv4 so 1472 is safe here.
# Operator-facing daemon default is 1280 (IPv6 minimum).
mtu: 1472 mtu: 1472
# recv_buf_size: 2097152 # 2 MB (default) # recv_buf_size: 2097152 # 2 MB (default)
# send_buf_size: 2097152 # 2 MB (default) # send_buf_size: 2097152 # 2 MB (default)